From 31b55a6475798390a6753322ac16940cdabed8f9 Mon Sep 17 00:00:00 2001 From: Google APIs Date: Wed, 5 Aug 2020 00:39:04 +0000 Subject: [PATCH] Autogenerated update (2020-08-05) Update: - alertcenter_v1beta1 - analyticsreporting_v4 - androidenterprise_v1 - androidmanagement_v1 - apigee_v1 - chromeuxreport_v1 - classroom_v1 - cloudasset_v1 - cloudasset_v1beta1 - cloudasset_v1p4beta1 - cloudasset_v1p5beta1 - dialogflow_v2 - dialogflow_v2beta1 - driveactivity_v2 - firebase_v1beta1 - firebasedynamiclinks_v1 - firebaseml_v1 - firebaseml_v1beta2 - gameservices_v1 - gameservices_v1beta - gmail_v1 - osconfig_v1 - policytroubleshooter_v1 - policytroubleshooter_v1beta - recommender_v1 - recommender_v1beta1 - runtimeconfig_v1 - searchconsole_v1 - storagetransfer_v1 - tagmanager_v1 - tagmanager_v2 - vision_v1 - vision_v1p1beta1 - vision_v1p2beta1 --- api_names_out.yaml | 92 + generated/google/apis/alertcenter_v1beta1.rb | 2 +- .../apis/alertcenter_v1beta1/classes.rb | 245 +- .../apis/alertcenter_v1beta1/service.rb | 105 +- .../google/apis/analyticsreporting_v4.rb | 2 +- .../apis/analyticsreporting_v4/classes.rb | 714 ++-- generated/google/apis/androidenterprise_v1.rb | 2 +- .../apis/androidenterprise_v1/classes.rb | 1009 +++--- .../apis/androidenterprise_v1/service.rb | 421 +-- generated/google/apis/androidmanagement_v1.rb | 2 +- generated/google/apis/apigee_v1.rb | 13 +- generated/google/apis/apigee_v1/classes.rb | 1913 ++++------ generated/google/apis/apigee_v1/service.rb | 2012 +++++------ generated/google/apis/chromeuxreport_v1.rb | 2 +- .../google/apis/chromeuxreport_v1/classes.rb | 121 +- generated/google/apis/classroom_v1.rb | 2 +- generated/google/apis/classroom_v1/classes.rb | 615 ++-- generated/google/apis/classroom_v1/service.rb | 1545 ++++---- generated/google/apis/cloudasset_v1.rb | 2 +- .../google/apis/cloudasset_v1/classes.rb | 4 +- generated/google/apis/cloudasset_v1beta1.rb | 2 +- .../google/apis/cloudasset_v1beta1/classes.rb | 4 +- generated/google/apis/cloudasset_v1p4beta1.rb | 2 +- generated/google/apis/cloudasset_v1p5beta1.rb | 2 +- .../apis/cloudasset_v1p5beta1/classes.rb | 4 +- generated/google/apis/dialogflow_v2.rb | 2 +- .../google/apis/dialogflow_v2/classes.rb | 2827 +++++++-------- .../google/apis/dialogflow_v2/service.rb | 772 ++-- generated/google/apis/dialogflow_v2beta1.rb | 2 +- .../google/apis/dialogflow_v2beta1/classes.rb | 2994 +++++++--------- .../google/apis/dialogflow_v2beta1/service.rb | 1740 ++++----- generated/google/apis/driveactivity_v2.rb | 2 +- .../google/apis/driveactivity_v2/classes.rb | 123 +- generated/google/apis/firebase_v1beta1.rb | 2 +- .../google/apis/firebase_v1beta1/classes.rb | 662 ++-- .../google/apis/firebase_v1beta1/service.rb | 843 ++--- .../google/apis/firebasedynamiclinks_v1.rb | 2 +- .../apis/firebasedynamiclinks_v1/classes.rb | 201 +- .../apis/firebasedynamiclinks_v1/service.rb | 39 +- generated/google/apis/firebaseml_v1.rb | 2 +- .../google/apis/firebaseml_v1/classes.rb | 83 +- .../google/apis/firebaseml_v1/service.rb | 41 +- generated/google/apis/firebaseml_v1beta2.rb | 2 +- .../google/apis/firebaseml_v1beta2/classes.rb | 130 +- .../google/apis/firebaseml_v1beta2/service.rb | 34 +- generated/google/apis/gameservices_v1.rb | 2 +- generated/google/apis/gameservices_v1beta.rb | 2 +- generated/google/apis/gmail_v1.rb | 6 +- generated/google/apis/gmail_v1/classes.rb | 485 ++- generated/google/apis/gmail_v1/service.rb | 543 ++- generated/google/apis/osconfig_v1.rb | 2 +- generated/google/apis/osconfig_v1/classes.rb | 721 ++++ .../apis/osconfig_v1/representations.rb | 337 ++ .../google/apis/policytroubleshooter_v1.rb | 2 +- .../apis/policytroubleshooter_v1/classes.rb | 626 ++-- .../apis/policytroubleshooter_v1/service.rb | 4 +- .../apis/policytroubleshooter_v1beta.rb | 2 +- .../policytroubleshooter_v1beta/classes.rb | 625 ++-- .../policytroubleshooter_v1beta/service.rb | 4 +- generated/google/apis/recommender_v1.rb | 2 +- .../google/apis/recommender_v1/classes.rb | 176 +- .../google/apis/recommender_v1/service.rb | 101 +- generated/google/apis/recommender_v1beta1.rb | 2 +- .../apis/recommender_v1beta1/classes.rb | 174 +- .../apis/recommender_v1beta1/service.rb | 101 +- generated/google/apis/runtimeconfig_v1.rb | 2 +- .../google/apis/runtimeconfig_v1/classes.rb | 76 +- .../google/apis/runtimeconfig_v1/service.rb | 41 +- generated/google/apis/searchconsole_v1.rb | 2 +- .../google/apis/searchconsole_v1/classes.rb | 4 +- generated/google/apis/storagetransfer_v1.rb | 2 +- .../google/apis/storagetransfer_v1/classes.rb | 18 +- generated/google/apis/tagmanager_v1.rb | 5 +- .../google/apis/tagmanager_v1/classes.rb | 513 ++- .../google/apis/tagmanager_v1/service.rb | 41 +- generated/google/apis/tagmanager_v2.rb | 5 +- .../google/apis/tagmanager_v2/classes.rb | 514 ++- .../google/apis/tagmanager_v2/service.rb | 470 +-- generated/google/apis/vision_v1.rb | 2 +- generated/google/apis/vision_v1/classes.rb | 3174 +++++++---------- generated/google/apis/vision_v1/service.rb | 594 ++- generated/google/apis/vision_v1p1beta1.rb | 2 +- .../google/apis/vision_v1p1beta1/classes.rb | 3036 +++++++--------- .../google/apis/vision_v1p1beta1/service.rb | 212 +- generated/google/apis/vision_v1p2beta1.rb | 2 +- .../google/apis/vision_v1p2beta1/classes.rb | 3036 +++++++--------- .../google/apis/vision_v1p2beta1/service.rb | 212 +- 87 files changed, 15544 insertions(+), 19676 deletions(-) diff --git a/api_names_out.yaml b/api_names_out.yaml index bef706309..4adc382d7 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -109613,6 +109613,17 @@ "/osconfig:v1/AptSettings/type": type "/osconfig:v1/CancelPatchJobRequest": cancel_patch_job_request "/osconfig:v1/Empty": empty +"/osconfig:v1/ExecResource": exec_resource +"/osconfig:v1/ExecResource/enforce": enforce +"/osconfig:v1/ExecResource/validate": validate +"/osconfig:v1/ExecResourceExec": exec_resource_exec +"/osconfig:v1/ExecResourceExec/allowedSuccessCodes": allowed_success_codes +"/osconfig:v1/ExecResourceExec/allowedSuccessCodes/allowed_success_code": allowed_success_code +"/osconfig:v1/ExecResourceExec/args": args +"/osconfig:v1/ExecResourceExec/args/arg": arg +"/osconfig:v1/ExecResourceExec/file": file +"/osconfig:v1/ExecResourceExec/interpreter": interpreter +"/osconfig:v1/ExecResourceExec/script": script "/osconfig:v1/ExecStep": exec_step "/osconfig:v1/ExecStep/linuxExecStepConfig": linux_exec_step_config "/osconfig:v1/ExecStep/windowsExecStepConfig": windows_exec_step_config @@ -109630,6 +109641,30 @@ "/osconfig:v1/ExecutePatchJobRequest/instanceFilter": instance_filter "/osconfig:v1/ExecutePatchJobRequest/patchConfig": patch_config "/osconfig:v1/ExecutePatchJobRequest/rollout": rollout +"/osconfig:v1/ExtractArchiveResource": extract_archive_resource +"/osconfig:v1/ExtractArchiveResource/creates": creates +"/osconfig:v1/ExtractArchiveResource/destination": destination +"/osconfig:v1/ExtractArchiveResource/overwrite": overwrite +"/osconfig:v1/ExtractArchiveResource/source": source +"/osconfig:v1/ExtractArchiveResource/type": type +"/osconfig:v1/File": file +"/osconfig:v1/File/allowInsecure": allow_insecure +"/osconfig:v1/File/gcs": gcs +"/osconfig:v1/File/localPath": local_path +"/osconfig:v1/File/remote": remote +"/osconfig:v1/FileGcs": file_gcs +"/osconfig:v1/FileGcs/bucket": bucket +"/osconfig:v1/FileGcs/generation": generation +"/osconfig:v1/FileGcs/object": object +"/osconfig:v1/FileRemote": file_remote +"/osconfig:v1/FileRemote/sha256Checksum": sha256_checksum +"/osconfig:v1/FileRemote/uri": uri +"/osconfig:v1/FileResource": file_resource +"/osconfig:v1/FileResource/content": content +"/osconfig:v1/FileResource/file": file +"/osconfig:v1/FileResource/path": path +"/osconfig:v1/FileResource/permissions": permissions +"/osconfig:v1/FileResource/state": state "/osconfig:v1/FixedOrPercent": fixed_or_percent "/osconfig:v1/FixedOrPercent/fixed": fixed "/osconfig:v1/FixedOrPercent/percent": percent @@ -109655,6 +109690,35 @@ "/osconfig:v1/MonthlySchedule/weekDayOfMonth": week_day_of_month "/osconfig:v1/OneTimeSchedule": one_time_schedule "/osconfig:v1/OneTimeSchedule/executeTime": execute_time +"/osconfig:v1/PackageResource": package_resource +"/osconfig:v1/PackageResource/apt": apt +"/osconfig:v1/PackageResource/deb": deb +"/osconfig:v1/PackageResource/desiredState": desired_state +"/osconfig:v1/PackageResource/googet": googet +"/osconfig:v1/PackageResource/msi": msi +"/osconfig:v1/PackageResource/rpm": rpm +"/osconfig:v1/PackageResource/yum": yum +"/osconfig:v1/PackageResource/zypper": zypper +"/osconfig:v1/PackageResourceAPT": package_resource_apt +"/osconfig:v1/PackageResourceAPT/name": name +"/osconfig:v1/PackageResourceDeb": package_resource_deb +"/osconfig:v1/PackageResourceDeb/pullDeps": pull_deps +"/osconfig:v1/PackageResourceDeb/source": source +"/osconfig:v1/PackageResourceGooGet": package_resource_goo_get +"/osconfig:v1/PackageResourceGooGet/name": name +"/osconfig:v1/PackageResourceMSI": package_resource_msi +"/osconfig:v1/PackageResourceMSI/allowedSuccessCodes": allowed_success_codes +"/osconfig:v1/PackageResourceMSI/allowedSuccessCodes/allowed_success_code": allowed_success_code +"/osconfig:v1/PackageResourceMSI/flags": flags +"/osconfig:v1/PackageResourceMSI/flags/flag": flag +"/osconfig:v1/PackageResourceMSI/source": source +"/osconfig:v1/PackageResourceRPM": package_resource_rpm +"/osconfig:v1/PackageResourceRPM/pullDeps": pull_deps +"/osconfig:v1/PackageResourceRPM/source": source +"/osconfig:v1/PackageResourceYUM": package_resource_yum +"/osconfig:v1/PackageResourceYUM/name": name +"/osconfig:v1/PackageResourceZypper": package_resource_zypper +"/osconfig:v1/PackageResourceZypper/name": name "/osconfig:v1/PatchConfig": patch_config "/osconfig:v1/PatchConfig/apt": apt "/osconfig:v1/PatchConfig/goo": goo @@ -109740,6 +109804,34 @@ "/osconfig:v1/RecurringSchedule/timeOfDay": time_of_day "/osconfig:v1/RecurringSchedule/timeZone": time_zone "/osconfig:v1/RecurringSchedule/weekly": weekly +"/osconfig:v1/RepositoryResource": repository_resource +"/osconfig:v1/RepositoryResource/apt": apt +"/osconfig:v1/RepositoryResource/goo": goo +"/osconfig:v1/RepositoryResource/yum": yum +"/osconfig:v1/RepositoryResource/zypper": zypper +"/osconfig:v1/RepositoryResourceAptRepository": repository_resource_apt_repository +"/osconfig:v1/RepositoryResourceAptRepository/archiveType": archive_type +"/osconfig:v1/RepositoryResourceAptRepository/components": components +"/osconfig:v1/RepositoryResourceAptRepository/components/component": component +"/osconfig:v1/RepositoryResourceAptRepository/distribution": distribution +"/osconfig:v1/RepositoryResourceAptRepository/gpgKey": gpg_key +"/osconfig:v1/RepositoryResourceAptRepository/uri": uri +"/osconfig:v1/RepositoryResourceGooRepository": repository_resource_goo_repository +"/osconfig:v1/RepositoryResourceGooRepository/name": name +"/osconfig:v1/RepositoryResourceGooRepository/url": url +"/osconfig:v1/RepositoryResourceYumRepository": repository_resource_yum_repository +"/osconfig:v1/RepositoryResourceYumRepository/baseUrl": base_url +"/osconfig:v1/RepositoryResourceYumRepository/displayName": display_name +"/osconfig:v1/RepositoryResourceYumRepository/gpgKeys": gpg_keys +"/osconfig:v1/RepositoryResourceYumRepository/gpgKeys/gpg_key": gpg_key +"/osconfig:v1/RepositoryResourceYumRepository/id": id +"/osconfig:v1/RepositoryResourceZypperRepository": repository_resource_zypper_repository +"/osconfig:v1/RepositoryResourceZypperRepository/baseUrl": base_url +"/osconfig:v1/RepositoryResourceZypperRepository/displayName": display_name +"/osconfig:v1/RepositoryResourceZypperRepository/gpgKeys": gpg_keys +"/osconfig:v1/RepositoryResourceZypperRepository/gpgKeys/gpg_key": gpg_key +"/osconfig:v1/RepositoryResourceZypperRepository/id": id +"/osconfig:v1/ServiceResource": service_resource "/osconfig:v1/TimeOfDay": time_of_day "/osconfig:v1/TimeOfDay/hours": hours "/osconfig:v1/TimeOfDay/minutes": minutes diff --git a/generated/google/apis/alertcenter_v1beta1.rb b/generated/google/apis/alertcenter_v1beta1.rb index ea6e12118..e301b1c90 100644 --- a/generated/google/apis/alertcenter_v1beta1.rb +++ b/generated/google/apis/alertcenter_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/admin-sdk/alertcenter/ module AlertcenterV1beta1 VERSION = 'V1beta1' - REVISION = '20200404' + REVISION = '20200801' # See and delete your domain's G Suite alerts, and send alert feedback AUTH_APPS_ALERTS = 'https://www.googleapis.com/auth/apps.alerts' diff --git a/generated/google/apis/alertcenter_v1beta1/classes.rb b/generated/google/apis/alertcenter_v1beta1/classes.rb index b3de02ba8..c74b6c9ee 100644 --- a/generated/google/apis/alertcenter_v1beta1/classes.rb +++ b/generated/google/apis/alertcenter_v1beta1/classes.rb @@ -81,16 +81,16 @@ module Google # @return [String] attr_accessor :query - # List of alert IDs superseded by this alert. It is used to indicate that - # this alert is essentially extension of superseded alerts and we found the + # List of alert IDs superseded by this alert. It is used to indicate that this + # alert is essentially extension of superseded alerts and we found the # relationship after creating these alerts. # Corresponds to the JSON property `supersededAlerts` # @return [Array] attr_accessor :superseded_alerts - # Alert ID superseding this alert. It is used to indicate that superseding - # alert is essentially extension of this alert and we found the relationship - # after creating both alerts. + # Alert ID superseding this alert. It is used to indicate that superseding alert + # is essentially extension of this alert and we found the relationship after + # creating both alerts. # Corresponds to the JSON property `supersedingAlert` # @return [String] attr_accessor :superseding_alert @@ -100,10 +100,8 @@ module Google # @return [String] attr_accessor :threshold - # The trigger sources for this rule. - # * GMAIL_EVENTS - # * DEVICE_EVENTS - # * USER_EVENTS + # The trigger sources for this rule. * GMAIL_EVENTS * DEVICE_EVENTS * + # USER_EVENTS # Corresponds to the JSON property `triggerSource` # @return [String] attr_accessor :trigger_source @@ -158,8 +156,8 @@ module Google # @return [String] attr_accessor :customer_id - # Optional. The data associated with this alert, for example - # google.apps.alertcenter.type.DeviceCompromised. + # Optional. The data associated with this alert, for example google.apps. + # alertcenter.type.DeviceCompromised. # Corresponds to the JSON property `data` # @return [Hash] attr_accessor :data @@ -170,22 +168,22 @@ module Google attr_accessor :deleted alias_method :deleted?, :deleted - # Optional. The time the event that caused this alert ceased being active. - # If provided, the end time must not be earlier than the start time. - # If not provided, it indicates an ongoing alert. + # Optional. The time the event that caused this alert ceased being active. If + # provided, the end time must not be earlier than the start time. If not + # provided, it indicates an ongoing alert. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # Optional. `etag` is used for optimistic concurrency control as a way to help - # prevent simultaneous updates of an alert from overwriting each other. - # It is strongly suggested that systems make use of the `etag` in the - # read-modify-write cycle to perform alert updates in order to avoid race - # conditions: An `etag` is returned in the response which contains alerts, - # and systems are expected to put that etag in the request to update alert to - # ensure that their change will be applied to the same version of the alert. - # If no `etag` is provided in the call to update alert, then the existing - # alert is overwritten blindly. + # prevent simultaneous updates of an alert from overwriting each other. It is + # strongly suggested that systems make use of the `etag` in the read-modify- + # write cycle to perform alert updates in order to avoid race conditions: An ` + # etag` is returned in the response which contains alerts, and systems are + # expected to put that etag in the request to update alert to ensure that their + # change will be applied to the same version of the alert. If no `etag` is + # provided in the call to update alert, then the existing alert is overwritten + # blindly. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag @@ -195,36 +193,28 @@ module Google # @return [Google::Apis::AlertcenterV1beta1::AlertMetadata] attr_accessor :metadata - # Output only. An optional - # [Security Investigation Tool](https://support.google.com/a/answer/7575955) - # query for this alert. + # Output only. An optional [Security Investigation Tool](https://support.google. + # com/a/answer/7575955) query for this alert. # Corresponds to the JSON property `securityInvestigationToolLink` # @return [String] attr_accessor :security_investigation_tool_link - # Required. A unique identifier for the system that reported the alert. - # This is output only after alert is created. - # Supported sources are any of the following: - # * Google Operations - # * Mobile device management - # * Gmail phishing - # * Domain wide takeout - # * State sponsored attack - # * Google identity + # Required. A unique identifier for the system that reported the alert. This is + # output only after alert is created. Supported sources are any of the following: + # * Google Operations * Mobile device management * Gmail phishing * Domain wide + # takeout * State sponsored attack * Google identity # Corresponds to the JSON property `source` # @return [String] attr_accessor :source - # Required. The time the event that caused this alert was started or - # detected. + # Required. The time the event that caused this alert was started or detected. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time - # Required. The type of the alert. - # This is output only after alert is created. - # For a list of available alert types see - # [G Suite Alert types](/admin-sdk/alertcenter/reference/alert-types). + # Required. The type of the alert. This is output only after alert is created. + # For a list of available alert types see [G Suite Alert types](/admin-sdk/ + # alertcenter/reference/alert-types). # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -324,36 +314,29 @@ module Google # @return [String] attr_accessor :customer_id - # Optional. `etag` is used for optimistic concurrency control as a way to - # help prevent simultaneous updates of an alert metadata from overwriting - # each other. It is strongly suggested that systems make use of the `etag` in - # the read-modify-write cycle to perform metatdata updates in order to avoid - # race conditions: An `etag` is returned in the response which contains alert - # metadata, and systems are expected to put that etag in the request to - # update alert metadata to ensure that their change will be applied to the - # same version of the alert metadata. - # If no `etag` is provided in the call to update alert metadata, then the - # existing alert metadata is overwritten blindly. + # Optional. `etag` is used for optimistic concurrency control as a way to help + # prevent simultaneous updates of an alert metadata from overwriting each other. + # It is strongly suggested that systems make use of the `etag` in the read- + # modify-write cycle to perform metatdata updates in order to avoid race + # conditions: An `etag` is returned in the response which contains alert + # metadata, and systems are expected to put that etag in the request to update + # alert metadata to ensure that their change will be applied to the same version + # of the alert metadata. If no `etag` is provided in the call to update alert + # metadata, then the existing alert metadata is overwritten blindly. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag # The severity value of the alert. Alert Center will set this field at alert - # creation time, default's to an empty string when it could not be - # determined. - # The supported values for update actions on this field are the following: - # * HIGH - # * MEDIUM - # * LOW + # creation time, default's to an empty string when it could not be determined. + # The supported values for update actions on this field are the following: * + # HIGH * MEDIUM * LOW # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity - # The current status of the alert. - # The supported values are the following: - # * NOT_STARTED - # * IN_PROGRESS - # * CLOSED + # The current status of the alert. The supported values are the following: * + # NOT_STARTED * IN_PROGRESS * CLOSED # Corresponds to the JSON property `status` # @return [String] attr_accessor :status @@ -402,8 +385,8 @@ module Google class Attachment include Google::Apis::Core::Hashable - # A representation of a CSV file attachment, as a list of column headers and - # a list of data rows. + # A representation of a CSV file attachment, as a list of column headers and a + # list of data rows. # Corresponds to the JSON property `csv` # @return [Google::Apis::AlertcenterV1beta1::Csv] attr_accessor :csv @@ -438,8 +421,7 @@ module Google # @return [Array] attr_accessor :messages - # The source IP address of the malicious email, for example, - # `127.0.0.1`. + # The source IP address of the malicious email, for example, `127.0.0.1`. # Corresponds to the JSON property `sourceIp` # @return [String] attr_accessor :source_ip @@ -559,21 +541,20 @@ module Google end end - # A reference to a Cloud Pubsub topic. - # To register for notifications, the owner of the topic must grant - # `alerts-api-push-notifications@system.gserviceaccount.com` the - # `projects.topics.publish` permission. + # A reference to a Cloud Pubsub topic. To register for notifications, the owner + # of the topic must grant `alerts-api-push-notifications@system.gserviceaccount. + # com` the `projects.topics.publish` permission. class CloudPubsubTopic include Google::Apis::Core::Hashable - # Optional. The format of the payload that would be sent. - # If not specified the format will be JSON. + # Optional. The format of the payload that would be sent. If not specified the + # format will be JSON. # Corresponds to the JSON property `payloadFormat` # @return [String] attr_accessor :payload_format - # The `name` field of a Cloud Pubsub [Topic] - # (https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics#Topic). + # The `name` field of a Cloud Pubsub [Topic] (https://cloud.google.com/pubsub/ + # docs/reference/rest/v1/projects.topics#Topic). # Corresponds to the JSON property `topicName` # @return [String] attr_accessor :topic_name @@ -589,13 +570,13 @@ module Google end end - # A representation of a CSV file attachment, as a list of column headers and - # a list of data rows. + # A representation of a CSV file attachment, as a list of column headers and a + # list of data rows. class Csv include Google::Apis::Core::Hashable - # The list of data rows in a CSV file, as string arrays rather than as a - # single comma-separated string. + # The list of data rows in a CSV file, as string arrays rather than as a single + # comma-separated string. # Corresponds to the JSON property `dataRows` # @return [Array] attr_accessor :data_rows @@ -620,8 +601,8 @@ module Google class CsvRow include Google::Apis::Core::Hashable - # The data entries in a CSV file row, as a string array rather than a - # single comma-separated string. + # The data entries in a CSV file row, as a string array rather than a single + # comma-separated string. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries @@ -665,8 +646,8 @@ module Google class DeviceCompromisedSecurityDetail include Google::Apis::Core::Hashable - # The device compromised state. Possible values are "`Compromised`" or - # "`Not Compromised`". + # The device compromised state. Possible values are "`Compromised`" or "`Not + # Compromised`". # Corresponds to the JSON property `deviceCompromisedState` # @return [String] attr_accessor :device_compromised_state @@ -782,13 +763,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 @@ -904,8 +883,8 @@ module Google class ListAlertFeedbackResponse include Google::Apis::Core::Hashable - # The list of alert feedback. - # Feedback entries for each alert are ordered by creation time descending. + # The list of alert feedback. Feedback entries for each alert are ordered by + # creation time descending. # Corresponds to the JSON property `feedback` # @return [Array] attr_accessor :feedback @@ -930,9 +909,9 @@ module Google attr_accessor :alerts # The token for the next page. If not empty, indicates that there may be more - # alerts that match the listing request; this value can be used in a - # subsequent ListAlertsRequest to get alerts continuing from last result - # of the current list call. + # alerts that match the listing request; this value can be used in a subsequent + # ListAlertsRequest to get alerts continuing from last result of the current + # list call. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -952,14 +931,14 @@ module Google class LoginDetails include Google::Apis::Core::Hashable - # Optional. The human-readable IP address (for example, - # `11.22.33.44`) that is associated with the warning event. + # Optional. The human-readable IP address (for example, `11.22.33.44`) that is + # associated with the warning event. # Corresponds to the JSON property `ipAddress` # @return [String] attr_accessor :ip_address - # Optional. The successful login time that is associated with the warning - # event. This isn't present for blocked login attempts. + # Optional. The successful login time that is associated with the warning event. + # This isn't present for blocked login attempts. # Corresponds to the JSON property `loginTime` # @return [String] attr_accessor :login_time @@ -975,14 +954,10 @@ module Google end end - # Proto for all phishing alerts with common payload. - # Supported types are any of the following: - # * User reported phishing - # * User reported spam spike - # * Suspicious message reported - # * Phishing reclassification - # * Malware reclassification - # * Gmail potential employee spoofing + # Proto for all phishing alerts with common payload. Supported types are any of + # the following: * User reported phishing * User reported spam spike * + # Suspicious message reported * Phishing reclassification * Malware + # reclassification * Gmail potential employee spoofing class MailPhishing include Google::Apis::Core::Hashable @@ -1082,16 +1057,14 @@ module Google end end - # Settings for callback notifications. - # For more details see [G Suite Alert + # Settings for callback notifications. For more details see [G Suite Alert # Notification](/admin-sdk/alertcenter/guides/notifications). class Notification include Google::Apis::Core::Hashable - # A reference to a Cloud Pubsub topic. - # To register for notifications, the owner of the topic must grant - # `alerts-api-push-notifications@system.gserviceaccount.com` the - # `projects.topics.publish` permission. + # A reference to a Cloud Pubsub topic. To register for notifications, the owner + # of the topic must grant `alerts-api-push-notifications@system.gserviceaccount. + # com` the `projects.topics.publish` permission. # Corresponds to the JSON property `cloudPubsubTopic` # @return [Google::Apis::AlertcenterV1beta1::CloudPubsubTopic] attr_accessor :cloud_pubsub_topic @@ -1106,10 +1079,9 @@ module Google end end - # Alert for a spike in user reported phishing. - # + # Alert for a spike in user reported phishing. *Warning*: This type has been + # deprecated. Use [MailPhishing](/admin-sdk/alertcenter/reference/rest/v1beta1/ + # MailPhishing) instead. class PhishingSpike include Google::Apis::Core::Hashable @@ -1170,8 +1142,7 @@ module Google class RequestInfo include Google::Apis::Core::Hashable - # List of app developers who triggered notifications for above - # application. + # List of app developers who triggered notifications for above application. # Corresponds to the JSON property `appDeveloperEmail` # @return [Array] attr_accessor :app_developer_email @@ -1181,8 +1152,8 @@ module Google # @return [String] attr_accessor :app_key - # Required. Number of requests sent for this application to set up default - # SQL instance. + # Required. Number of requests sent for this application to set up default SQL + # instance. # Corresponds to the JSON property `numberOfRequests` # @return [Fixnum] attr_accessor :number_of_requests @@ -1264,13 +1235,11 @@ module Google # @return [Array] attr_accessor :match_info - # Resource recipients. - # For Drive, they are grantees that the Drive file was shared with at the - # time of rule triggering. Valid values include user emails, group emails, - # domains, or 'anyone' if the file was publicly accessible. If the file was - # private the recipients list will be empty. - # For Gmail, they are emails of the users or groups that the Gmail message - # was sent to. + # Resource recipients. For Drive, they are grantees that the Drive file was + # shared with at the time of rule triggering. Valid values include user emails, + # group emails, domains, or 'anyone' if the file was publicly accessible. If the + # file was private the recipients list will be empty. For Gmail, they are emails + # of the users or groups that the Gmail message was sent to. # Corresponds to the JSON property `recipients` # @return [Array] attr_accessor :recipients @@ -1362,12 +1331,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 @@ -1376,15 +1345,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 @@ -1498,8 +1467,8 @@ module Google include Google::Apis::Core::Hashable # Optional. The unique identifier of the G Suite organization account of the - # customer the alert is associated with. - # Inferred from the caller identity if not provided. + # customer the alert is associated with. Inferred from the caller identity if + # not provided. # Corresponds to the JSON property `customerId` # @return [String] attr_accessor :customer_id diff --git a/generated/google/apis/alertcenter_v1beta1/service.rb b/generated/google/apis/alertcenter_v1beta1/service.rb index b3dfcb832..0d07fc207 100644 --- a/generated/google/apis/alertcenter_v1beta1/service.rb +++ b/generated/google/apis/alertcenter_v1beta1/service.rb @@ -108,16 +108,16 @@ module Google end # Marks the specified alert for deletion. An alert that has been marked for - # deletion is removed from Alert Center after 30 days. - # Marking an alert for deletion has no effect on an alert which has - # already been marked for deletion. Attempting to mark a nonexistent alert - # for deletion results in a `NOT_FOUND` error. + # deletion is removed from Alert Center after 30 days. Marking an alert for + # deletion has no effect on an alert which has already been marked for deletion. + # Attempting to mark a nonexistent alert for deletion results in a `NOT_FOUND` + # error. # @param [String] alert_id # Required. The identifier of the alert to delete. # @param [String] customer_id # Optional. The unique identifier of the G Suite organization account of the - # customer the alert is associated with. - # Inferred from the caller identity if not provided. + # customer the alert is associated with. Inferred from the caller identity if + # not provided. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -146,14 +146,14 @@ module Google execute_or_queue_command(command, &block) end - # Gets the specified alert. Attempting to get a nonexistent alert returns - # `NOT_FOUND` error. + # Gets the specified alert. Attempting to get a nonexistent alert returns ` + # NOT_FOUND` error. # @param [String] alert_id # Required. The identifier of the alert to retrieve. # @param [String] customer_id # Optional. The unique identifier of the G Suite organization account of the - # customer the alert is associated with. - # Inferred from the caller identity if not provided. + # customer the alert is associated with. Inferred from the caller identity if + # not provided. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -182,14 +182,14 @@ module Google execute_or_queue_command(command, &block) end - # Returns the metadata of an alert. Attempting to get metadata for - # a non-existent alert returns `NOT_FOUND` error. + # Returns the metadata of an alert. Attempting to get metadata for a non- + # existent alert returns `NOT_FOUND` error. # @param [String] alert_id # Required. The identifier of the alert this metadata belongs to. # @param [String] customer_id # Optional. The unique identifier of the G Suite organization account of the - # customer the alert metadata is associated with. - # Inferred from the caller identity if not provided. + # customer the alert metadata is associated with. Inferred from the caller + # identity if not provided. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -221,29 +221,26 @@ module Google # Lists the alerts. # @param [String] customer_id # Optional. The unique identifier of the G Suite organization account of the - # customer the alerts are associated with. - # Inferred from the caller identity if not provided. + # customer the alerts are associated with. Inferred from the caller identity if + # not provided. # @param [String] filter - # Optional. A query string for filtering alert results. - # For more details, see [Query - # filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported - # query filter - # fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.list). + # Optional. A query string for filtering alert results. For more details, see [ + # Query filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported + # query filter fields](/admin-sdk/alertcenter/reference/filter-fields#alerts. + # list). # @param [String] order_by - # Optional. The sort order of the list results. - # If not specified results may be returned in arbitrary order. - # You can sort the results in descending order based on the creation - # timestamp using `order_by="create_time desc"`. - # Currently, supported sorting are `create_time asc`, `create_time desc`, - # `update_time desc` + # Optional. The sort order of the list results. If not specified results may be + # returned in arbitrary order. You can sort the results in descending order + # based on the creation timestamp using `order_by="create_time desc"`. Currently, + # supported sorting are `create_time asc`, `create_time desc`, `update_time + # desc` # @param [Fixnum] page_size # Optional. The requested page size. Server may return fewer items than # requested. If unspecified, server picks an appropriate default. # @param [String] page_token - # Optional. A token identifying a page of results the server should return. - # If empty, a new iteration is started. To continue an iteration, pass in - # the value from the previous ListAlertsResponse's - # next_page_token field. + # Optional. A token identifying a page of results the server should return. If + # empty, a new iteration is started. To continue an iteration, pass in the value + # from the previous ListAlertsResponse's next_page_token field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -277,9 +274,9 @@ module Google # Restores, or "undeletes", an alert that was marked for deletion within the # past 30 days. Attempting to undelete an alert which was marked for deletion - # over 30 days ago (which has been removed from the Alert Center database) or - # a nonexistent alert returns a `NOT_FOUND` error. Attempting to - # undelete an alert which has not been marked for deletion has no effect. + # over 30 days ago (which has been removed from the Alert Center database) or a + # nonexistent alert returns a `NOT_FOUND` error. Attempting to undelete an alert + # which has not been marked for deletion has no effect. # @param [String] alert_id # Required. The identifier of the alert to undelete. # @param [Google::Apis::AlertcenterV1beta1::UndeleteAlertRequest] undelete_alert_request_object @@ -312,17 +309,16 @@ module Google execute_or_queue_command(command, &block) end - # Creates new feedback for an alert. Attempting to create a feedback for - # a non-existent alert returns `NOT_FOUND` error. Attempting to create a - # feedback for an alert that is marked for deletion returns - # `FAILED_PRECONDITION' error. + # Creates new feedback for an alert. Attempting to create a feedback for a non- + # existent alert returns `NOT_FOUND` error. Attempting to create a feedback for + # an alert that is marked for deletion returns `FAILED_PRECONDITION' error. # @param [String] alert_id # Required. The identifier of the alert this feedback belongs to. # @param [Google::Apis::AlertcenterV1beta1::AlertFeedback] alert_feedback_object # @param [String] customer_id # Optional. The unique identifier of the G Suite organization account of the - # customer the alert is associated with. - # Inferred from the caller identity if not provided. + # customer the alert is associated with. Inferred from the caller identity if + # not provided. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -353,21 +349,20 @@ module Google execute_or_queue_command(command, &block) end - # Lists all the feedback for an alert. Attempting to list feedbacks for - # a non-existent alert returns `NOT_FOUND` error. + # Lists all the feedback for an alert. Attempting to list feedbacks for a non- + # existent alert returns `NOT_FOUND` error. # @param [String] alert_id - # Required. The alert identifier. - # The "-" wildcard could be used to represent all alerts. + # Required. The alert identifier. The "-" wildcard could be used to represent + # all alerts. # @param [String] customer_id # Optional. The unique identifier of the G Suite organization account of the - # customer the alert feedback are associated with. - # Inferred from the caller identity if not provided. + # customer the alert feedback are associated with. Inferred from the caller + # identity if not provided. # @param [String] filter - # Optional. A query string for filtering alert feedback results. - # For more details, see [Query - # filters](/admin-sdk/alertcenter/guides/query-filters) and [Supported - # query filter - # fields](/admin-sdk/alertcenter/reference/filter-fields#alerts.feedback.list). + # Optional. A query string for filtering alert feedback results. For more + # details, see [Query filters](/admin-sdk/alertcenter/guides/query-filters) and [ + # Supported query filter fields](/admin-sdk/alertcenter/reference/filter-fields# + # alerts.feedback.list). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -400,8 +395,8 @@ module Google # Returns customer-level settings. # @param [String] customer_id # Optional. The unique identifier of the G Suite organization account of the - # customer the alert settings are associated with. - # Inferred from the caller identity if not provided. + # customer the alert settings are associated with. Inferred from the caller + # identity if not provided. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -433,8 +428,8 @@ module Google # @param [Google::Apis::AlertcenterV1beta1::Settings] settings_object # @param [String] customer_id # Optional. The unique identifier of the G Suite organization account of the - # customer the alert settings are associated with. - # Inferred from the caller identity if not provided. + # customer the alert settings are associated with. Inferred from the caller + # identity if not provided. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/analyticsreporting_v4.rb b/generated/google/apis/analyticsreporting_v4.rb index c493c26a4..676f0b019 100644 --- a/generated/google/apis/analyticsreporting_v4.rb +++ b/generated/google/apis/analyticsreporting_v4.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/analytics/devguides/reporting/core/v4/ module AnalyticsreportingV4 VERSION = 'V4' - REVISION = '20200210' + REVISION = '20200803' # View and manage your Google Analytics data AUTH_ANALYTICS = 'https://www.googleapis.com/auth/analytics' diff --git a/generated/google/apis/analyticsreporting_v4/classes.rb b/generated/google/apis/analyticsreporting_v4/classes.rb index 83629de54..b607a25e0 100644 --- a/generated/google/apis/analyticsreporting_v4/classes.rb +++ b/generated/google/apis/analyticsreporting_v4/classes.rb @@ -22,23 +22,21 @@ module Google module Apis module AnalyticsreportingV4 - # An Activity represents data for an activity of a user. Note that an - # Activity is different from a hit. - # A hit might result in multiple Activity's. For example, if a hit - # includes a transaction and a goal completion, there will be two - # Activity protos for this hit, one for ECOMMERCE and one for GOAL. - # Conversely, multiple hits can also construct one Activity. In classic - # e-commerce, data for one transaction might be sent through multiple hits. - # These hits will be merged into one ECOMMERCE Activity. + # An Activity represents data for an activity of a user. Note that an Activity + # is different from a hit. A hit might result in multiple Activity's. For + # example, if a hit includes a transaction and a goal completion, there will be + # two Activity protos for this hit, one for ECOMMERCE and one for GOAL. + # Conversely, multiple hits can also construct one Activity. In classic e- + # commerce, data for one transaction might be sent through multiple hits. These + # hits will be merged into one ECOMMERCE Activity. class Activity include Google::Apis::Core::Hashable - # Timestamp of the activity. If activities for a visit cross midnight and - # occur in two separate dates, then two sessions (one per date) - # share the session identifier. - # For example, say session ID 113472 has activity within 2019-08-20, and - # session ID 243742 has activity within 2019-08-25 and 2019-08-26. Session ID - # 113472 is one session, and session ID 243742 is two sessions. + # Timestamp of the activity. If activities for a visit cross midnight and occur + # in two separate dates, then two sessions (one per date) share the session + # identifier. For example, say session ID 113472 has activity within 2019-08-20, + # and session ID 243742 has activity within 2019-08-25 and 2019-08-26. Session + # ID 113472 is one session, and session ID 243742 is two sessions. # Corresponds to the JSON property `activityTime` # @return [String] attr_accessor :activity_time @@ -54,15 +52,15 @@ module Google attr_accessor :appview # For manual campaign tracking, it is the value of the utm_campaign campaign - # tracking parameter. For AdWords autotagging, it is the name(s) of the - # online ad campaign(s) you use for the property. If you use neither, its - # value is (not set). + # tracking parameter. For AdWords autotagging, it is the name(s) of the online + # ad campaign(s) you use for the property. If you use neither, its value is (not + # set). # Corresponds to the JSON property `campaign` # @return [String] attr_accessor :campaign - # The Channel Group associated with an end user's session for this View - # (defined by the View's Channel Groupings). + # The Channel Group associated with an end user's session for this View (defined + # by the View's Channel Groupings). # Corresponds to the JSON property `channelGrouping` # @return [String] attr_accessor :channel_grouping @@ -94,11 +92,10 @@ module Google # For manual campaign tracking, it is the value of the utm_term campaign # tracking parameter. For AdWords traffic, it contains the best matching - # targeting criteria. For the display network, where multiple targeting - # criteria could have caused the ad to show up, it returns the best matching - # targeting criteria as selected by Ads. This could be display_keyword, site - # placement, boomuserlist, user_interest, age, or gender. Otherwise its value - # is (not set). + # targeting criteria. For the display network, where multiple targeting criteria + # could have caused the ad to show up, it returns the best matching targeting + # criteria as selected by Ads. This could be display_keyword, site placement, + # boomuserlist, user_interest, age, or gender. Otherwise its value is (not set). # Corresponds to the JSON property `keyword` # @return [String] attr_accessor :keyword @@ -109,11 +106,10 @@ module Google attr_accessor :landing_page_path # The type of referrals. For manual campaign tracking, it is the value of the - # utm_medium campaign tracking parameter. For AdWords autotagging, it is cpc. - # If users came from a search engine detected by Google Analytics, it is - # organic. If the referrer is not a search engine, it is referral. If users - # came directly to the property and document.referrer is empty, its value is - # (none). + # utm_medium campaign tracking parameter. For AdWords autotagging, it is cpc. If + # users came from a search engine detected by Google Analytics, it is organic. + # If the referrer is not a search engine, it is referral. If users came directly + # to the property and document.referrer is empty, its value is (none). # Corresponds to the JSON property `medium` # @return [String] attr_accessor :medium @@ -123,11 +119,11 @@ module Google # @return [Google::Apis::AnalyticsreportingV4::PageviewData] attr_accessor :pageview - # The source of referrals. For manual campaign tracking, it is the value of - # the utm_source campaign tracking parameter. For AdWords autotagging, it is - # google. If you use neither, it is the domain of the source - # (e.g., document.referrer) referring the users. It may also contain a port - # address. If users arrived without a referrer, its value is (direct). + # The source of referrals. For manual campaign tracking, it is the value of the + # utm_source campaign tracking parameter. For AdWords autotagging, it is google. + # If you use neither, it is the domain of the source (e.g., document.referrer) + # referring the users. It may also contain a port address. If users arrived + # without a referrer, its value is (direct). # Corresponds to the JSON property `source` # @return [String] attr_accessor :source @@ -157,27 +153,27 @@ module Google end # Defines a cohort. A cohort is a group of users who share a common - # characteristic. For example, all users with the same acquisition date - # belong to the same cohort. + # characteristic. For example, all users with the same acquisition date belong + # to the same cohort. class Cohort include Google::Apis::Core::Hashable - # A contiguous set of days: startDate, startDate + 1 day, ..., endDate. - # The start and end dates are specified in - # [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`. + # A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The + # start and end dates are specified in [ISO8601](https://en.wikipedia.org/wiki/ + # ISO_8601) date format `YYYY-MM-DD`. # Corresponds to the JSON property `dateRange` # @return [Google::Apis::AnalyticsreportingV4::DateRange] attr_accessor :date_range - # A unique name for the cohort. If not defined name will be auto-generated - # with values cohort_[1234...]. + # A unique name for the cohort. If not defined name will be auto-generated with + # values cohort_[1234...]. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Type of the cohort. The only supported type as of now is - # `FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated - # as `FIRST_VISIT_DATE` type cohort. + # Type of the cohort. The only supported type as of now is `FIRST_VISIT_DATE`. + # If this field is unspecified the cohort is treated as `FIRST_VISIT_DATE` type + # cohort. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -194,19 +190,10 @@ module Google end end - # Defines a cohort group. - # For example: - # "cohortGroup": ` - # "cohorts": [` - # "name": "cohort 1", - # "type": "FIRST_VISIT_DATE", - # "dateRange": ` "startDate": "2015-08-01", "endDate": "2015-08-01" ` - # `,` - # "name": "cohort 2" - # "type": "FIRST_VISIT_DATE" - # "dateRange": ` "startDate": "2015-07-01", "endDate": "2015-07-01" ` - # `] - # ` + # Defines a cohort group. For example: "cohortGroup": ` "cohorts": [` "name": " + # cohort 1", "type": "FIRST_VISIT_DATE", "dateRange": ` "startDate": "2015-08-01" + # , "endDate": "2015-08-01" ` `,` "name": "cohort 2" "type": "FIRST_VISIT_DATE" " + # dateRange": ` "startDate": "2015-07-01", "endDate": "2015-07-01" ` `] ` class CohortGroup include Google::Apis::Core::Hashable @@ -215,33 +202,24 @@ module Google # @return [Array] attr_accessor :cohorts - # Enable Life Time Value (LTV). LTV measures lifetime value for users - # acquired through different channels. - # Please see: - # [Cohort Analysis](https://support.google.com/analytics/answer/6074676) and - # [Lifetime Value](https://support.google.com/analytics/answer/6182550) - # If the value of lifetimeValue is false: - # - The metric values are similar to the values in the web interface cohort - # report. - # - The cohort definition date ranges must be aligned to the calendar week - # and month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in - # the cohort definition should be a Sunday and the `endDate` should be the - # following Saturday, and for `ga:cohortNthMonth`, the `startDate` - # should be the 1st of the month and `endDate` should be the last day - # of the month. - # When the lifetimeValue is true: - # - The metric values will correspond to the values in the web interface - # LifeTime value report. - # - The Lifetime Value report shows you how user value (Revenue) and - # engagement (Appviews, Goal Completions, Sessions, and Session Duration) - # grow during the 90 days after a user is acquired. - # - The metrics are calculated as a cumulative average per user per the time - # increment. - # - The cohort definition date ranges need not be aligned to the calendar - # week and month boundaries. - # - The `viewId` must be an - # [app view - # ID](https://support.google.com/analytics/answer/2649553#WebVersusAppViews) + # Enable Life Time Value (LTV). LTV measures lifetime value for users acquired + # through different channels. Please see: [Cohort Analysis](https://support. + # google.com/analytics/answer/6074676) and [Lifetime Value](https://support. + # google.com/analytics/answer/6182550) If the value of lifetimeValue is false: - + # The metric values are similar to the values in the web interface cohort report. + # - The cohort definition date ranges must be aligned to the calendar week and + # month. i.e. while requesting `ga:cohortNthWeek` the `startDate` in the cohort + # definition should be a Sunday and the `endDate` should be the following + # Saturday, and for `ga:cohortNthMonth`, the `startDate` should be the 1st of + # the month and `endDate` should be the last day of the month. When the + # lifetimeValue is true: - The metric values will correspond to the values in + # the web interface LifeTime value report. - The Lifetime Value report shows you + # how user value (Revenue) and engagement (Appviews, Goal Completions, Sessions, + # and Session Duration) grow during the 90 days after a user is acquired. - The + # metrics are calculated as a cumulative average per user per the time increment. + # - The cohort definition date ranges need not be aligned to the calendar week + # and month boundaries. - The `viewId` must be an [app view ID](https://support. + # google.com/analytics/answer/2649553#WebVersusAppViews) # Corresponds to the JSON property `lifetimeValue` # @return [Boolean] attr_accessor :lifetime_value @@ -309,9 +287,9 @@ module Google end end - # A contiguous set of days: startDate, startDate + 1 day, ..., endDate. - # The start and end dates are specified in - # [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`. + # A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The + # start and end dates are specified in [ISO8601](https://en.wikipedia.org/wiki/ + # ISO_8601) date format `YYYY-MM-DD`. class DateRange include Google::Apis::Core::Hashable @@ -362,38 +340,31 @@ module Google end end - # [Dimensions](https://support.google.com/analytics/answer/1033861) - # are attributes of your data. For example, the dimension `ga:city` - # indicates the city, for example, "Paris" or "New York", from which - # a session originates. + # [Dimensions](https://support.google.com/analytics/answer/1033861) are + # attributes of your data. For example, the dimension `ga:city` indicates the + # city, for example, "Paris" or "New York", from which a session originates. class Dimension include Google::Apis::Core::Hashable - # If non-empty, we place dimension values into buckets after string to - # int64. Dimension values that are not the string representation of an - # integral value will be converted to zero. The bucket values have to be in - # increasing order. Each bucket is closed on the lower end, and open on the - # upper end. The "first" bucket includes all values less than the first - # boundary, the "last" bucket includes all values up to infinity. Dimension - # values that fall in a bucket get transformed to a new dimension value. For - # example, if one gives a list of "0, 1, 3, 4, 7", then we return the - # following buckets: - # - bucket #1: values < 0, dimension value "<0" - # - bucket #2: values in [0,1), dimension value "0" - # - bucket #3: values in [1,3), dimension value "1-2" - # - bucket #4: values in [3,4), dimension value "3" - # - bucket #5: values in [4,7), dimension value "4-6" - # - bucket #6: values >= 7, dimension value "7+" - # NOTE: If you are applying histogram mutation on any dimension, and using - # that dimension in sort, you will want to use the sort type - # `HISTOGRAM_BUCKET` for that purpose. Without that the dimension values - # will be sorted according to dictionary - # (lexicographic) order. For example the ascending dictionary order is: - # "<50", "1001+", "121-1000", "50-120" - # And the ascending `HISTOGRAM_BUCKET` order is: - # "<50", "50-120", "121-1000", "1001+" - # The client has to explicitly request `"orderType": "HISTOGRAM_BUCKET"` - # for a histogram-mutated dimension. + # If non-empty, we place dimension values into buckets after string to int64. + # Dimension values that are not the string representation of an integral value + # will be converted to zero. The bucket values have to be in increasing order. + # Each bucket is closed on the lower end, and open on the upper end. The "first" + # bucket includes all values less than the first boundary, the "last" bucket + # includes all values up to infinity. Dimension values that fall in a bucket get + # transformed to a new dimension value. For example, if one gives a list of "0, + # 1, 3, 4, 7", then we return the following buckets: - bucket #1: values < 0, + # dimension value "<0" - bucket #2: values in [0,1), dimension value "0" - + # bucket #3: values in [1,3), dimension value "1-2" - bucket #4: values in [3,4), + # dimension value "3" - bucket #5: values in [4,7), dimension value "4-6" - + # bucket #6: values >= 7, dimension value "7+" NOTE: If you are applying + # histogram mutation on any dimension, and using that dimension in sort, you + # will want to use the sort type `HISTOGRAM_BUCKET` for that purpose. Without + # that the dimension values will be sorted according to dictionary ( + # lexicographic) order. For example the ascending dictionary order is: "<50", " + # 1001+", "121-1000", "50-120" And the ascending `HISTOGRAM_BUCKET` order is: "< + # 50", "50-120", "121-1000", "1001+" The client has to explicitly request `" + # orderType": "HISTOGRAM_BUCKET"` for a histogram-mutated dimension. # Corresponds to the JSON property `histogramBuckets` # @return [Array] attr_accessor :histogram_buckets @@ -429,10 +400,10 @@ module Google # @return [String] attr_accessor :dimension_name - # Strings or regular expression to match against. Only the first value of - # the list is used for comparison unless the operator is `IN_LIST`. - # If `IN_LIST` operator, then the entire list is used to filter the - # dimensions as explained in the description of the `IN_LIST` operator. + # Strings or regular expression to match against. Only the first value of the + # list is used for comparison unless the operator is `IN_LIST`. If `IN_LIST` + # operator, then the entire list is used to filter the dimensions as explained + # in the description of the `IN_LIST` operator. # Corresponds to the JSON property `expressions` # @return [Array] attr_accessor :expressions @@ -463,19 +434,19 @@ module Google end end - # A group of dimension filters. Set the operator value to specify how - # the filters are logically combined. + # A group of dimension filters. Set the operator value to specify how the + # filters are logically combined. class DimensionFilterClause include Google::Apis::Core::Hashable - # The repeated set of filters. They are logically combined based on the - # operator specified. + # The repeated set of filters. They are logically combined based on the operator + # specified. # Corresponds to the JSON property `filters` # @return [Array] attr_accessor :filters - # The operator for combining multiple dimension filters. If unspecified, it - # is treated as an `OR`. + # The operator for combining multiple dimension filters. If unspecified, it is + # treated as an `OR`. # Corresponds to the JSON property `operator` # @return [String] attr_accessor :operator @@ -491,8 +462,8 @@ module Google end end - # Dynamic segment definition for defining the segment within the request. - # A segment can select users, sessions or both. + # Dynamic segment definition for defining the segment within the request. A + # segment can select users, sessions or both. class DynamicSegment include Google::Apis::Core::Hashable @@ -501,14 +472,14 @@ module Google # @return [String] attr_accessor :name - # SegmentDefinition defines the segment to be a set of SegmentFilters which - # are combined together with a logical `AND` operation. + # SegmentDefinition defines the segment to be a set of SegmentFilters which are + # combined together with a logical `AND` operation. # Corresponds to the JSON property `sessionSegment` # @return [Google::Apis::AnalyticsreportingV4::SegmentDefinition] attr_accessor :session_segment - # SegmentDefinition defines the segment to be a set of SegmentFilters which - # are combined together with a logical `AND` operation. + # SegmentDefinition defines the segment to be a set of SegmentFilters which are + # combined together with a logical `AND` operation. # Corresponds to the JSON property `userSegment` # @return [Google::Apis::AnalyticsreportingV4::SegmentDefinition] attr_accessor :user_segment @@ -610,26 +581,20 @@ module Google class GetReportsRequest include Google::Apis::Core::Hashable - # Requests, each request will have a separate response. - # There can be a maximum of 5 requests. All requests should have the same - # `dateRanges`, `viewId`, `segments`, `samplingLevel`, and `cohortGroup`. + # Requests, each request will have a separate response. There can be a maximum + # of 5 requests. All requests should have the same `dateRanges`, `viewId`, ` + # segments`, `samplingLevel`, and `cohortGroup`. # Corresponds to the JSON property `reportRequests` # @return [Array] attr_accessor :report_requests - # Enables - # [resource based - # quotas](/analytics/devguides/reporting/core/v4/limits-quotas# - # analytics_reporting_api_v4), - # (defaults to `False`). If this field is set to `True` the - # per view (profile) quotas are governed by the computational - # cost of the request. Note that using cost based quotas will - # higher enable sampling rates. (10 Million for `SMALL`, - # 100M for `LARGE`. See the - # [limits and quotas - # documentation](/analytics/devguides/reporting/core/v4/limits-quotas# - # analytics_reporting_api_v4) - # for details. + # Enables [resource based quotas](/analytics/devguides/reporting/core/v4/limits- + # quotas#analytics_reporting_api_v4), (defaults to `False`). If this field is + # set to `True` the per view (profile) quotas are governed by the computational + # cost of the request. Note that using cost based quotas will higher enable + # sampling rates. (10 Million for `SMALL`, 100M for `LARGE`. See the [limits and + # quotas documentation](/analytics/devguides/reporting/core/v4/limits-quotas# + # analytics_reporting_api_v4) for details. # Corresponds to the JSON property `useResourceQuotas` # @return [Boolean] attr_accessor :use_resource_quotas @@ -646,8 +611,8 @@ module Google end end - # The main response class which holds the reports from the Reporting API - # `batchGet` call. + # The main response class which holds the reports from the Reporting API ` + # batchGet` call. class GetReportsResponse include Google::Apis::Core::Hashable @@ -760,35 +725,33 @@ module Google end end - # [Metrics](https://support.google.com/analytics/answer/1033861) - # are the quantitative measurements. For example, the metric `ga:users` - # indicates the total number of users for the requested time period. + # [Metrics](https://support.google.com/analytics/answer/1033861) are the + # quantitative measurements. For example, the metric `ga:users` indicates the + # total number of users for the requested time period. class Metric include Google::Apis::Core::Hashable - # An alias for the metric expression is an alternate name for the - # expression. The alias can be used for filtering and sorting. This field - # is optional and is useful if the expression is not a single metric but - # a complex expression which cannot be used in filtering and sorting. - # The alias is also used in the response column header. + # An alias for the metric expression is an alternate name for the expression. + # The alias can be used for filtering and sorting. This field is optional and is + # useful if the expression is not a single metric but a complex expression which + # cannot be used in filtering and sorting. The alias is also used in the + # response column header. # Corresponds to the JSON property `alias` # @return [String] attr_accessor :alias - # A metric expression in the request. An expression is constructed from one - # or more metrics and numbers. Accepted operators include: Plus (+), Minus - # (-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis, - # Positive cardinal numbers (0-9), can include decimals and is limited to - # 1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the - # metric expression is just a single metric name like `ga:users`. - # Adding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics - # will result in unexpected results. + # A metric expression in the request. An expression is constructed from one or + # more metrics and numbers. Accepted operators include: Plus (+), Minus (-), + # Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis, Positive + # cardinal numbers (0-9), can include decimals and is limited to 1024 characters. + # Example `ga:totalRefunds/ga:users`, in most cases the metric expression is + # just a single metric name like `ga:users`. Adding mixed `MetricType` (E.g., ` + # CURRENCY` + `PERCENTAGE`) metrics will result in unexpected results. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression - # Specifies how the metric expression should be formatted, for example - # `INTEGER`. + # Specifies how the metric expression should be formatted, for example `INTEGER`. # Corresponds to the JSON property `formattingType` # @return [String] attr_accessor :formatting_type @@ -814,9 +777,9 @@ module Google # @return [String] attr_accessor :comparison_value - # The metric that will be filtered on. A metricFilter must contain a metric - # name. A metric name can be an alias earlier defined as a metric or it can - # also be a metric expression. + # The metric that will be filtered on. A metricFilter must contain a metric name. + # A metric name can be an alias earlier defined as a metric or it can also be a + # metric expression. # Corresponds to the JSON property `metricName` # @return [String] attr_accessor :metric_name @@ -828,10 +791,9 @@ module Google attr_accessor :not alias_method :not?, :not - # Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the - # comparisonValue, the default is `EQUAL`. If the operator is - # `IS_MISSING`, checks if the metric is missing and would ignore the - # comparisonValue. + # Is the metric `EQUAL`, `LESS_THAN` or `GREATER_THAN` the comparisonValue, the + # default is `EQUAL`. If the operator is `IS_MISSING`, checks if the metric is + # missing and would ignore the comparisonValue. # Corresponds to the JSON property `operator` # @return [String] attr_accessor :operator @@ -849,13 +811,13 @@ module Google end end - # Represents a group of metric filters. - # Set the operator value to specify how the filters are logically combined. + # Represents a group of metric filters. Set the operator value to specify how + # the filters are logically combined. class MetricFilterClause include Google::Apis::Core::Hashable - # The repeated set of filters. They are logically combined based on the - # operator specified. + # The repeated set of filters. They are logically combined based on the operator + # specified. # Corresponds to the JSON property `filters` # @return [Array] attr_accessor :filters @@ -951,9 +913,8 @@ module Google class OrderBy include Google::Apis::Core::Hashable - # The field which to sort by. The default sort order is ascending. Example: - # `ga:browser`. - # Note, that you can only specify one field for sort here. For example, + # The field which to sort by. The default sort order is ascending. Example: `ga: + # browser`. Note, that you can only specify one field for sort here. For example, # `ga:browser, ga:city` is not valid. # Corresponds to the JSON property `fieldName` # @return [String] @@ -1006,54 +967,52 @@ module Google end end - # The Pivot describes the pivot section in the request. - # The Pivot helps rearrange the information in the table for certain reports - # by pivoting your data on a second dimension. + # The Pivot describes the pivot section in the request. The Pivot helps + # rearrange the information in the table for certain reports by pivoting your + # data on a second dimension. class Pivot include Google::Apis::Core::Hashable # DimensionFilterClauses are logically combined with an `AND` operator: only - # data that is included by all these DimensionFilterClauses contributes to - # the values in this pivot region. Dimension filters can be used to restrict - # the columns shown in the pivot region. For example if you have - # `ga:browser` as the requested dimension in the pivot region, and you - # specify key filters to restrict `ga:browser` to only "IE" or "Firefox", - # then only those two browsers would show up as columns. + # data that is included by all these DimensionFilterClauses contributes to the + # values in this pivot region. Dimension filters can be used to restrict the + # columns shown in the pivot region. For example if you have `ga:browser` as the + # requested dimension in the pivot region, and you specify key filters to + # restrict `ga:browser` to only "IE" or "Firefox", then only those two browsers + # would show up as columns. # Corresponds to the JSON property `dimensionFilterClauses` # @return [Array] attr_accessor :dimension_filter_clauses - # A list of dimensions to show as pivot columns. A Pivot can have a maximum - # of 4 dimensions. Pivot dimensions are part of the restriction on the - # total number of dimensions allowed in the request. + # A list of dimensions to show as pivot columns. A Pivot can have a maximum of 4 + # dimensions. Pivot dimensions are part of the restriction on the total number + # of dimensions allowed in the request. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions - # Specifies the maximum number of groups to return. - # The default value is 10, also the maximum value is 1,000. + # Specifies the maximum number of groups to return. The default value is 10, + # also the maximum value is 1,000. # Corresponds to the JSON property `maxGroupCount` # @return [Fixnum] attr_accessor :max_group_count - # The pivot metrics. Pivot metrics are part of the - # restriction on total number of metrics allowed in the request. + # The pivot metrics. Pivot metrics are part of the restriction on total number + # of metrics allowed in the request. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics - # If k metrics were requested, then the response will contain some - # data-dependent multiple of k columns in the report. E.g., if you pivoted - # on the dimension `ga:browser` then you'd get k columns for "Firefox", k - # columns for "IE", k columns for "Chrome", etc. The ordering of the groups - # of columns is determined by descending order of "total" for the first of - # the k values. Ties are broken by lexicographic ordering of the first - # pivot dimension, then lexicographic ordering of the second pivot - # dimension, and so on. E.g., if the totals for the first value for - # Firefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns - # would be Chrome, Firefox, IE. - # The following let you choose which of the groups of k columns are - # included in the response. + # If k metrics were requested, then the response will contain some data- + # dependent multiple of k columns in the report. E.g., if you pivoted on the + # dimension `ga:browser` then you'd get k columns for "Firefox", k columns for " + # IE", k columns for "Chrome", etc. The ordering of the groups of columns is + # determined by descending order of "total" for the first of the k values. Ties + # are broken by lexicographic ordering of the first pivot dimension, then + # lexicographic ordering of the second pivot dimension, and so on. E.g., if the + # totals for the first value for Firefox, IE, and Chrome were 8, 2, 8, + # respectively, the order of columns would be Chrome, Firefox, IE. The following + # let you choose which of the groups of k columns are included in the response. # Corresponds to the JSON property `startGroup` # @return [Fixnum] attr_accessor :start_group @@ -1157,8 +1116,8 @@ module Google # @return [Float] attr_accessor :item_revenue - # The product name, supplied by the e-commerce tracking application, for - # the purchased items. + # The product name, supplied by the e-commerce tracking application, for the + # purchased items. # Corresponds to the JSON property `productName` # @return [String] attr_accessor :product_name @@ -1227,24 +1186,22 @@ module Google # @return [String] attr_accessor :data_last_refreshed - # Indicates if response to this request is golden or not. Data is - # golden when the exact same request will not produce any new results if - # asked at a later point in time. + # Indicates if response to this request is golden or not. Data is golden when + # the exact same request will not produce any new results if asked at a later + # point in time. # Corresponds to the JSON property `isDataGolden` # @return [Boolean] attr_accessor :is_data_golden alias_method :is_data_golden?, :is_data_golden - # Minimum and maximum values seen over all matching rows. These are both - # empty when `hideValueRanges` in the request is false, or when - # rowCount is zero. + # Minimum and maximum values seen over all matching rows. These are both empty + # when `hideValueRanges` in the request is false, or when rowCount is zero. # Corresponds to the JSON property `maximums` # @return [Array] attr_accessor :maximums - # Minimum and maximum values seen over all matching rows. These are both - # empty when `hideValueRanges` in the request is false, or when - # rowCount is zero. + # Minimum and maximum values seen over all matching rows. These are both empty + # when `hideValueRanges` in the request is false, or when rowCount is zero. # Corresponds to the JSON property `minimums` # @return [Array] attr_accessor :minimums @@ -1259,34 +1216,29 @@ module Google # @return [Array] attr_accessor :rows - # If the results are - # [sampled](https://support.google.com/analytics/answer/2637192), - # this returns the total number of samples read, one entry per date range. - # If the results are not sampled this field will not be defined. See - # [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) - # for details. + # If the results are [sampled](https://support.google.com/analytics/answer/ + # 2637192), this returns the total number of samples read, one entry per date + # range. If the results are not sampled this field will not be defined. See [ + # developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for + # details. # Corresponds to the JSON property `samplesReadCounts` # @return [Array] attr_accessor :samples_read_counts - # If the results are - # [sampled](https://support.google.com/analytics/answer/2637192), - # this returns the total number of - # samples present, one entry per date range. If the results are not sampled - # this field will not be defined. See - # [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) - # for details. + # If the results are [sampled](https://support.google.com/analytics/answer/ + # 2637192), this returns the total number of samples present, one entry per date + # range. If the results are not sampled this field will not be defined. See [ + # developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for + # details. # Corresponds to the JSON property `samplingSpaceSizes` # @return [Array] attr_accessor :sampling_space_sizes - # For each requested date range, for the set of all rows that match - # the query, every requested value format gets a total. The total - # for a value format is computed by first totaling the metrics - # mentioned in the value format and then evaluating the value - # format as a scalar expression. E.g., The "totals" for - # `3 / (ga:sessions + 2)` we compute - # `3 / ((sum of all relevant ga:sessions) + 2)`. + # For each requested date range, for the set of all rows that match the query, + # every requested value format gets a total. The total for a value format is + # computed by first totaling the metrics mentioned in the value format and then + # evaluating the value format as a scalar expression. E.g., The "totals" for `3 / + # (ga:sessions + 2)` we compute `3 / ((sum of all relevant ga:sessions) + 2)`. # Totals are computed before pagination. # Corresponds to the JSON property `totals` # @return [Array] @@ -1314,125 +1266,108 @@ module Google class ReportRequest include Google::Apis::Core::Hashable - # Defines a cohort group. - # For example: - # "cohortGroup": ` - # "cohorts": [` - # "name": "cohort 1", - # "type": "FIRST_VISIT_DATE", - # "dateRange": ` "startDate": "2015-08-01", "endDate": "2015-08-01" ` - # `,` - # "name": "cohort 2" - # "type": "FIRST_VISIT_DATE" - # "dateRange": ` "startDate": "2015-07-01", "endDate": "2015-07-01" ` - # `] - # ` + # Defines a cohort group. For example: "cohortGroup": ` "cohorts": [` "name": " + # cohort 1", "type": "FIRST_VISIT_DATE", "dateRange": ` "startDate": "2015-08-01" + # , "endDate": "2015-08-01" ` `,` "name": "cohort 2" "type": "FIRST_VISIT_DATE" " + # dateRange": ` "startDate": "2015-07-01", "endDate": "2015-07-01" ` `] ` # Corresponds to the JSON property `cohortGroup` # @return [Google::Apis::AnalyticsreportingV4::CohortGroup] attr_accessor :cohort_group - # Date ranges in the request. The request can have a maximum of 2 date - # ranges. The response will contain a set of metric values for each - # combination of the dimensions for each date range in the request. So, if - # there are two date ranges, there will be two set of metric values, one for - # the original date range and one for the second date range. - # The `reportRequest.dateRanges` field should not be specified for cohorts - # or Lifetime value requests. - # If a date range is not provided, the default date range is (startDate: - # current date - 7 days, endDate: current date - 1 day). Every - # [ReportRequest](#ReportRequest) within a `batchGet` method must - # contain the same `dateRanges` definition. + # Date ranges in the request. The request can have a maximum of 2 date ranges. + # The response will contain a set of metric values for each combination of the + # dimensions for each date range in the request. So, if there are two date + # ranges, there will be two set of metric values, one for the original date + # range and one for the second date range. The `reportRequest.dateRanges` field + # should not be specified for cohorts or Lifetime value requests. If a date + # range is not provided, the default date range is (startDate: current date - 7 + # days, endDate: current date - 1 day). Every [ReportRequest](#ReportRequest) + # within a `batchGet` method must contain the same `dateRanges` definition. # Corresponds to the JSON property `dateRanges` # @return [Array] attr_accessor :date_ranges # The dimension filter clauses for filtering Dimension Values. They are - # logically combined with the `AND` operator. Note that filtering occurs - # before any dimensions are aggregated, so that the returned metrics - # represent the total for only the relevant dimensions. + # logically combined with the `AND` operator. Note that filtering occurs before + # any dimensions are aggregated, so that the returned metrics represent the + # total for only the relevant dimensions. # Corresponds to the JSON property `dimensionFilterClauses` # @return [Array] attr_accessor :dimension_filter_clauses - # The dimensions requested. - # Requests can have a total of 9 dimensions. + # The dimensions requested. Requests can have a total of 9 dimensions. # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions - # Dimension or metric filters that restrict the data returned for your - # request. To use the `filtersExpression`, supply a dimension or metric on - # which to filter, followed by the filter expression. For example, the - # following expression selects `ga:browser` dimension which starts with - # Firefox; `ga:browser=~^Firefox`. For more information on dimensions - # and metric filters, see - # [Filters - # reference](https://developers.google.com/analytics/devguides/reporting/core/v3/ - # reference#filters). + # Dimension or metric filters that restrict the data returned for your request. + # To use the `filtersExpression`, supply a dimension or metric on which to + # filter, followed by the filter expression. For example, the following + # expression selects `ga:browser` dimension which starts with Firefox; `ga: + # browser=~^Firefox`. For more information on dimensions and metric filters, see + # [Filters reference](https://developers.google.com/analytics/devguides/ + # reporting/core/v3/reference#filters). # Corresponds to the JSON property `filtersExpression` # @return [String] attr_accessor :filters_expression - # If set to true, hides the total of all metrics for all the matching rows, - # for every date range. The default false and will return the totals. + # If set to true, hides the total of all metrics for all the matching rows, for + # every date range. The default false and will return the totals. # Corresponds to the JSON property `hideTotals` # @return [Boolean] attr_accessor :hide_totals alias_method :hide_totals?, :hide_totals - # If set to true, hides the minimum and maximum across all matching rows. - # The default is false and the value ranges are returned. + # If set to true, hides the minimum and maximum across all matching rows. The + # default is false and the value ranges are returned. # Corresponds to the JSON property `hideValueRanges` # @return [Boolean] attr_accessor :hide_value_ranges alias_method :hide_value_ranges?, :hide_value_ranges # If set to false, the response does not include rows if all the retrieved - # metrics are equal to zero. The default is false which will exclude these - # rows. + # metrics are equal to zero. The default is false which will exclude these rows. # Corresponds to the JSON property `includeEmptyRows` # @return [Boolean] attr_accessor :include_empty_rows alias_method :include_empty_rows?, :include_empty_rows - # The metric filter clauses. They are logically combined with the `AND` - # operator. Metric filters look at only the first date range and not the - # comparing date range. Note that filtering on metrics occurs after the - # metrics are aggregated. + # The metric filter clauses. They are logically combined with the `AND` operator. + # Metric filters look at only the first date range and not the comparing date + # range. Note that filtering on metrics occurs after the metrics are aggregated. # Corresponds to the JSON property `metricFilterClauses` # @return [Array] attr_accessor :metric_filter_clauses - # The metrics requested. - # Requests must specify at least one metric. Requests can have a - # total of 10 metrics. + # The metrics requested. Requests must specify at least one metric. Requests can + # have a total of 10 metrics. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics - # Sort order on output rows. To compare two rows, the elements of the - # following are applied in order until a difference is found. All date - # ranges in the output get the same row order. + # Sort order on output rows. To compare two rows, the elements of the following + # are applied in order until a difference is found. All date ranges in the + # output get the same row order. # Corresponds to the JSON property `orderBys` # @return [Array] attr_accessor :order_bys # Page size is for paging and specifies the maximum number of returned rows. - # Page size should be >= 0. A query returns the default of 1,000 rows. - # The Analytics Core Reporting API returns a maximum of 100,000 rows per - # request, no matter how many you ask for. It can also return fewer rows - # than requested, if there aren't as many dimension segments as you expect. - # For instance, there are fewer than 300 possible values for `ga:country`, - # so when segmenting only by country, you can't get more than 300 rows, - # even if you set `pageSize` to a higher value. + # Page size should be >= 0. A query returns the default of 1,000 rows. The + # Analytics Core Reporting API returns a maximum of 100,000 rows per request, no + # matter how many you ask for. It can also return fewer rows than requested, if + # there aren't as many dimension segments as you expect. For instance, there are + # fewer than 300 possible values for `ga:country`, so when segmenting only by + # country, you can't get more than 300 rows, even if you set `pageSize` to a + # higher value. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size - # A continuation token to get the next page of the results. Adding this to - # the request will return the rows after the pageToken. The pageToken should - # be the value returned in the nextPageToken parameter in the response to - # the GetReports request. + # A continuation token to get the next page of the results. Adding this to the + # request will return the rows after the pageToken. The pageToken should be the + # value returned in the nextPageToken parameter in the response to the + # GetReports request. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token @@ -1442,30 +1377,28 @@ module Google # @return [Array] attr_accessor :pivots - # The desired report - # [sample](https://support.google.com/analytics/answer/2637192) size. - # If the the `samplingLevel` field is unspecified the `DEFAULT` sampling - # level is used. Every [ReportRequest](#ReportRequest) within a - # `batchGet` method must contain the same `samplingLevel` definition. See - # [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) - # for details. + # The desired report [sample](https://support.google.com/analytics/answer/ + # 2637192) size. If the the `samplingLevel` field is unspecified the `DEFAULT` + # sampling level is used. Every [ReportRequest](#ReportRequest) within a ` + # batchGet` method must contain the same `samplingLevel` definition. See [ + # developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for + # details. # Corresponds to the JSON property `samplingLevel` # @return [String] attr_accessor :sampling_level - # Segment the data returned for the request. A segment definition helps look - # at a subset of the segment request. A request can contain up to four - # segments. Every [ReportRequest](#ReportRequest) within a - # `batchGet` method must contain the same `segments` definition. Requests - # with segments must have the `ga:segment` dimension. + # Segment the data returned for the request. A segment definition helps look at + # a subset of the segment request. A request can contain up to four segments. + # Every [ReportRequest](#ReportRequest) within a `batchGet` method must contain + # the same `segments` definition. Requests with segments must have the `ga: + # segment` dimension. # Corresponds to the JSON property `segments` # @return [Array] attr_accessor :segments - # The Analytics - # [view ID](https://support.google.com/analytics/answer/1009618) - # from which to retrieve data. Every [ReportRequest](#ReportRequest) - # within a `batchGet` method must contain the same `viewId`. + # The Analytics [view ID](https://support.google.com/analytics/answer/1009618) + # from which to retrieve data. Every [ReportRequest](#ReportRequest) within a ` + # batchGet` method must contain the same `viewId`. # Corresponds to the JSON property `viewId` # @return [String] attr_accessor :view_id @@ -1588,16 +1521,15 @@ module Google class SearchUserActivityRequest include Google::Apis::Core::Hashable - # Set of all activity types being requested. Only acvities matching these - # types will be returned in the response. If empty, all activies will be - # returned. + # Set of all activity types being requested. Only acvities matching these types + # will be returned in the response. If empty, all activies will be returned. # Corresponds to the JSON property `activityTypes` # @return [Array] attr_accessor :activity_types - # A contiguous set of days: startDate, startDate + 1 day, ..., endDate. - # The start and end dates are specified in - # [ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`. + # A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The + # start and end dates are specified in [ISO8601](https://en.wikipedia.org/wiki/ + # ISO_8601) date format `YYYY-MM-DD`. # Corresponds to the JSON property `dateRange` # @return [Google::Apis::AnalyticsreportingV4::DateRange] attr_accessor :date_range @@ -1609,10 +1541,10 @@ module Google # @return [Fixnum] attr_accessor :page_size - # A continuation token to get the next page of the results. Adding this to - # the request will return the rows after the pageToken. The pageToken should - # be the value returned in the nextPageToken parameter in the response to - # the [SearchUserActivityRequest](#SearchUserActivityRequest) request. + # A continuation token to get the next page of the results. Adding this to the + # request will return the rows after the pageToken. The pageToken should be the + # value returned in the nextPageToken parameter in the response to the [ + # SearchUserActivityRequest](#SearchUserActivityRequest) request. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token @@ -1622,11 +1554,9 @@ module Google # @return [Google::Apis::AnalyticsreportingV4::User] attr_accessor :user - # Required. The Analytics - # [view ID](https://support.google.com/analytics/answer/1009618) - # from which to retrieve data. Every - # [SearchUserActivityRequest](#SearchUserActivityRequest) must contain the - # `viewId`. + # Required. The Analytics [view ID](https://support.google.com/analytics/answer/ + # 1009618) from which to retrieve data. Every [SearchUserActivityRequest](# + # SearchUserActivityRequest) must contain the `viewId`. # Corresponds to the JSON property `viewId` # @return [String] attr_accessor :view_id @@ -1650,18 +1580,16 @@ module Google class SearchUserActivityResponse include Google::Apis::Core::Hashable - # This token should be passed to - # [SearchUserActivityRequest](#SearchUserActivityRequest) to retrieve the - # next page. + # This token should be passed to [SearchUserActivityRequest](# + # SearchUserActivityRequest) to retrieve the next page. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # This field represents the - # [sampling rate](https://support.google.com/analytics/answer/2637192) for - # the given request and is a number between 0.0 to 1.0. See - # [developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) - # for details. + # This field represents the [sampling rate](https://support.google.com/analytics/ + # answer/2637192) for the given request and is a number between 0.0 to 1.0. See [ + # developer guide](/analytics/devguides/reporting/core/v4/basics#sampling) for + # details. # Corresponds to the JSON property `sampleRate` # @return [Float] attr_accessor :sample_rate @@ -1689,14 +1617,14 @@ module Google end end - # The segment definition, if the report needs to be segmented. - # A Segment is a subset of the Analytics data. For example, of the entire - # set of users, one Segment might be users from a particular country or city. + # The segment definition, if the report needs to be segmented. A Segment is a + # subset of the Analytics data. For example, of the entire set of users, one + # Segment might be users from a particular country or city. class Segment include Google::Apis::Core::Hashable - # Dynamic segment definition for defining the segment within the request. - # A segment can select users, sessions or both. + # Dynamic segment definition for defining the segment within the request. A + # segment can select users, sessions or both. # Corresponds to the JSON property `dynamicSegment` # @return [Google::Apis::AnalyticsreportingV4::DynamicSegment] attr_accessor :dynamic_segment @@ -1717,13 +1645,13 @@ module Google end end - # SegmentDefinition defines the segment to be a set of SegmentFilters which - # are combined together with a logical `AND` operation. + # SegmentDefinition defines the segment to be a set of SegmentFilters which are + # combined together with a logical `AND` operation. class SegmentDefinition include Google::Apis::Core::Hashable - # A segment is defined by a set of segment filters which are combined - # together with a logical `AND` operation. + # A segment is defined by a set of segment filters which are combined together + # with a logical `AND` operation. # Corresponds to the JSON property `segmentFilters` # @return [Array] attr_accessor :segment_filters @@ -1788,31 +1716,19 @@ module Google end end - # SegmentFilter defines the segment to be either a simple or a sequence - # segment. A simple segment condition contains dimension and metric conditions - # to select the sessions or users. A sequence segment condition can be used to - # select users or sessions based on sequential conditions. + # SegmentFilter defines the segment to be either a simple or a sequence segment. + # A simple segment condition contains dimension and metric conditions to select + # the sessions or users. A sequence segment condition can be used to select + # users or sessions based on sequential conditions. class SegmentFilter include Google::Apis::Core::Hashable - # If true, match the complement of simple or sequence segment. - # For example, to match all visits not from "New York", we can define the - # segment as follows: - # "sessionSegment": ` - # "segmentFilters": [` - # "simpleSegment" :` - # "orFiltersForSegment": [` - # "segmentFilterClauses":[` - # "dimensionFilter": ` - # "dimensionName": "ga:city", - # "expressions": ["New York"] - # ` - # `] - # `] - # `, - # "not": "True" - # `] - # `, + # If true, match the complement of simple or sequence segment. For example, to + # match all visits not from "New York", we can define the segment as follows: " + # sessionSegment": ` "segmentFilters": [` "simpleSegment" :` " + # orFiltersForSegment": [` "segmentFilterClauses":[` "dimensionFilter": ` " + # dimensionName": "ga:city", "expressions": ["New York"] ` `] `] `, "not": "True" + # `] `, # Corresponds to the JSON property `not` # @return [Boolean] attr_accessor :not @@ -1825,8 +1741,8 @@ module Google # @return [Google::Apis::AnalyticsreportingV4::SequenceSegment] attr_accessor :sequence_segment - # A Simple segment conditions consist of one or more dimension/metric - # conditions that can be combined. + # A Simple segment conditions consist of one or more dimension/metric conditions + # that can be combined. # Corresponds to the JSON property `simpleSegment` # @return [Google::Apis::AnalyticsreportingV4::SimpleSegment] attr_accessor :simple_segment @@ -1843,8 +1759,8 @@ module Google end end - # Filter Clause to be used in a segment definition, can be wither a metric or - # a dimension filter. + # Filter Clause to be used in a segment definition, can be wither a metric or a + # dimension filter. class SegmentFilterClause include Google::Apis::Core::Hashable @@ -1891,22 +1807,22 @@ module Google # @return [String] attr_accessor :max_comparison_value - # The metric that will be filtered on. A `metricFilter` must contain a - # metric name. + # The metric that will be filtered on. A `metricFilter` must contain a metric + # name. # Corresponds to the JSON property `metricName` # @return [String] attr_accessor :metric_name - # Specifies is the operation to perform to compare the metric. The default - # is `EQUAL`. + # Specifies is the operation to perform to compare the metric. The default is ` + # EQUAL`. # Corresponds to the JSON property `operator` # @return [String] attr_accessor :operator - # Scope for a metric defines the level at which that metric is defined. The - # specified metric scope must be equal to or greater than its primary scope - # as defined in the data model. The primary scope is defined by if the - # segment is selecting users or sessions. + # Scope for a metric defines the level at which that metric is defined. The + # specified metric scope must be equal to or greater than its primary scope as + # defined in the data model. The primary scope is defined by if the segment is + # selecting users or sessions. # Corresponds to the JSON property `scope` # @return [String] attr_accessor :scope @@ -1929,14 +1845,14 @@ module Google class SegmentSequenceStep include Google::Apis::Core::Hashable - # Specifies if the step immediately precedes or can be any time before the - # next step. + # Specifies if the step immediately precedes or can be any time before the next + # step. # Corresponds to the JSON property `matchType` # @return [String] attr_accessor :match_type - # A sequence is specified with a list of Or grouped filters which are - # combined with `AND` operator. + # A sequence is specified with a list of Or grouped filters which are combined + # with `AND` operator. # Corresponds to the JSON property `orFiltersForSegment` # @return [Array] attr_accessor :or_filters_for_segment @@ -1958,8 +1874,8 @@ module Google class SequenceSegment include Google::Apis::Core::Hashable - # If set, first step condition must match the first hit of the visitor (in - # the date range). + # If set, first step condition must match the first hit of the visitor (in the + # date range). # Corresponds to the JSON property `firstStepShouldMatchFirstHit` # @return [Boolean] attr_accessor :first_step_should_match_first_hit @@ -1981,8 +1897,8 @@ module Google end end - # A Simple segment conditions consist of one or more dimension/metric - # conditions that can be combined. + # A Simple segment conditions consist of one or more dimension/metric conditions + # that can be combined. class SimpleSegment include Google::Apis::Core::Hashable @@ -2077,9 +1993,9 @@ module Google # @return [Array] attr_accessor :activities - # The data source of a hit. By default, hits sent from analytics.js are - # reported as "web" and hits sent from the mobile SDKs are reported as "app". - # These values can be overridden in the Measurement Protocol. + # The data source of a hit. By default, hits sent from analytics.js are reported + # as "web" and hits sent from the mobile SDKs are reported as "app". These + # values can be overridden in the Measurement Protocol. # Corresponds to the JSON property `dataSource` # @return [String] attr_accessor :data_source diff --git a/generated/google/apis/androidenterprise_v1.rb b/generated/google/apis/androidenterprise_v1.rb index 3fd8ba9fd..db03bb95c 100644 --- a/generated/google/apis/androidenterprise_v1.rb +++ b/generated/google/apis/androidenterprise_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/android/work/play/emm-api module AndroidenterpriseV1 VERSION = 'V1' - REVISION = '20200704' + REVISION = '20200801' # Manage corporate Android devices AUTH_ANDROIDENTERPRISE = 'https://www.googleapis.com/auth/androidenterprise' diff --git a/generated/google/apis/androidenterprise_v1/classes.rb b/generated/google/apis/androidenterprise_v1/classes.rb index 0f42bf5c6..27c2923f3 100644 --- a/generated/google/apis/androidenterprise_v1/classes.rb +++ b/generated/google/apis/androidenterprise_v1/classes.rb @@ -22,8 +22,8 @@ module Google module Apis module AndroidenterpriseV1 - # This represents an enterprise admin who can manage the enterprise - # in the managed Google Play store. + # This represents an enterprise admin who can manage the enterprise in the + # managed Google Play store. class Administrator include Google::Apis::Core::Hashable @@ -61,9 +61,9 @@ module Google end end - # Specification for a token used to generate iframes. The token specifies - # what data the admin is allowed to modify and the URI the iframe is - # allowed to communiate with. + # Specification for a token used to generate iframes. The token specifies what + # data the admin is allowed to modify and the URI the iframe is allowed to + # communiate with. class AdministratorWebTokenSpec include Google::Apis::Core::Hashable @@ -72,14 +72,14 @@ module Google # @return [Google::Apis::AndroidenterpriseV1::AdministratorWebTokenSpecManagedConfigurations] attr_accessor :managed_configurations - # The URI of the parent frame hosting the iframe. To prevent XSS, the iframe - # may not be hosted at other URIs. This URI must be https. - # Use whitespaces to separate multiple parent URIs. + # The URI of the parent frame hosting the iframe. To prevent XSS, the iframe may + # not be hosted at other URIs. This URI must be https. Use whitespaces to + # separate multiple parent URIs. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # Deprecated. Use PlaySearch.approveApps. + # Deprecated. Use PlaySearch.approveApps. # Corresponds to the JSON property `permission` # @return [Array] attr_accessor :permission @@ -144,10 +144,7 @@ module Google class AdministratorWebTokenSpecPlaySearch include Google::Apis::Core::Hashable - # Allow access to the iframe in approve - # mode. Default is false. + # Allow access to the iframe in approve mode. Default is false. # Corresponds to the JSON property `approveApps` # @return [Boolean] attr_accessor :approve_apps @@ -230,8 +227,8 @@ module Google end end - # Represents the list of app restrictions available to be pre-configured for - # the product. + # Represents the list of app restrictions available to be pre-configured for the + # product. class AppRestrictionsSchema include Google::Apis::Core::Hashable @@ -257,14 +254,13 @@ module Google end # An event generated when a new app version is uploaded to Google Play and its - # app restrictions schema changed. - # To fetch the app restrictions schema for an app, use - # Products.getAppRestrictionsSchema on the EMM API. + # app restrictions schema changed. To fetch the app restrictions schema for an + # app, use Products.getAppRestrictionsSchema on the EMM API. class AppRestrictionsSchemaChangeEvent include Google::Apis::Core::Hashable - # The id of the product (e.g. "app:com.google.android.gm") for which the - # app restriction schema changed. This field will always be present. + # The id of the product (e.g. "app:com.google.android.gm") for which the app + # restriction schema changed. This field will always be present. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id @@ -289,37 +285,34 @@ module Google # @return [Google::Apis::AndroidenterpriseV1::AppRestrictionsSchemaRestrictionRestrictionValue] attr_accessor :default_value - # A longer description of the restriction, giving more detail of what it - # affects. + # A longer description of the restriction, giving more detail of what it affects. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # For choice or multiselect restrictions, the list - # of possible entries' human-readable names. + # For choice or multiselect restrictions, the list of possible entries' human- + # readable names. # Corresponds to the JSON property `entry` # @return [Array] attr_accessor :entry - # For choice or multiselect restrictions, the list - # of possible entries' machine-readable values. These values should be used - # in the configuration, either as a single string value for a - # choice restriction or in a stringArray for a - # multiselect restriction. + # For choice or multiselect restrictions, the list of possible entries' machine- + # readable values. These values should be used in the configuration, either as a + # single string value for a choice restriction or in a stringArray for a + # multiselect restriction. # Corresponds to the JSON property `entryValue` # @return [Array] attr_accessor :entry_value - # The unique key that the product uses to identify the restriction, - # e.g. "com.google.android.gm.fieldname". + # The unique key that the product uses to identify the restriction, e.g. "com. + # google.android.gm.fieldname". # Corresponds to the JSON property `key` # @return [String] attr_accessor :key - # For bundle or bundleArray restrictions, the list - # of nested restrictions. A bundle restriction is always nested - # within a bundleArray restriction, and a - # bundleArray restriction is at most two levels deep. + # For bundle or bundleArray restrictions, the list of nested restrictions. A + # bundle restriction is always nested within a bundleArray restriction, and a + # bundleArray restriction is at most two levels deep. # Corresponds to the JSON property `nestedRestriction` # @return [Array] attr_accessor :nested_restriction @@ -371,14 +364,12 @@ module Google # @return [Fixnum] attr_accessor :value_integer - # The list of string values - this will only be present if type is - # multiselect. + # The list of string values - this will only be present if type is multiselect. # Corresponds to the JSON property `valueMultiselect` # @return [Array] attr_accessor :value_multiselect - # The string value - this will be present for types string, choice and - # hidden. + # The string value - this will be present for types string, choice and hidden. # Corresponds to the JSON property `valueString` # @return [String] attr_accessor :value_string @@ -401,14 +392,12 @@ module Google class AppState include Google::Apis::Core::Hashable - # List of keyed app states. - # This field will always be present. + # List of keyed app states. This field will always be present. # Corresponds to the JSON property `keyedAppState` # @return [Array] attr_accessor :keyed_app_state - # The package name of the app. - # This field will always be present. + # The package name of the app. This field will always be present. # Corresponds to the JSON property `packageName` # @return [String] attr_accessor :package_name @@ -457,14 +446,14 @@ module Google attr_accessor :is_production alias_method :is_production?, :is_production - # Deprecated, use trackId instead. + # Deprecated, use trackId instead. # Corresponds to the JSON property `track` # @return [String] attr_accessor :track - # Track ids that the app version is published in. Replaces the - # track field (deprecated), but doesn't include the production - # track (see isProduction instead). + # Track ids that the app version is published in. Replaces the track field ( + # deprecated), but doesn't include the production track (see isProduction + # instead). # Corresponds to the JSON property `trackId` # @return [Array] attr_accessor :track_id @@ -474,8 +463,7 @@ module Google # @return [Fixnum] attr_accessor :version_code - # The string used in the Play store by the app developer to identify - # the version. + # The string used in the Play store by the app developer to identify the version. # The string is not necessarily unique or localized (for example, the string # could be "1.4"). # Corresponds to the JSON property `versionString` @@ -501,7 +489,7 @@ module Google include Google::Apis::Core::Hashable # A URL that displays a product's permissions and that can also be used to - # approve the product with the Products.approve call. + # approve the product with the Products.approve call. # Corresponds to the JSON property `approvalUrl` # @return [String] attr_accessor :approval_url @@ -522,8 +510,8 @@ module Google include Google::Apis::Core::Hashable # The authentication token to be passed to the device policy client on the - # device where it can be used to provision the account for which this token - # was generated. + # device where it can be used to provision the account for which this token was + # generated. # Corresponds to the JSON property `token` # @return [String] attr_accessor :token @@ -574,8 +562,8 @@ module Google class AutoInstallPolicy include Google::Apis::Core::Hashable - # The constraints for auto-installing the app. You can specify a maximum of - # one constraint. + # The constraints for auto-installing the app. You can specify a maximum of one + # constraint. # Corresponds to the JSON property `autoInstallConstraint` # @return [Array] attr_accessor :auto_install_constraint @@ -592,9 +580,9 @@ module Google attr_accessor :auto_install_priority # The minimum version of the app. If a lower version of the app is installed, - # then the app will be auto-updated according to the auto-install - # constraints, instead of waiting for the regular auto-update. You can set a - # minimum version code for at most 20 apps per device. + # then the app will be auto-updated according to the auto-install constraints, + # instead of waiting for the regular auto-update. You can set a minimum version + # code for at most 20 apps per device. # Corresponds to the JSON property `minimumVersionCode` # @return [Fixnum] attr_accessor :minimum_version_code @@ -612,10 +600,10 @@ module Google end end - # A configuration variables resource contains the managed configuration - # settings ID to be applied to a single user, as well as the variable set that - # is attributed to the user. The variable set will be used to replace - # placeholders in the managed configuration settings. + # A configuration variables resource contains the managed configuration settings + # ID to be applied to a single user, as well as the variable set that is + # attributed to the user. The variable set will be used to replace placeholders + # in the managed configuration settings. class ConfigurationVariables include Google::Apis::Core::Hashable @@ -640,31 +628,26 @@ module Google end end - # A Devices resource represents a mobile device managed by the EMM and - # belonging to a specific enterprise user. + # A Devices resource represents a mobile device managed by the EMM and belonging + # to a specific enterprise user. class Device include Google::Apis::Core::Hashable - # The Google Play Services Android ID for the device encoded as - # a lowercase hex string. For example, - # "123456789abcdef0". + # The Google Play Services Android ID for the device encoded as a lowercase hex + # string. For example, "123456789abcdef0". # Corresponds to the JSON property `androidId` # @return [String] attr_accessor :android_id - # Identifies the extent to which the device is controlled by a managed - # Google Play EMM in various deployment configurations.

- # Possible values include: - #
  • "managedDevice", a device that has the EMM's device - # policy controller (DPC) as the device owner.
    • - #
  • "managedProfile", a device that has a profile managed - # by the DPC (DPC is profile owner) in addition to a separate, personal - # profile that is unavailable to the DPC.
    • - #
  • "containerApp", no longer used (deprecated).
    • - #
  • "unmanagedProfile", a device that has been allowed (by the - # domain's admin, using the Admin Console to enable the privilege) to use - # managed Google Play, but the profile is itself - # not owned by a DPC.
+ # Identifies the extent to which the device is controlled by a managed Google + # Play EMM in various deployment configurations. Possible values include: - " + # managedDevice", a device that has the EMM's device policy controller (DPC) as + # the device owner. - "managedProfile", a device that has a profile managed by + # the DPC (DPC is profile owner) in addition to a separate, personal profile + # that is unavailable to the DPC. - "containerApp", no longer used (deprecated). + # - "unmanagedProfile", a device that has been allowed (by the domain's admin, + # using the Admin Console to enable the privilege) to use managed Google Play, + # but the profile is itself not owned by a DPC. # Corresponds to the JSON property `managementType` # @return [String] attr_accessor :management_type @@ -698,15 +681,14 @@ module Google class DeviceReport include Google::Apis::Core::Hashable - # List of app states set by managed apps on the device. App states are - # defined by the app's developers. - # This field will always be present. + # List of app states set by managed apps on the device. App states are defined + # by the app's developers. This field will always be present. # Corresponds to the JSON property `appState` # @return [Array] attr_accessor :app_state - # The timestamp of the last report update in milliseconds since epoch. - # This field will always be present. + # The timestamp of the last report update in milliseconds since epoch. This + # field will always be present. # Corresponds to the JSON property `lastUpdatedTimestampMillis` # @return [Fixnum] attr_accessor :last_updated_timestamp_millis @@ -726,8 +708,7 @@ module Google class DeviceReportUpdateEvent include Google::Apis::Core::Hashable - # The Android ID of the device. - # This field will always be present. + # The Android ID of the device. This field will always be present. # Corresponds to the JSON property `deviceId` # @return [String] attr_accessor :device_id @@ -738,8 +719,7 @@ module Google # @return [Google::Apis::AndroidenterpriseV1::DeviceReport] attr_accessor :report - # The ID of the user. - # This field will always be present. + # The ID of the user. This field will always be present. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id @@ -756,15 +736,15 @@ module Google end end - # The state of a user's device, as accessed by the getState and setState - # methods on device resources. + # The state of a user's device, as accessed by the getState and setState methods + # on device resources. class DeviceState include Google::Apis::Core::Hashable - # The state of the Google account on the device. "enabled" indicates that - # the Google account on the device can be used to access Google services - # (including Google Play), while "disabled" means that it cannot. - # A new device is initially in the "disabled" state. + # The state of the Google account on the device. "enabled" indicates that the + # Google account on the device can be used to access Google services (including + # Google Play), while "disabled" means that it cannot. A new device is initially + # in the "disabled" state. # Corresponds to the JSON property `accountState` # @return [String] attr_accessor :account_state @@ -798,27 +778,22 @@ module Google end end - # An Enterprises resource represents the binding between an EMM and a - # specific organization. That binding can be instantiated in one of two - # different ways using this API as follows: - #
  • For Google managed domain customers, the process involves using - # Enterprises.enroll and Enterprises.setAccount (in - # conjunction with artifacts obtained from the Admin console and the Google - # API Console) and submitted to the EMM through a more-or-less manual - # process.
    • - #
  • For managed Google Play Accounts customers, the process involves using - # Enterprises.generateSignupUrl and - # Enterprises.completeSignup in conjunction with the managed - # Google Play sign-up UI (Google-provided mechanism) to create the binding - # without manual steps.
As an EMM, you can support either or both - # approaches in your EMM console. See Create an Enterprise - # for details. + # An Enterprises resource represents the binding between an EMM and a specific + # organization. That binding can be instantiated in one of two different ways + # using this API as follows: - For Google managed domain customers, the process + # involves using Enterprises.enroll and Enterprises.setAccount (in conjunction + # with artifacts obtained from the Admin console and the Google API Console) and + # submitted to the EMM through a more-or-less manual process. - For managed + # Google Play Accounts customers, the process involves using Enterprises. + # generateSignupUrl and Enterprises.completeSignup in conjunction with the + # managed Google Play sign-up UI (Google-provided mechanism) to create the + # binding without manual steps. As an EMM, you can support either or both + # approaches in your EMM console. See Create an Enterprise for details. class Enterprise include Google::Apis::Core::Hashable - # Admins of the enterprise. This is only supported for enterprises - # created via the EMM-initiated flow. + # Admins of the enterprise. This is only supported for enterprises created via + # the EMM-initiated flow. # Corresponds to the JSON property `administrator` # @return [Array] attr_accessor :administrator @@ -851,8 +826,8 @@ module Google end end - # A service account that can be used to authenticate as the enterprise to - # API calls that require such authentication. + # A service account that can be used to authenticate as the enterprise to API + # calls that require such authentication. class EnterpriseAccount include Google::Apis::Core::Hashable @@ -899,8 +874,8 @@ module Google # @return [String] attr_accessor :message_id - # The name of the Cloud Pub/Sub topic to which notifications for this - # enterprise's enrolled account will be sent. + # The name of the Cloud Pub/Sub topic to which notifications for this enterprise' + # s enrolled account will be sent. # Corresponds to the JSON property `topicName` # @return [String] attr_accessor :topic_name @@ -920,35 +895,32 @@ module Google # to use a particular app. Entitlements are user specific, not device specific. # This allows a user with an entitlement to an app to install the app on all # their devices. It's also possible for a user to hold an entitlement to an app - # without installing the app on any device. - # The API can be used to create an entitlement. As an option, you can also use - # the API to trigger the installation of an app on all a user's managed devices - # at the same time the entitlement is created. - # If the app is free, creating the entitlement also creates a group license - # for that app. For paid apps, creating the entitlement consumes one license, - # and that license remains consumed until the entitlement is removed. If the - # enterprise hasn't purchased enough licenses, then no entitlement is created - # and the installation fails. An entitlement is also not created for an app if - # the app requires permissions that the enterprise hasn't accepted. - # If an entitlement is deleted, the app may be uninstalled from a user's - # device. As a best practice, uninstall the app by calling - # - # Installs.delete() before deleting the entitlement. - # Entitlements for apps that a user pays for on an unmanaged profile have - # "userPurchase" as the entitlement reason. These + # without installing the app on any device. The API can be used to create an + # entitlement. As an option, you can also use the API to trigger the + # installation of an app on all a user's managed devices at the same time the + # entitlement is created. If the app is free, creating the entitlement also + # creates a group license for that app. For paid apps, creating the entitlement + # consumes one license, and that license remains consumed until the entitlement + # is removed. If the enterprise hasn't purchased enough licenses, then no + # entitlement is created and the installation fails. An entitlement is also not + # created for an app if the app requires permissions that the enterprise hasn't + # accepted. If an entitlement is deleted, the app may be uninstalled from a user' + # s device. As a best practice, uninstall the app by calling Installs.delete() + # before deleting the entitlement. Entitlements for apps that a user pays for on + # an unmanaged profile have "userPurchase" as the entitlement reason. These # entitlements cannot be removed via the API. class Entitlement include Google::Apis::Core::Hashable - # The ID of the product that the entitlement is for. For example, - # "app:com.google.android.gm". + # The ID of the product that the entitlement is for. For example, "app:com. + # google.android.gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id - # The reason for the entitlement. For example, "free" - # for free apps. This property is temporary: it will be replaced by the acquisition kind field of group licenses. + # The reason for the entitlement. For example, "free" for free apps. This + # property is temporary: it will be replaced by the acquisition kind field of + # group licenses. # Corresponds to the JSON property `reason` # @return [String] attr_accessor :reason @@ -968,9 +940,9 @@ module Google class ListEntitlementsResponse include Google::Apis::Core::Hashable - # An entitlement of a user to a product (e.g. an app). - # For example, a free app that they have installed, or a paid app that they - # have been allocated a license to. + # An entitlement of a user to a product (e.g. an app). For example, a free app + # that they have installed, or a paid app that they have been allocated a + # license to. # Corresponds to the JSON property `entitlement` # @return [Array] attr_accessor :entitlement @@ -985,74 +957,67 @@ module Google end end - # Group license objects allow you to keep track of licenses (called - # entitlements) + # Group license objects allow you to keep track of licenses (called entitlements) # for both free and paid apps. For a free app, a group license is created when # an enterprise admin first approves the product in Google Play or when the # first entitlement for the product is created for a user via the API. For a # paid app, a group license object is only created when an enterprise admin - # purchases the product in Google Play for the first time. - # Use the API to query group licenses. A Grouplicenses resource - # includes the total number of licenses purchased (paid apps only) and the - # total number of licenses currently in use. In other words, the total number - # of Entitlements that exist for the product. - # Only one group license object is created per product and group license - # objects are never deleted. If a product is unapproved, its group license - # remains. This allows enterprise admins to keep track of any remaining - # entitlements for the product. + # purchases the product in Google Play for the first time. Use the API to query + # group licenses. A Grouplicenses resource includes the total number of licenses + # purchased (paid apps only) and the total number of licenses currently in use. + # In other words, the total number of Entitlements that exist for the product. + # Only one group license object is created per product and group license objects + # are never deleted. If a product is unapproved, its group license remains. This + # allows enterprise admins to keep track of any remaining entitlements for the + # product. class GroupLicense include Google::Apis::Core::Hashable - # How this group license was acquired. "bulkPurchase" - # means that this Grouplicenses resource was created because the enterprise - # purchased licenses for this product; otherwise, the value is - # "free" (for free products). + # How this group license was acquired. "bulkPurchase" means that this + # Grouplicenses resource was created because the enterprise purchased licenses + # for this product; otherwise, the value is "free" (for free products). # Corresponds to the JSON property `acquisitionKind` # @return [String] attr_accessor :acquisition_kind - # Whether the product to which this group license relates is currently - # approved by the enterprise. Products are approved when a group license is - # first created, but this approval may be revoked by an enterprise admin via - # Google Play. Unapproved products will not be visible to end users in - # collections, and new entitlements to them should not normally be created. + # Whether the product to which this group license relates is currently approved + # by the enterprise. Products are approved when a group license is first created, + # but this approval may be revoked by an enterprise admin via Google Play. + # Unapproved products will not be visible to end users in collections, and new + # entitlements to them should not normally be created. # Corresponds to the JSON property `approval` # @return [String] attr_accessor :approval - # The total number of provisioned licenses for this product. - # Returned by read operations, but ignored in write operations. + # The total number of provisioned licenses for this product. Returned by read + # operations, but ignored in write operations. # Corresponds to the JSON property `numProvisioned` # @return [Fixnum] attr_accessor :num_provisioned - # The number of purchased licenses (possibly in multiple purchases). - # If this field is omitted, then there is no limit on the number of licenses - # that can be provisioned (for example, if the acquisition kind is - # "free"). + # The number of purchased licenses (possibly in multiple purchases). If this + # field is omitted, then there is no limit on the number of licenses that can be + # provisioned (for example, if the acquisition kind is "free"). # Corresponds to the JSON property `numPurchased` # @return [Fixnum] attr_accessor :num_purchased - # The permission approval status of the product. This field - # is only set if the product is approved. Possible states are:
    - #
  • "currentApproved", the current set + # The permission approval status of the product. This field is only set if the + # product is approved. Possible states are: - "currentApproved", the current set # of permissions is approved, but additional permissions will require the - # administrator to reapprove the product (If the product was approved - # without specifying the approved permissions setting, then this is the - # default behavior.),
    • - #
  • "needsReapproval", the product has unapproved permissions. - # No additional product licenses can be assigned until the product is - # reapproved,
    • - #
  • "allCurrentAndFutureApproved", - # the current permissions are approved and any future permission updates - # will be automatically approved without administrator review.
+ # administrator to reapprove the product (If the product was approved without + # specifying the approved permissions setting, then this is the default behavior. + # ), - "needsReapproval", the product has unapproved permissions. No additional + # product licenses can be assigned until the product is reapproved, - " + # allCurrentAndFutureApproved", the current permissions are approved and any + # future permission updates will be automatically approved without administrator + # review. # Corresponds to the JSON property `permissions` # @return [String] attr_accessor :permissions - # The ID of the product that the license is for. For example, - # "app:com.google.android.gm". + # The ID of the product that the license is for. For example, "app:com.google. + # android.gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id @@ -1110,49 +1075,41 @@ module Google end end - # The existence of an Installs resource indicates that an app is - # installed on a particular device (or that an install is pending). - # The API can be used to create an install resource using the - # update - # method. This triggers the actual install of the app on the device. If the - # user does not already have an entitlement for the app, then an attempt is - # made to create one. If this fails (for example, because the app is not free - # and there is no available license), then the creation of the install fails. - # The API can also be used to update an installed app. If - # the update method is - # used on an existing install, then the app will be updated to the latest - # available version. - # Note that it is not possible to force the installation of a specific version - # of an app: the version code is read-only. - # If a user installs an app themselves (as permitted by the enterprise), then - # again an install resource and possibly an entitlement resource are - # automatically created. - # The API can also be used to delete an install resource, which triggers the - # removal of the app from the device. Note that deleting an install does not - # automatically remove the corresponding entitlement, even if there are no - # remaining installs. The install resource will also be deleted if the user - # uninstalls the app themselves. + # The existence of an Installs resource indicates that an app is installed on a + # particular device (or that an install is pending). The API can be used to + # create an install resource using the update method. This triggers the actual + # install of the app on the device. If the user does not already have an + # entitlement for the app, then an attempt is made to create one. If this fails ( + # for example, because the app is not free and there is no available license), + # then the creation of the install fails. The API can also be used to update an + # installed app. If the update method is used on an existing install, then the + # app will be updated to the latest available version. Note that it is not + # possible to force the installation of a specific version of an app: the + # version code is read-only. If a user installs an app themselves (as permitted + # by the enterprise), then again an install resource and possibly an entitlement + # resource are automatically created. The API can also be used to delete an + # install resource, which triggers the removal of the app from the device. Note + # that deleting an install does not automatically remove the corresponding + # entitlement, even if there are no remaining installs. The install resource + # will also be deleted if the user uninstalls the app themselves. class Install include Google::Apis::Core::Hashable - # Install state. The state "installPending" - # means that an install request has recently been made and download to the - # device is in progress. The state "installed" - # means that the app has been installed. This field is read-only. + # Install state. The state "installPending" means that an install request has + # recently been made and download to the device is in progress. The state " + # installed" means that the app has been installed. This field is read-only. # Corresponds to the JSON property `installState` # @return [String] attr_accessor :install_state - # The ID of the product that the install is for. For example, - # "app:com.google.android.gm". + # The ID of the product that the install is for. For example, "app:com.google. + # android.gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id - # The version of the installed product. Guaranteed to be set only if the - # install state is "installed". + # The version of the installed product. Guaranteed to be set only if the install + # state is "installed". # Corresponds to the JSON property `versionCode` # @return [Fixnum] attr_accessor :version_code @@ -1173,8 +1130,7 @@ module Google class InstallFailureEvent include Google::Apis::Core::Hashable - # The Android ID of the device. - # This field will always be present. + # The Android ID of the device. This field will always be present. # Corresponds to the JSON property `deviceId` # @return [String] attr_accessor :device_id @@ -1184,20 +1140,18 @@ module Google # @return [String] attr_accessor :failure_details - # The reason for the installation failure. - # This field will always be present. + # The reason for the installation failure. This field will always be present. # Corresponds to the JSON property `failureReason` # @return [String] attr_accessor :failure_reason - # The id of the product (e.g. "app:com.google.android.gm") for which the - # install failure event occured. This field will always be present. + # The id of the product (e.g. "app:com.google.android.gm") for which the install + # failure event occured. This field will always be present. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id - # The ID of the user. - # This field will always be present. + # The ID of the user. This field will always be present. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id @@ -1220,9 +1174,8 @@ module Google class ListInstallsResponse include Google::Apis::Core::Hashable - # An installation of an app for a user on a specific device. - # The existence of an install implies that the user must have an - # entitlement to the app. + # An installation of an app for a user on a specific device. The existence of an + # install implies that the user must have an entitlement to the app. # Corresponds to the JSON property `install` # @return [Array] attr_accessor :install @@ -1242,36 +1195,34 @@ module Google class KeyedAppState include Google::Apis::Core::Hashable - # Additional field intended for machine-readable data. For example, a number - # or JSON object. To prevent XSS, we recommend removing any HTML from the - # data before displaying it. + # Additional field intended for machine-readable data. For example, a number or + # JSON object. To prevent XSS, we recommend removing any HTML from the data + # before displaying it. # Corresponds to the JSON property `data` # @return [String] attr_accessor :data - # Key indicating what the app is providing a state for. The content of the - # key is set by the app's developer. To prevent XSS, we recommend removing - # any HTML from the key before displaying it. - # This field will always be present. + # Key indicating what the app is providing a state for. The content of the key + # is set by the app's developer. To prevent XSS, we recommend removing any HTML + # from the key before displaying it. This field will always be present. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key - # Free-form, human-readable message describing the app state. For example, - # an error message. To prevent XSS, we recommend removing any HTML from the - # message before displaying it. + # Free-form, human-readable message describing the app state. For example, an + # error message. To prevent XSS, we recommend removing any HTML from the message + # before displaying it. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message - # Severity of the app state. - # This field will always be present. + # Severity of the app state. This field will always be present. # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity - # Timestamp of when the app set the state in milliseconds since epoch. - # This field will always be present. + # Timestamp of when the app set the state in milliseconds since epoch. This + # field will always be present. # Corresponds to the JSON property `stateTimestampMillis` # @return [Fixnum] attr_accessor :state_timestamp_millis @@ -1315,9 +1266,8 @@ module Google end end - # Maintenance window for managed Google Play Accounts. - # This allows Play store to update the apps on the foreground in the designated - # window. + # Maintenance window for managed Google Play Accounts. This allows Play store to + # update the apps on the foreground in the designated window. class MaintenanceWindow include Google::Apis::Core::Hashable @@ -1345,15 +1295,15 @@ module Google end # A managed configuration resource contains the set of managed properties - # defined by the app developer in the app's managed configurations schema, - # as well as any configuration variables defined for the user. + # defined by the app developer in the app's managed configurations schema, as + # well as any configuration variables defined for the user. class ManagedConfiguration include Google::Apis::Core::Hashable - # A configuration variables resource contains the managed configuration - # settings ID to be applied to a single user, as well as the variable set that - # is attributed to the user. The variable set will be used to replace - # placeholders in the managed configuration settings. + # A configuration variables resource contains the managed configuration settings + # ID to be applied to a single user, as well as the variable set that is + # attributed to the user. The variable set will be used to replace placeholders + # in the managed configuration settings. # Corresponds to the JSON property `configurationVariables` # @return [Google::Apis::AndroidenterpriseV1::ConfigurationVariables] attr_accessor :configuration_variables @@ -1368,8 +1318,8 @@ module Google # @return [Array] attr_accessor :managed_property - # The ID of the product that the managed configuration is for, e.g. - # "app:com.google.android.gm". + # The ID of the product that the managed configuration is for, e.g. "app:com. + # google.android.gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id @@ -1425,15 +1375,15 @@ module Google end end - # A managed configurations settings resource contains the set of - # managed properties that have been configured for an Android app to be applied - # to a set of users. The app's developer would have - # defined configurable properties in the managed configurations schema. + # A managed configurations settings resource contains the set of managed + # properties that have been configured for an Android app to be applied to a set + # of users. The app's developer would have defined configurable properties in + # the managed configurations schema. class ManagedConfigurationsSettings include Google::Apis::Core::Hashable - # The last updated time of the managed configuration settings in - # milliseconds since 1970-01-01T00:00:00Z. + # The last updated time of the managed configuration settings in milliseconds + # since 1970-01-01T00:00:00Z. # Corresponds to the JSON property `lastUpdatedTimestampMillis` # @return [Fixnum] attr_accessor :last_updated_timestamp_millis @@ -1464,8 +1414,8 @@ module Google class ManagedConfigurationsSettingsListResponse include Google::Apis::Core::Hashable - # A managed configurations settings for an app that may be assigned to a - # group of users in an enterprise. + # A managed configurations settings for an app that may be assigned to a group + # of users in an enterprise. # Corresponds to the JSON property `managedConfigurationsSettings` # @return [Array] attr_accessor :managed_configurations_settings @@ -1492,8 +1442,7 @@ module Google # @return [String] attr_accessor :key - # The boolean value - this will only be present if type of the property is - # bool. + # The boolean value - this will only be present if type of the property is bool. # Corresponds to the JSON property `valueBool` # @return [Boolean] attr_accessor :value_bool @@ -1504,8 +1453,8 @@ module Google # @return [Google::Apis::AndroidenterpriseV1::ManagedPropertyBundle] attr_accessor :value_bundle - # The list of bundles of properties - this will only be present if type of - # the property is bundle_array. + # The list of bundles of properties - this will only be present if type of the + # property is bundle_array. # Corresponds to the JSON property `valueBundleArray` # @return [Array] attr_accessor :value_bundle_array @@ -1516,14 +1465,14 @@ module Google # @return [Fixnum] attr_accessor :value_integer - # The string value - this will only be present if type of the property is - # string, choice or hidden. + # The string value - this will only be present if type of the property is string, + # choice or hidden. # Corresponds to the JSON property `valueString` # @return [String] attr_accessor :value_string - # The list of string values - this will only be present if type of the - # property is multiselect. + # The list of string values - this will only be present if type of the property + # is multiselect. # Corresponds to the JSON property `valueStringArray` # @return [Array] attr_accessor :value_string_array @@ -1567,8 +1516,7 @@ module Google class NewDeviceEvent include Google::Apis::Core::Hashable - # The Android ID of the device. - # This field will always be present. + # The Android ID of the device. This field will always be present. # Corresponds to the JSON property `deviceId` # @return [String] attr_accessor :device_id @@ -1578,19 +1526,15 @@ module Google # @return [String] attr_accessor :dpc_package_name - # Identifies the extent to which the device is controlled by an Android - # EMM in various deployment configurations.

- # Possible values include: - #
  • "managedDevice", a device where the DPC is set as - # device owner,
    • - #
  • "managedProfile", a device where the DPC is set as profile - # owner.
+ # Identifies the extent to which the device is controlled by an Android EMM in + # various deployment configurations. Possible values include: - "managedDevice", + # a device where the DPC is set as device owner, - "managedProfile", a device + # where the DPC is set as profile owner. # Corresponds to the JSON property `managementType` # @return [String] attr_accessor :management_type - # The ID of the user. - # This field will always be present. + # The ID of the user. This field will always be present. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id @@ -1612,10 +1556,9 @@ module Google class NewPermissionsEvent include Google::Apis::Core::Hashable - # The set of permissions that the enterprise admin has already approved for - # this application. - # Use Permissions.Get on the EMM API to retrieve details about these - # permissions. + # The set of permissions that the enterprise admin has already approved for this + # application. Use Permissions.Get on the EMM API to retrieve details about + # these permissions. # Corresponds to the JSON property `approvedPermissions` # @return [Array] attr_accessor :approved_permissions @@ -1626,9 +1569,8 @@ module Google # @return [String] attr_accessor :product_id - # The set of permissions that the app is currently requesting. - # Use Permissions.Get on the EMM API to retrieve details about these - # permissions. + # The set of permissions that the app is currently requesting. Use Permissions. + # Get on the EMM API to retrieve details about these permissions. # Corresponds to the JSON property `requestedPermissions` # @return [Array] attr_accessor :requested_permissions @@ -1650,9 +1592,8 @@ module Google include Google::Apis::Core::Hashable # An event generated when a new app version is uploaded to Google Play and its - # app restrictions schema changed. - # To fetch the app restrictions schema for an app, use - # Products.getAppRestrictionsSchema on the EMM API. + # app restrictions schema changed. To fetch the app restrictions schema for an + # app, use Products.getAppRestrictionsSchema on the EMM API. # Corresponds to the JSON property `appRestrictionsSchemaChangeEvent` # @return [Google::Apis::AndroidenterpriseV1::AppRestrictionsSchemaChangeEvent] attr_accessor :app_restrictions_schema_change_event @@ -1670,8 +1611,8 @@ module Google # @return [Google::Apis::AndroidenterpriseV1::DeviceReportUpdateEvent] attr_accessor :device_report_update_event - # The ID of the enterprise for which the notification is sent. - # This will always be present. + # The ID of the enterprise for which the notification is sent. This will always + # be present. # Corresponds to the JSON property `enterpriseId` # @return [String] attr_accessor :enterprise_id @@ -1706,9 +1647,8 @@ module Google # @return [Google::Apis::AndroidenterpriseV1::ProductAvailabilityChangeEvent] attr_accessor :product_availability_change_event - # The time when the notification was published in - # milliseconds since 1970-01-01T00:00:00Z. - # This will always be present. + # The time when the notification was published in milliseconds since 1970-01- + # 01T00:00:00Z. This will always be present. # Corresponds to the JSON property `timestampMillis` # @return [Fixnum] attr_accessor :timestamp_millis @@ -1733,8 +1673,8 @@ module Google end end - # A resource returned by the PullNotificationSet API, which contains - # a collection of notifications for enterprises associated with the service + # A resource returned by the PullNotificationSet API, which contains a + # collection of notifications for enterprises associated with the service # account authenticated for the request. class NotificationSet include Google::Apis::Core::Hashable @@ -1744,9 +1684,9 @@ module Google # @return [Array] attr_accessor :notification - # The notification set ID, required to mark the notification as - # received with the Enterprises.AcknowledgeNotification API. - # This will be omitted if no notifications are present. + # The notification set ID, required to mark the notification as received with + # the Enterprises.AcknowledgeNotification API. This will be omitted if no + # notifications are present. # Corresponds to the JSON property `notificationSetId` # @return [String] attr_accessor :notification_set_id @@ -1762,14 +1702,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 @@ -1779,8 +1719,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 @@ -1798,18 +1738,16 @@ module Google end # A Permissions resource represents some extra capability, to be granted to an - # Android app, which requires explicit consent. An enterprise admin must - # consent to these permissions on behalf of their users before an - # entitlement for the app can be created. - # The permissions collection is read-only. The information provided for - # each permission (localized name and description) is intended to be - # used in the MDM user interface when obtaining consent from the - # enterprise. + # Android app, which requires explicit consent. An enterprise admin must consent + # to these permissions on behalf of their users before an entitlement for the + # app can be created. The permissions collection is read-only. The information + # provided for each permission (localized name and description) is intended to + # be used in the MDM user interface when obtaining consent from the enterprise. class Permission include Google::Apis::Core::Hashable - # A longer description of the Permissions resource, giving more details of - # what it affects. + # A longer description of the Permissions resource, giving more details of what + # it affects. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -1841,41 +1779,38 @@ module Google include Google::Apis::Core::Hashable # The auto-update policy for apps installed on the device. "choiceToTheUser" - # allows the device's user to configure the app update policy. "always" - # enables auto updates. "never" disables auto updates. "wifiOnly" enables - # auto updates only when the device is connected to wifi. + # allows the device's user to configure the app update policy. "always" enables + # auto updates. "never" disables auto updates. "wifiOnly" enables auto updates + # only when the device is connected to wifi. # Corresponds to the JSON property `autoUpdatePolicy` # @return [String] attr_accessor :auto_update_policy - # Whether the device reports app states to the EMM. The default value is - # "deviceReportDisabled". + # Whether the device reports app states to the EMM. The default value is " + # deviceReportDisabled". # Corresponds to the JSON property `deviceReportPolicy` # @return [String] attr_accessor :device_report_policy - # Maintenance window for managed Google Play Accounts. - # This allows Play store to update the apps on the foreground in the designated - # window. + # Maintenance window for managed Google Play Accounts. This allows Play store to + # update the apps on the foreground in the designated window. # Corresponds to the JSON property `maintenanceWindow` # @return [Google::Apis::AndroidenterpriseV1::MaintenanceWindow] attr_accessor :maintenance_window - # The availability granted to the device for the specified products. "all" - # gives the device access to all products, regardless of approval status. - # "all" does not enable automatic visibility of "alpha" or "beta" tracks. - # "whitelist" grants the device access the products specified in - # productPolicy[]. Only products that are approved or products that were - # previously approved (products with revoked approval) by the enterprise can - # be whitelisted. If no value is provided, the availability set at the user - # level is applied by default. + # The availability granted to the device for the specified products. "all" gives + # the device access to all products, regardless of approval status. "all" does + # not enable automatic visibility of "alpha" or "beta" tracks. "whitelist" + # grants the device access the products specified in productPolicy[]. Only + # products that are approved or products that were previously approved (products + # with revoked approval) by the enterprise can be whitelisted. If no value is + # provided, the availability set at the user level is applied by default. # Corresponds to the JSON property `productAvailabilityPolicy` # @return [String] attr_accessor :product_availability_policy - # The list of product policies. The productAvailabilityPolicy - # needs to be set to WHITELIST or ALL for the - # product policies to be applied. + # The list of product policies. The productAvailabilityPolicy needs to be set to + # WHITELIST or ALL for the product policies to be applied. # Corresponds to the JSON property `productPolicy` # @return [Array] attr_accessor :product_policy @@ -1897,10 +1832,9 @@ module Google # A Products resource represents an app in the Google Play store that is # available to at least some users in the enterprise. (Some apps are restricted # to a single enterprise, and no information about them is made available - # outside that enterprise.) - # The information provided for each product (localized name, icon, link - # to the full Google Play details page) is intended to allow a basic - # representation of the product within an EMM user interface. + # outside that enterprise.) The information provided for each product (localized + # name, icon, link to the full Google Play details page) is intended to allow a + # basic representation of the product within an EMM user interface. class Product include Google::Apis::Core::Hashable @@ -1924,7 +1858,7 @@ module Google # @return [Array] attr_accessor :available_countries - # Deprecated, use appTracks instead. + # Deprecated, use appTracks instead. # Corresponds to the JSON property `availableTracks` # @return [Array] attr_accessor :available_tracks @@ -1949,13 +1883,12 @@ module Google # @return [String] attr_accessor :details_url - # How and to whom the package is made available. - # The value publicGoogleHosted means that the package is - # available through the Play store and not restricted to a specific - # enterprise. The value privateGoogleHosted means that the - # package is a private app (restricted to an enterprise) but hosted by - # Google. The value privateSelfHosted means that the package is - # a private app (restricted to an enterprise) and is privately hosted. + # How and to whom the package is made available. The value publicGoogleHosted + # means that the package is available through the Play store and not restricted + # to a specific enterprise. The value privateGoogleHosted means that the package + # is a private app (restricted to an enterprise) but hosted by Google. The value + # privateSelfHosted means that the package is a private app (restricted to an + # enterprise) and is privately hosted. # Corresponds to the JSON property `distributionChannel` # @return [String] attr_accessor :distribution_channel @@ -1965,14 +1898,14 @@ module Google # @return [Array] attr_accessor :features - # A link to an image that can be used as an icon for the product. - # This image is suitable for use at up to 512px x 512px. + # A link to an image that can be used as an icon for the product. This image is + # suitable for use at up to 512px x 512px. # Corresponds to the JSON property `iconUrl` # @return [String] attr_accessor :icon_url - # The approximate time (within 7 days) the app was last published, expressed - # in milliseconds since epoch. + # The approximate time (within 7 days) the app was last published, expressed in + # milliseconds since epoch. # Corresponds to the JSON property `lastUpdatedTimestampMillis` # @return [Fixnum] attr_accessor :last_updated_timestamp_millis @@ -1987,16 +1920,15 @@ module Google # @return [Array] attr_accessor :permissions - # A string of the form app:<package name>. For - # example, app:com.google.android.gm represents the Gmail app. + # A string of the form *app:*. For example, app:com.google.android. + # gm represents the Gmail app. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id - # Whether this product is free, free with in-app purchases, or paid. - # If the pricing is unknown, this means the product is not generally - # available anymore (even though it might still be available to - # people who own it). + # Whether this product is free, free with in-app purchases, or paid. If the + # pricing is unknown, this means the product is not generally available anymore ( + # even though it might still be available to people who own it). # Corresponds to the JSON property `productPricing` # @return [String] attr_accessor :product_pricing @@ -2022,8 +1954,8 @@ module Google # @return [Google::Apis::AndroidenterpriseV1::ProductSigningCertificate] attr_accessor :signing_certificate - # A link to a smaller image that can be used as an icon for the product. - # This image is suitable for use at up to 128px x 128px. + # A link to a smaller image that can be used as an icon for the product. This + # image is suitable for use at up to 128px x 128px. # Corresponds to the JSON property `smallIconUrl` # @return [String] attr_accessor :small_icon_url @@ -2033,8 +1965,8 @@ module Google # @return [String] attr_accessor :title - # A link to the managed Google Play details page for the product, - # for use by an Enterprise admin. + # A link to the managed Google Play details page for the product, for use by an + # Enterprise admin. # Corresponds to the JSON property `workDetailsUrl` # @return [String] attr_accessor :work_details_url @@ -2076,8 +2008,8 @@ module Google class ProductApprovalEvent include Google::Apis::Core::Hashable - # Whether the product was approved or unapproved. - # This field will always be present. + # Whether the product was approved or unapproved. This field will always be + # present. # Corresponds to the JSON property `approved` # @return [String] attr_accessor :approved @@ -2103,14 +2035,13 @@ module Google class ProductAvailabilityChangeEvent include Google::Apis::Core::Hashable - # The new state of the product. - # This field will always be present. + # The new state of the product. This field will always be present. # Corresponds to the JSON property `availabilityStatus` # @return [String] attr_accessor :availability_status - # The id of the product (e.g. "app:com.google.android.gm") for which the - # product availability changed. This field will always be present. + # The id of the product (e.g. "app:com.google.android.gm") for which the product + # availability changed. This field will always be present. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id @@ -2126,11 +2057,10 @@ module Google end end - # A product permissions resource represents the set of permissions - # required by a specific app and whether or not they have been accepted - # by an enterprise admin. - # The API can be used to read the set of permissions, and also to update - # the set to indicate that permissions have been accepted. + # A product permissions resource represents the set of permissions required by a + # specific app and whether or not they have been accepted by an enterprise admin. + # The API can be used to read the set of permissions, and also to update the + # set to indicate that permissions have been accepted. class ProductPermission include Google::Apis::Core::Hashable @@ -2155,8 +2085,8 @@ module Google end end - # Information about the permissions required by a specific app and - # whether they have been accepted by the enterprise. + # Information about the permissions required by a specific app and whether they + # have been accepted by the enterprise. class ProductPermissions include Google::Apis::Core::Hashable @@ -2165,8 +2095,8 @@ module Google # @return [Array] attr_accessor :permission - # The ID of the app that the permissions relate to, e.g. - # "app:com.google.android.gm". + # The ID of the app that the permissions relate to, e.g. "app:com.google.android. + # gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id @@ -2192,26 +2122,25 @@ module Google attr_accessor :auto_install_policy # A managed configuration resource contains the set of managed properties - # defined by the app developer in the app's managed configurations schema, - # as well as any configuration variables defined for the user. + # defined by the app developer in the app's managed configurations schema, as + # well as any configuration variables defined for the user. # Corresponds to the JSON property `managedConfiguration` # @return [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] attr_accessor :managed_configuration - # The ID of the product. For example, - # "app:com.google.android.gm". + # The ID of the product. For example, "app:com.google.android.gm". # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # Grants the device visibility to the specified product release track(s), - # identified by trackIds. The list of release tracks of a - # product can be obtained by calling Products.Get. + # identified by trackIds. The list of release tracks of a product can be + # obtained by calling Products.Get. # Corresponds to the JSON property `trackIds` # @return [Array] attr_accessor :track_ids - # Deprecated. Use trackIds instead. + # Deprecated. Use trackIds instead. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -2239,28 +2168,26 @@ module Google # @return [Array] attr_accessor :product_id - # The interpretation of this product set. "unknown" should never be sent and - # is ignored if received. "whitelist" means that the user is entitled to - # access the product set. "includeAll" means that all products are - # accessible, including products that are approved, products with revoked - # approval, and products that have never been approved. "allApproved" means - # that the user is entitled to access all products that are approved for the - # enterprise. If the value is "allApproved" or "includeAll", the productId - # field is ignored. If no value is provided, it is interpreted as - # "whitelist" for backwards compatibility. - # Further "allApproved" or "includeAll" does not enable automatic - # visibility of "alpha" or "beta" tracks for Android app. Use - # ProductVisibility to enable "alpha" or "beta" tracks per user. + # The interpretation of this product set. "unknown" should never be sent and is + # ignored if received. "whitelist" means that the user is entitled to access the + # product set. "includeAll" means that all products are accessible, including + # products that are approved, products with revoked approval, and products that + # have never been approved. "allApproved" means that the user is entitled to + # access all products that are approved for the enterprise. If the value is " + # allApproved" or "includeAll", the productId field is ignored. If no value is + # provided, it is interpreted as "whitelist" for backwards compatibility. + # Further "allApproved" or "includeAll" does not enable automatic visibility of " + # alpha" or "beta" tracks for Android app. Use ProductVisibility to enable " + # alpha" or "beta" tracks per user. # Corresponds to the JSON property `productSetBehavior` # @return [String] attr_accessor :product_set_behavior - # Additional list of product IDs making up the product set. - # Unlike the productID array, in this list It's possible to specify - # which tracks (alpha, beta, production) of a product are visible to the - # user. See ProductVisibility and its fields for more information. Specifying - # the same product ID both here and in the productId array is not allowed and - # it will result in an error. + # Additional list of product IDs making up the product set. Unlike the productID + # array, in this list It's possible to specify which tracks (alpha, beta, + # production) of a product are visible to the user. See ProductVisibility and + # its fields for more information. Specifying the same product ID both here and + # in the productId array is not allowed and it will result in an error. # Corresponds to the JSON property `productVisibility` # @return [Array] attr_accessor :product_visibility @@ -2282,8 +2209,8 @@ module Google include Google::Apis::Core::Hashable # The base64 urlsafe encoded SHA1 hash of the certificate. (This field is - # deprecated in favor of SHA2-256. It should not be used and may be - # removed at any time.) + # deprecated in favor of SHA2-256. It should not be used and may be removed at + # any time.) # Corresponds to the JSON property `certificateHashSha1` # @return [String] attr_accessor :certificate_hash_sha1 @@ -2308,19 +2235,19 @@ module Google class ProductVisibility include Google::Apis::Core::Hashable - # The product ID to make visible to the user. - # Required for each item in the productVisibility list. + # The product ID to make visible to the user. Required for each item in the + # productVisibility list. # Corresponds to the JSON property `productId` # @return [String] attr_accessor :product_id # Grants the user visibility to the specified product track(s), identified by - # trackIds. + # trackIds. # Corresponds to the JSON property `trackIds` # @return [Array] attr_accessor :track_ids - # Deprecated. Use trackIds instead. + # Deprecated. Use trackIds instead. # Corresponds to the JSON property `tracks` # @return [Array] attr_accessor :tracks @@ -2346,12 +2273,12 @@ module Google # @return [Google::Apis::AndroidenterpriseV1::ApprovalUrlInfo] attr_accessor :approval_url_info - # Sets how new permission requests for the product are handled. - # "allPermissions" automatically approves all current and future - # permissions for the product. "currentPermissionsOnly" approves the - # current set of permissions for the product, but any future permissions - # added through updates will require manual reapproval. If not specified, - # only the current set of permissions will be approved. + # Sets how new permission requests for the product are handled. "allPermissions" + # automatically approves all current and future permissions for the product. " + # currentPermissionsOnly" approves the current set of permissions for the + # product, but any future permissions added through updates will require manual + # reapproval. If not specified, only the current set of permissions will be + # approved. # Corresponds to the JSON property `approvedPermissions` # @return [String] attr_accessor :approved_permissions @@ -2371,15 +2298,13 @@ module Google class GenerateProductApprovalUrlResponse include Google::Apis::Core::Hashable - # A URL that can be rendered in an iframe to display the permissions (if - # any) of a product. - # This URL can be used to approve the product only once and only within 24 - # hours of being generated, using the Products.approve call. - # If the product is currently unapproved and has no permissions, this - # URL will point to an empty page. - # If the product is currently approved, a URL will only be generated if - # that product has added permissions since it was last approved, and the - # URL will only display those new permissions that have not yet been + # A URL that can be rendered in an iframe to display the permissions (if any) of + # a product. This URL can be used to approve the product only once and only + # within 24 hours of being generated, using the Products.approve call. If the + # product is currently unapproved and has no permissions, this URL will point to + # an empty page. If the product is currently approved, a URL will only be + # generated if that product has added permissions since it was last approved, + # and the URL will only display those new permissions that have not yet been # accepted. # Corresponds to the JSON property `url` # @return [String] @@ -2399,9 +2324,9 @@ module Google class ProductsListResponse 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::AndroidenterpriseV1::PageInfo] attr_accessor :page_info @@ -2412,15 +2337,14 @@ module Google # @return [Array] attr_accessor :product - # 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::AndroidenterpriseV1::TokenPagination] attr_accessor :token_pagination @@ -2468,23 +2392,21 @@ module Google class ServiceAccountKey include Google::Apis::Core::Hashable - # The body of the private key credentials file, in string format. This - # is only populated when the ServiceAccountKey is created, and is not stored - # by Google. + # The body of the private key credentials file, in string format. This is only + # populated when the ServiceAccountKey is created, and is not stored by Google. # Corresponds to the JSON property `data` # @return [String] attr_accessor :data - # An opaque, unique identifier for this ServiceAccountKey. - # Assigned by the server. + # An opaque, unique identifier for this ServiceAccountKey. Assigned by the + # server. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id # Public key data for the credentials file. This is an X.509 cert. If you are - # using the googleCredentials key type, this is identical to the - # cert that can be retrieved by using the X.509 cert url inside of the - # credentials file. + # using the googleCredentials key type, this is identical to the cert that can + # be retrieved by using the X.509 cert url inside of the credentials file. # Corresponds to the JSON property `publicData` # @return [String] attr_accessor :public_data @@ -2526,13 +2448,13 @@ module Google end end - # A resource returned by the GenerateSignupUrl API, which contains the - # Signup URL and Completion Token. + # A resource returned by the GenerateSignupUrl API, which contains the Signup + # URL and Completion Token. class SignupInfo include Google::Apis::Core::Hashable - # An opaque token that will be required, along with the Enterprise Token, - # for obtaining the enterprise resource from CompleteSignup. + # An opaque token that will be required, along with the Enterprise Token, for + # obtaining the enterprise resource from CompleteSignup. # Corresponds to the JSON property `completionToken` # @return [String] attr_accessor :completion_token @@ -2542,8 +2464,8 @@ module Google # @return [String] attr_accessor :kind - # A URL under which the Admin can sign up for an enterprise. - # The page pointed to cannot be rendered in an iframe. + # A URL under which the Admin can sign up for an enterprise. The page pointed to + # cannot be rendered in an iframe. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -2570,28 +2492,25 @@ module Google # @return [String] attr_accessor :id - # Ordered list of localized strings giving the name of this page. - # The text displayed is the one that best matches the user locale, - # or the first entry if there is no good match. There needs to be - # at least one entry. + # Ordered list of localized strings giving the name of this page. The text + # displayed is the one that best matches the user locale, or the first entry if + # there is no good match. There needs to be at least one entry. # Corresponds to the JSON property `name` # @return [Array] attr_accessor :name # String (US-ASCII only) used to determine order of this cluster within the - # parent page's elements. Page elements are sorted in lexicographic order - # of this field. - # Duplicated values are allowed, but ordering between elements with - # duplicate order is undefined. - # The value of this field is never visible to a user, it is used solely - # for the purpose of defining an ordering. Maximum length is 256 - # characters. + # parent page's elements. Page elements are sorted in lexicographic order of + # this field. Duplicated values are allowed, but ordering between elements with + # duplicate order is undefined. The value of this field is never visible to a + # user, it is used solely for the purpose of defining an ordering. Maximum + # length is 256 characters. # Corresponds to the JSON property `orderInPage` # @return [String] attr_accessor :order_in_page - # List of products in the order they are displayed in the cluster. There - # should not be duplicates within a cluster. + # List of products in the order they are displayed in the cluster. There should + # not be duplicates within a cluster. # Corresponds to the JSON property `productId` # @return [Array] attr_accessor :product_id @@ -2609,24 +2528,22 @@ module Google end end - # General setting for the managed Google Play store layout, - # currently only specifying the page to display the first time - # the store is opened. + # General setting for the managed Google Play store layout, currently only + # specifying the page to display the first time the store is opened. class StoreLayout include Google::Apis::Core::Hashable - # The ID of the store page to be used as the homepage. The homepage is the - # first page shown in the managed Google Play Store. - # Not specifying a homepage is equivalent to setting the store layout - # type to "basic". + # The ID of the store page to be used as the homepage. The homepage is the first + # page shown in the managed Google Play Store. Not specifying a homepage is + # equivalent to setting the store layout type to "basic". # Corresponds to the JSON property `homepageId` # @return [String] attr_accessor :homepage_id - # The store layout type. By default, this value is set to "basic" - # if the homepageId field is not set, and to "custom" otherwise. - # If set to "basic", the layout will consist of all approved apps that - # have been whitelisted for the user. + # The store layout type. By default, this value is set to "basic" if the + # homepageId field is not set, and to "custom" otherwise. If set to "basic", the + # layout will consist of all approved apps that have been whitelisted for the + # user. # Corresponds to the JSON property `storeLayoutType` # @return [String] attr_accessor :store_layout_type @@ -2680,9 +2597,8 @@ module Google end end - # Definition of a managed Google Play store page, made of a localized name - # and links to other pages. A page also contains clusters defined - # as a subcollection. + # Definition of a managed Google Play store page, made of a localized name and + # links to other pages. A page also contains clusters defined as a subcollection. class StorePage include Google::Apis::Core::Hashable @@ -2691,19 +2607,17 @@ module Google # @return [String] attr_accessor :id - # Ordered list of pages a user should be able to reach from this page. - # The list can't include this page. - # It is recommended that the basic pages are created first, - # before adding the links between pages. - # The API doesn't verify that the pages exist or the pages are reachable. + # Ordered list of pages a user should be able to reach from this page. The list + # can't include this page. It is recommended that the basic pages are created + # first, before adding the links between pages. The API doesn't verify that the + # pages exist or the pages are reachable. # Corresponds to the JSON property `link` # @return [Array] attr_accessor :link - # Ordered list of localized strings giving the name of this page. - # The text displayed is the one that best matches the user locale, - # or the first entry if there is no good match. There needs to be - # at least one entry. + # Ordered list of localized strings giving the name of this page. The text + # displayed is the one that best matches the user locale, or the first entry if + # there is no good match. There needs to be at least one entry. # Corresponds to the JSON property `name` # @return [Array] attr_accessor :name @@ -2720,15 +2634,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 @@ -2758,15 +2671,15 @@ module Google class TrackInfo include Google::Apis::Core::Hashable - # A modifiable name for a track. This is the visible name in the play - # developer console. + # A modifiable name for a track. This is the visible name in the play developer + # console. # Corresponds to the JSON property `trackAlias` # @return [String] attr_accessor :track_alias - # Unmodifiable, unique track identifier. This identifier is the - # releaseTrackId in the url of the play developer console page that displays - # the track information. + # Unmodifiable, unique track identifier. This identifier is the releaseTrackId + # in the url of the play developer console page that displays the track + # information. # Corresponds to the JSON property `trackId` # @return [String] attr_accessor :track_id @@ -2783,43 +2696,37 @@ module Google end # A Users resource represents an account associated with an enterprise. The - # account may be specific to a device or to an individual user (who can then - # use the account across multiple devices). The account may provide access to + # account may be specific to a device or to an individual user (who can then use + # the account across multiple devices). The account may provide access to # managed Google Play only, or to other Google services, depending on the - # identity model: - #
  • The Google managed domain identity model requires synchronization to - # Google account sources (via primaryEmail).
    • - #
  • The managed Google Play Accounts identity model provides a dynamic means - # for enterprises to create user or device accounts as needed. These accounts - # provide access to managed Google Play.
    • - #
+ # identity model: - The Google managed domain identity model requires + # synchronization to Google account sources (via primaryEmail). - The managed + # Google Play Accounts identity model provides a dynamic means for enterprises + # to create user or device accounts as needed. These accounts provide access to + # managed Google Play. class User include Google::Apis::Core::Hashable - # A unique identifier you create for this user, such as "user342" or - # "asset#44418". Do not use personally identifiable information (PII) for - # this property. Must always be set for EMM-managed users. - # Not set for Google-managed users. + # A unique identifier you create for this user, such as "user342" or "asset# + # 44418". Do not use personally identifiable information (PII) for this property. + # Must always be set for EMM-managed users. Not set for Google-managed users. # Corresponds to the JSON property `accountIdentifier` # @return [String] attr_accessor :account_identifier - # The type of account that this user represents. A userAccount - # can be installed on multiple devices, but a deviceAccount is - # specific to a single device. An EMM-managed user (emmManaged) - # can be either type (userAccount, deviceAccount), - # but a Google-managed user (googleManaged) is always a - # userAccount. + # The type of account that this user represents. A userAccount can be installed + # on multiple devices, but a deviceAccount is specific to a single device. An + # EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), + # but a Google-managed user (googleManaged) is always a userAccount. # Corresponds to the JSON property `accountType` # @return [String] attr_accessor :account_type # The name that will appear in user interfaces. Setting this property is - # optional when creating EMM-managed users. If you do set this property, - # use something generic about the organization (such as "Example, Inc.") or - # your name (as EMM). - # Not used for Google-managed user accounts. - # @mutable androidenterprise.users.update + # optional when creating EMM-managed users. If you do set this property, use + # something generic about the organization (such as "Example, Inc.") or your + # name (as EMM). Not used for Google-managed user accounts. @mutable + # androidenterprise.users.update # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -2829,17 +2736,15 @@ module Google # @return [String] attr_accessor :id - # The entity that manages the user. With googleManaged users, - # the source of truth is Google so EMMs have to make sure a Google Account - # exists for the user. With emmManaged users, the - # EMM is in charge. + # The entity that manages the user. With googleManaged users, the source of + # truth is Google so EMMs have to make sure a Google Account exists for the user. + # With emmManaged users, the EMM is in charge. # Corresponds to the JSON property `managementType` # @return [String] attr_accessor :management_type - # The user's primary email address, for example, "jsmith@example.com". - # Will always be set for Google managed users and not set for EMM managed - # users. + # The user's primary email address, for example, "jsmith@example.com". Will + # always be set for Google managed users and not set for EMM managed users. # Corresponds to the JSON property `primaryEmail` # @return [String] attr_accessor :primary_email @@ -2878,10 +2783,10 @@ module Google end end - # A variable set is a key-value pair of EMM-provided placeholders and - # its corresponding value, which is attributed to a user. For example, - # $FIRSTNAME could be a placeholder, and its value could be Alice. Placeholders - # should start with a '$' sign and should be alphanumeric only. + # A variable set is a key-value pair of EMM-provided placeholders and its + # corresponding value, which is attributed to a user. For example, $FIRSTNAME + # could be a placeholder, and its value could be Alice. Placeholders should + # start with a '$' sign and should be alphanumeric only. class VariableSet include Google::Apis::Core::Hashable @@ -2907,23 +2812,19 @@ module Google end # A WebApps resource represents a web app created for an enterprise. Web apps - # are published to managed Google Play and can be distributed like other - # Android apps. On a user's device, a web app opens its specified URL. + # are published to managed Google Play and can be distributed like other Android + # apps. On a user's device, a web app opens its specified URL. class WebApp include Google::Apis::Core::Hashable - # The display mode of the web app.

- # Possible values include: - #
  • "minimalUi", the device's status bar, navigation bar, - # the app's URL, and a refresh button are visible when the app is open. For - # HTTP URLs, you can only select this option. - #
  • "standalone", the device's status bar and navigation - # bar are visible when the app is open. - #
  • "fullScreen", the app opens in full screen mode, hiding - # the device's status and navigation bars. All browser UI elements, page - # URL, system status bar and back button are not visible, and the web app - # takes up the entirety of the available display area. - #
+ # The display mode of the web app. Possible values include: - "minimalUi", the + # device's status bar, navigation bar, the app's URL, and a refresh button are + # visible when the app is open. For HTTP URLs, you can only select this option. - + # "standalone", the device's status bar and navigation bar are visible when the + # app is open. - "fullScreen", the app opens in full screen mode, hiding the + # device's status and navigation bars. All browser UI elements, page URL, system + # status bar and back button are not visible, and the web app takes up the + # entirety of the available display area. # Corresponds to the JSON property `displayMode` # @return [String] attr_accessor :display_mode @@ -2952,19 +2853,16 @@ module Google # @return [String] attr_accessor :title - # The current version of the app. - #

Note that the version can automatically increase during the lifetime of - # the web app, while Google does internal housekeeping to keep the web app - # up-to-date. + # The current version of the app. Note that the version can automatically + # increase during the lifetime of the web app, while Google does internal + # housekeeping to keep the web app up-to-date. # Corresponds to the JSON property `versionCode` # @return [Fixnum] attr_accessor :version_code - # The ID of the application. A string of the form - # "app:<package name>" where the package name - # always starts with the prefix - # "com.google.enterprise.webapp." followed by a - # random id. + # The ID of the application. A string of the form "app:" where the + # package name always starts with the prefix "com.google.enterprise.webapp." + # followed by a random id. # Corresponds to the JSON property `webAppId` # @return [String] attr_accessor :web_app_id @@ -2990,12 +2888,9 @@ module Google include Google::Apis::Core::Hashable # The actual bytes of the image in a base64url encoded string (c.f. RFC4648, - # section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). - #

    - #
  • The image type can be png or jpg. - #
  • The image should ideally be square. - #
  • The image should ideally have a size of 512x512. - #
+ # section 5 "Base 64 Encoding with URL and Filename Safe Alphabet"). - The image + # type can be png or jpg. - The image should ideally be square. - The image + # should ideally have a size of 512x512. # Corresponds to the JSON property `imageData` # @return [String] attr_accessor :image_data diff --git a/generated/google/apis/androidenterprise_v1/service.rb b/generated/google/apis/androidenterprise_v1/service.rb index 6a9025a58..8c8ef3988 100644 --- a/generated/google/apis/androidenterprise_v1/service.rb +++ b/generated/google/apis/androidenterprise_v1/service.rb @@ -47,11 +47,10 @@ module Google @batch_path = 'batch/androidenterprise/v1' end - # Uploads a report containing any changes in app states on the device since - # the last report was generated. You can call this method up to 3 times every - # 24 hours for a given device. - # If you exceed the quota, then the Google Play EMM API returns HTTP - # 429 Too Many Requests. + # Uploads a report containing any changes in app states on the device since the + # last report was generated. You can call this method up to 3 times every 24 + # hours for a given device. If you exceed the quota, then the Google Play EMM + # API returns HTTP 429 Too Many Requests. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -121,13 +120,11 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves whether a device's access to Google services is enabled or - # disabled. + # Retrieves whether a device's access to Google services is enabled or disabled. # The device state takes effect only if enforcing EMM policies on Android - # devices is enabled in the Google Admin Console. - # Otherwise, the device state is ignored and all devices are allowed access - # to Google services. - # This is only supported for Google-managed users. + # devices is enabled in the Google Admin Console. Otherwise, the device state is + # ignored and all devices are allowed access to Google services. This is only + # supported for Google-managed users. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -196,12 +193,11 @@ module Google execute_or_queue_command(command, &block) end - # Sets whether a device's access to Google services is enabled or disabled. - # The device state takes effect only if enforcing EMM policies on Android - # devices is enabled in the Google Admin Console. - # Otherwise, the device state is ignored and all devices are allowed access - # to Google services. - # This is only supported for Google-managed users. + # Sets whether a device's access to Google services is enabled or disabled. The + # device state takes effect only if enforcing EMM policies on Android devices is + # enabled in the Google Admin Console. Otherwise, the device state is ignored + # and all devices are allowed access to Google services. This is only supported + # for Google-managed users. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -249,10 +245,9 @@ module Google # The ID of the device. # @param [Google::Apis::AndroidenterpriseV1::Device] device_object # @param [String] update_mask - # Mask that identifies which fields to update. If not set, all modifiable - # fields will be modified. - # When set in a query parameter, this field should be specified as - # updateMask=<field1>,<field2>,... + # Mask that identifies which fields to update. If not set, all modifiable fields + # will be modified. When set in a query parameter, this field should be + # specified as updateMask=,,... # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -285,12 +280,12 @@ module Google execute_or_queue_command(command, &block) end - # Acknowledges notifications that were received from - # Enterprises.PullNotificationSet to prevent subsequent calls from returning - # the same notifications. + # Acknowledges notifications that were received from Enterprises. + # PullNotificationSet to prevent subsequent calls from returning the same + # notifications. # @param [String] notification_set_id - # The notification set ID as returned by Enterprises.PullNotificationSet. - # This must be provided. + # The notification set ID as returned by Enterprises.PullNotificationSet. This + # must be provided. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -316,9 +311,8 @@ module Google execute_or_queue_command(command, &block) end - # Completes the signup flow, by specifying the Completion token and - # Enterprise token. - # This request must not be called multiple times for a given Enterprise + # Completes the signup flow, by specifying the Completion token and Enterprise + # token. This request must not be called multiple times for a given Enterprise # Token. # @param [String] completion_token # The Completion token initially returned by GenerateSignupUrl. @@ -352,10 +346,10 @@ module Google execute_or_queue_command(command, &block) end - # Returns a unique token to access an embeddable UI. To generate a - # web UI, pass the generated token into the managed Google Play javascript - # API. Each token may only be used to start one UI session. See the - # javascript API documentation for further information. + # Returns a unique token to access an embeddable UI. To generate a web UI, pass + # the generated token into the managed Google Play javascript API. Each token + # may only be used to start one UI session. See the javascript API documentation + # for further information. # @param [String] enterprise_id # The ID of the enterprise. # @param [Google::Apis::AndroidenterpriseV1::AdministratorWebTokenSpec] administrator_web_token_spec_object @@ -424,13 +418,12 @@ module Google # Generates a sign-up URL. # @param [String] callback_url # The callback URL to which the Admin will be redirected after successfully - # creating an enterprise. Before redirecting there the system will add a - # single query parameter to this URL named "enterpriseToken" which will - # contain an opaque token to be used for the CompleteSignup request.
- # Beware that this means that the URL will be parsed, the parameter added - # and then a new URL formatted, i.e. there may be some minor formatting - # changes and, more importantly, the URL must be well-formed so that it can - # be parsed. + # creating an enterprise. Before redirecting there the system will add a single + # query parameter to this URL named "enterpriseToken" which will contain an + # opaque token to be used for the CompleteSignup request. Beware that this means + # that the URL will be parsed, the parameter added and then a new URL formatted, + # i.e. there may be some minor formatting changes and, more importantly, the URL + # must be well-formed so that it can be parsed. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -488,21 +481,16 @@ module Google execute_or_queue_command(command, &block) end - # Returns a service account and credentials. The service account - # can be bound to the enterprise by calling setAccount. The service account - # is unique to this enterprise and EMM, and will be deleted if the enterprise - # is unbound. The credentials contain private key data and are not stored - # server-side. - #

- # This method can only be called after calling - # Enterprises.Enroll or Enterprises.CompleteSignup, and before - # Enterprises.SetAccount; at other times it will return an error. - #

- # Subsequent calls after the first will generate a new, unique set of - # credentials, and invalidate the previously generated credentials. - #

- # Once the service account is bound to the enterprise, it can be managed - # using the serviceAccountKeys resource. + # Returns a service account and credentials. The service account can be bound to + # the enterprise by calling setAccount. The service account is unique to this + # enterprise and EMM, and will be deleted if the enterprise is unbound. The + # credentials contain private key data and are not stored server-side. This + # method can only be called after calling Enterprises.Enroll or Enterprises. + # CompleteSignup, and before Enterprises.SetAccount; at other times it will + # return an error. Subsequent calls after the first will generate a new, unique + # set of credentials, and invalidate the previously generated credentials. Once + # the service account is bound to the enterprise, it can be managed using the + # serviceAccountKeys resource. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] key_type @@ -535,9 +523,8 @@ module Google execute_or_queue_command(command, &block) end - # Returns the store layout for the enterprise. If the store layout - # has not been set, returns "basic" as the store layout type and no - # homepage. + # Returns the store layout for the enterprise. If the store layout has not been + # set, returns "basic" as the store layout type and no homepage. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] fields @@ -567,11 +554,11 @@ module Google execute_or_queue_command(command, &block) end - # Looks up an enterprise by domain name. - # This is only supported for enterprises created via the Google-initiated - # creation flow. Lookup of the id is not needed for enterprises created via - # the EMM-initiated flow since the EMM learns the enterprise ID in the - # callback specified in the Enterprises.generateSignupUrl call. + # Looks up an enterprise by domain name. This is only supported for enterprises + # created via the Google-initiated creation flow. Lookup of the id is not needed + # for enterprises created via the EMM-initiated flow since the EMM learns the + # enterprise ID in the callback specified in the Enterprises.generateSignupUrl + # call. # @param [String] domain # Required. The exact primary domain name of the enterprise to look up. # @param [String] fields @@ -601,38 +588,26 @@ module Google execute_or_queue_command(command, &block) end - # Pulls and returns a notification set for the enterprises associated with - # the service account authenticated for the request. The notification set may - # be empty if no notification are pending. - #
- # A notification set returned needs to be acknowledged within 20 seconds - # by calling Enterprises.AcknowledgeNotificationSet, unless the - # notification set is empty. - #
- # Notifications that are not acknowledged within the 20 seconds will - # eventually be included again in the response to another PullNotificationSet - # request, and those that are never acknowledged will ultimately be deleted - # according to the Google Cloud Platform Pub/Sub system policy. - #
- # Multiple requests might be performed concurrently to retrieve - # notifications, in which case the pending notifications (if any) will be - # split among each caller, if any are pending. - #
- # If no notifications are present, an empty notification list is returned. - # Subsequent requests may return more notifications once they become - # available. + # Pulls and returns a notification set for the enterprises associated with the + # service account authenticated for the request. The notification set may be + # empty if no notification are pending. A notification set returned needs to be + # acknowledged within 20 seconds by calling Enterprises. + # AcknowledgeNotificationSet, unless the notification set is empty. + # Notifications that are not acknowledged within the 20 seconds will eventually + # be included again in the response to another PullNotificationSet request, and + # those that are never acknowledged will ultimately be deleted according to the + # Google Cloud Platform Pub/Sub system policy. Multiple requests might be + # performed concurrently to retrieve notifications, in which case the pending + # notifications (if any) will be split among each caller, if any are pending. If + # no notifications are present, an empty notification list is returned. + # Subsequent requests may return more notifications once they become available. # @param [String] request_mode - # The request mode for pulling notifications. - #
- # Specifying waitForNotifications will cause the request to - # block and wait until one or more notifications are present, or return an - # empty notification list if no notifications are present after some time. - #
- # Speciying returnImmediately will cause the request to + # The request mode for pulling notifications. Specifying waitForNotifications + # will cause the request to block and wait until one or more notifications are + # present, or return an empty notification list if no notifications are present + # after some time. Speciying returnImmediately will cause the request to # immediately return the pending notifications, or an empty list if no - # notifications are present. - #
- # If omitted, defaults to waitForNotifications. + # notifications are present. If omitted, defaults to waitForNotifications. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -660,8 +635,8 @@ module Google execute_or_queue_command(command, &block) end - # Sends a test notification to validate the EMM integration with - # the Google Cloud Pub/Sub service for this enterprise. + # Sends a test notification to validate the EMM integration with the Google + # Cloud Pub/Sub service for this enterprise. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] fields @@ -725,15 +700,13 @@ module Google execute_or_queue_command(command, &block) end - # Sets the store layout for the enterprise. By default, storeLayoutType - # is set to "basic" and the basic store layout is enabled. The basic - # layout only contains apps approved by the admin, and that have - # been added to the available product set for a user (using the - # - # setAvailableProductSet call). Apps on the page are sorted in order of - # their product ID value. If you create a custom store layout (by setting - # storeLayoutType = "custom" and setting a homepage), the basic store - # layout is disabled. + # Sets the store layout for the enterprise. By default, storeLayoutType is set + # to "basic" and the basic store layout is enabled. The basic layout only + # contains apps approved by the admin, and that have been added to the available + # product set for a user (using the setAvailableProductSet call). Apps on the + # page are sorted in order of their product ID value. If you create a custom + # store layout (by setting storeLayoutType = "custom" and setting a homepage), + # the basic store layout is disabled. # @param [String] enterprise_id # The ID of the enterprise. # @param [Google::Apis::AndroidenterpriseV1::StoreLayout] store_layout_object @@ -907,9 +880,9 @@ module Google # @param [Google::Apis::AndroidenterpriseV1::Entitlement] entitlement_object # @param [Boolean] install # Set to true to also install the product on all the user's devices where - # possible. Failure to install on one or more devices will not prevent - # this operation from returning successfully, as long as the entitlement - # was successfully assigned to the user. + # possible. Failure to install on one or more devices will not prevent this + # operation from returning successfully, as long as the entitlement was + # successfully assigned to the user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -946,8 +919,8 @@ module Google # @param [String] enterprise_id # The ID of the enterprise. # @param [String] group_license_id - # The ID of the product the group license is for, e.g. - # "app:com.google.android.gm". + # The ID of the product the group license is for, e.g. "app:com.google.android. + # gm". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1006,13 +979,13 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the IDs of the users who have been granted entitlements - # under the license. + # Retrieves the IDs of the users who have been granted entitlements under the + # license. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] group_license_id - # The ID of the product the group license is for, e.g. - # "app:com.google.android.gm". + # The ID of the product the group license is for, e.g. "app:com.google.android. + # gm". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1041,9 +1014,8 @@ module Google execute_or_queue_command(command, &block) end - # Requests to remove an app from a device. A call to get or - # list will still show the app as installed on the device until - # it is actually removed. + # Requests to remove an app from a device. A call to get or list will still show + # the app as installed on the device until it is actually removed. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -1051,8 +1023,8 @@ module Google # @param [String] device_id # The Android ID of the device. # @param [String] install_id - # The ID of the product represented by the install, e.g. - # "app:com.google.android.gm". + # The ID of the product represented by the install, e.g. "app:com.google.android. + # gm". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1089,8 +1061,8 @@ module Google # @param [String] device_id # The Android ID of the device. # @param [String] install_id - # The ID of the product represented by the install, e.g. - # "app:com.google.android.gm". + # The ID of the product represented by the install, e.g. "app:com.google.android. + # gm". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1157,9 +1129,8 @@ module Google execute_or_queue_command(command, &block) end - # Requests to install the latest version of an app to a device. If the app - # is already installed, then it is updated to the latest version if - # necessary. + # Requests to install the latest version of an app to a device. If the app is + # already installed, then it is updated to the latest version if necessary. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -1167,8 +1138,8 @@ module Google # @param [String] device_id # The Android ID of the device. # @param [String] install_id - # The ID of the product represented by the install, e.g. - # "app:com.google.android.gm". + # The ID of the product represented by the install, e.g. "app:com.google.android. + # gm". # @param [Google::Apis::AndroidenterpriseV1::Install] install_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1202,8 +1173,7 @@ module Google execute_or_queue_command(command, &block) end - # Removes a per-device managed configuration for an app for the specified - # device. + # Removes a per-device managed configuration for an app for the specified device. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -1211,8 +1181,8 @@ module Google # @param [String] device_id # The Android ID of the device. # @param [String] managed_configuration_for_device_id - # The ID of the managed configuration (a product ID), e.g. - # "app:com.google.android.gm". + # The ID of the managed configuration (a product ID), e.g. "app:com.google. + # android.gm". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1249,8 +1219,8 @@ module Google # @param [String] device_id # The Android ID of the device. # @param [String] managed_configuration_for_device_id - # The ID of the managed configuration (a product ID), e.g. - # "app:com.google.android.gm". + # The ID of the managed configuration (a product ID), e.g. "app:com.google. + # android.gm". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1281,8 +1251,8 @@ module Google execute_or_queue_command(command, &block) end - # Lists all the per-device managed configurations for the specified device. - # Only the ID is set. + # Lists all the per-device managed configurations for the specified device. Only + # the ID is set. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -1327,8 +1297,8 @@ module Google # @param [String] device_id # The Android ID of the device. # @param [String] managed_configuration_for_device_id - # The ID of the managed configuration (a product ID), e.g. - # "app:com.google.android.gm". + # The ID of the managed configuration (a product ID), e.g. "app:com.google. + # android.gm". # @param [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] managed_configuration_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1368,8 +1338,8 @@ module Google # @param [String] user_id # The ID of the user. # @param [String] managed_configuration_for_user_id - # The ID of the managed configuration (a product ID), e.g. - # "app:com.google.android.gm". + # The ID of the managed configuration (a product ID), e.g. "app:com.google. + # android.gm". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1404,8 +1374,8 @@ module Google # @param [String] user_id # The ID of the user. # @param [String] managed_configuration_for_user_id - # The ID of the managed configuration (a product ID), e.g. - # "app:com.google.android.gm". + # The ID of the managed configuration (a product ID), e.g. "app:com.google. + # android.gm". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1435,8 +1405,8 @@ module Google execute_or_queue_command(command, &block) end - # Lists all the per-user managed configurations for the specified user. Only - # the ID is set. + # Lists all the per-user managed configurations for the specified user. Only the + # ID is set. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -1470,24 +1440,17 @@ module Google end # Adds or updates the managed configuration settings for an app for the - # specified user. - # If you support the Managed - # configurations iframe, - # you can apply managed configurations to a user by specifying an - # mcmId - # and its associated configuration variables (if any) in the request. - # Alternatively, - # all EMMs can apply managed configurations by passing a list of managed - # properties. + # specified user. If you support the Managed configurations iframe, you can + # apply managed configurations to a user by specifying an mcmId and its + # associated configuration variables (if any) in the request. Alternatively, all + # EMMs can apply managed configurations by passing a list of managed properties. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id # The ID of the user. # @param [String] managed_configuration_for_user_id - # The ID of the managed configuration (a product ID), e.g. - # "app:com.google.android.gm". + # The ID of the managed configuration (a product ID), e.g. "app:com.google. + # android.gm". # @param [Google::Apis::AndroidenterpriseV1::ManagedConfiguration] managed_configuration_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1524,8 +1487,7 @@ module Google # @param [String] enterprise_id # The ID of the enterprise. # @param [String] product_id - # The ID of the product for which the managed configurations settings applies - # to. + # The ID of the product for which the managed configurations settings applies to. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1588,13 +1550,10 @@ module Google execute_or_queue_command(command, &block) end - #

Approves the specified product and the relevant app permissions, if any. - # The maximum number of products that you can approve per enterprise customer - # is 1,000.

- #

To learn how to use managed Google Play to design and create a store - # layout to display approved products to your users, - # see Store Layout - # Design.

+ # Approves the specified product and the relevant app permissions, if any. The + # maximum number of products that you can approve per enterprise customer is 1, + # 000. To learn how to use managed Google Play to design and create a store + # layout to display approved products to your users, see Store Layout Design. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] product_id @@ -1628,23 +1587,21 @@ module Google execute_or_queue_command(command, &block) end - # Generates a URL that can be rendered in an iframe to display the - # permissions (if any) of a product. An enterprise admin must view these - # permissions and accept them on behalf of their organization in order to - # approve that product.

- # Admins should accept the displayed permissions by - # interacting with a separate UI element in the EMM console, which in turn - # should trigger the use of this URL as the - # approvalUrlInfo.approvalUrl property in a - # Products.approve call to approve the product. - # This URL can only be used to display permissions for up to 1 day. + # Generates a URL that can be rendered in an iframe to display the permissions ( + # if any) of a product. An enterprise admin must view these permissions and + # accept them on behalf of their organization in order to approve that product. + # Admins should accept the displayed permissions by interacting with a separate + # UI element in the EMM console, which in turn should trigger the use of this + # URL as the approvalUrlInfo.approvalUrl property in a Products.approve call to + # approve the product. This URL can only be used to display permissions for up + # to 1 day. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] product_id # The ID of the product. # @param [String] language_code - # The BCP 47 language code used for permission names and descriptions in - # the returned iframe, for instance "en-US". + # The BCP 47 language code used for permission names and descriptions in the + # returned iframe, for instance "en-US". # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1710,14 +1667,12 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the schema that defines the configurable properties for this - # product. All products have a schema, but this schema may be empty if no - # managed configurations have been defined. This schema can be used to - # populate a UI that allows an admin to configure the product. - # To apply a managed configuration based on the schema obtained using this - # API, see - # Managed - # Configurations through Play. + # Retrieves the schema that defines the configurable properties for this product. + # All products have a schema, but this schema may be empty if no managed + # configurations have been defined. This schema can be used to populate a UI + # that allows an admin to configure the product. To apply a managed + # configuration based on the schema obtained using this API, see Managed + # Configurations through Play. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] product_id @@ -1786,29 +1741,26 @@ module Google execute_or_queue_command(command, &block) end - # Finds approved products that match a query, or all approved products - # if there is no query. + # Finds approved products that match a query, or all approved products if there + # is no query. # @param [String] enterprise_id # The ID of the enterprise. # @param [Boolean] approved - # Specifies whether to search among all products (false) or among - # only products that have been approved (true). Only "true" is - # supported, and should be specified. + # Specifies whether to search among all products (false) or among only products + # that have been approved (true). Only "true" is supported, and should be + # specified. # @param [String] language - # The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). - # Results are returned in the language best matching the preferred - # language. + # The BCP47 tag for the user's preferred language (e.g. "en-US", "de"). Results + # are returned in the language best matching the preferred language. # @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 [String] query - # The search query as typed in the Google Play store search box. - # If omitted, all approved apps will be returned (using the pagination - # parameters), including apps that are not available in the store - # (e.g. unpublished apps). + # The search query as typed in the Google Play store search box. If omitted, all + # approved apps will be returned (using the pagination parameters), including + # apps that are not available in the store (e.g. unpublished apps). # @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 [String] fields # Selector specifying which fields to include in a partial response. @@ -1875,8 +1827,8 @@ module Google # Removes and invalidates the specified credentials for the service account # associated with this enterprise. The calling service account must have been - # retrieved by calling Enterprises.GetServiceAccount and must have been set - # as the enterprise service account by calling Enterprises.SetAccount. + # retrieved by calling Enterprises.GetServiceAccount and must have been set as + # the enterprise service account by calling Enterprises.SetAccount. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] key_id @@ -1909,10 +1861,9 @@ module Google # Generates new credentials for the service account associated with this # enterprise. The calling service account must have been retrieved by calling - # Enterprises.GetServiceAccount and must have been set as the enterprise - # service account by calling Enterprises.SetAccount.

- # Only the type of the key should be populated in the resource to be - # inserted. + # Enterprises.GetServiceAccount and must have been set as the enterprise service + # account by calling Enterprises.SetAccount. Only the type of the key should be + # populated in the resource to be inserted. # @param [String] enterprise_id # The ID of the enterprise. # @param [Google::Apis::AndroidenterpriseV1::ServiceAccountKey] service_account_key_object @@ -1946,10 +1897,10 @@ module Google end # Lists all active credentials for the service account associated with this - # enterprise. Only the ID and key type are returned. The calling service - # account must have been retrieved by calling Enterprises.GetServiceAccount - # and must have been set as the enterprise service account by calling - # Enterprises.SetAccount. + # enterprise. Only the ID and key type are returned. The calling service account + # must have been retrieved by calling Enterprises.GetServiceAccount and must + # have been set as the enterprise service account by calling Enterprises. + # SetAccount. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] fields @@ -2352,10 +2303,9 @@ module Google end # Generates an authentication token which the device policy client can use to - # provision the given EMM-managed user account on a device. - # The generated token is single-use and expires after a few minutes. - # You can provision a maximum of 10 devices per user. - # This call only works with EMM-managed accounts. + # provision the given EMM-managed user account on a device. The generated token + # is single-use and expires after a few minutes. You can provision a maximum of + # 10 devices per user. This call only works with EMM-managed accounts. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -2454,13 +2404,11 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new EMM-managed user. - # The Users resource - # passed in the body of the request should include an - # accountIdentifier and an accountType. - #

If a corresponding user already exists with the same account identifier, - # the user will be updated with the resource. In this case only the - # displayName field can be changed. + # Creates a new EMM-managed user. The Users resource passed in the body of the + # request should include an accountIdentifier and an accountType. If a + # corresponding user already exists with the same account identifier, the user + # will be updated with the resource. In this case only the displayName field can + # be changed. # @param [String] enterprise_id # The ID of the enterprise. # @param [Google::Apis::AndroidenterpriseV1::User] user_object @@ -2493,10 +2441,9 @@ module Google execute_or_queue_command(command, &block) end - # Looks up a user by primary email address. - # This is only supported for Google-managed users. Lookup of the id is not - # needed for EMM-managed users because the id is already returned in the - # result of the Users.insert call. + # Looks up a user by primary email address. This is only supported for Google- + # managed users. Lookup of the id is not needed for EMM-managed users because + # the id is already returned in the result of the Users.insert call. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] email @@ -2529,10 +2476,9 @@ module Google execute_or_queue_command(command, &block) end - # Revokes access to all devices currently provisioned to the user. The user - # will no longer be able to use the managed Play store on any of their - # managed devices. - # This call only works with EMM-managed accounts. + # Revokes access to all devices currently provisioned to the user. The user will + # no longer be able to use the managed Play store on any of their managed + # devices. This call only works with EMM-managed accounts. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -2563,11 +2509,9 @@ module Google execute_or_queue_command(command, &block) end - # Modifies the set of products that a user is entitled to access (referred to - # as whitelisted products). Only products that are - # approved - # or products that were previously approved (products with revoked approval) - # can be whitelisted. + # Modifies the set of products that a user is entitled to access (referred to as + # *whitelisted* products). Only products that are approved or products that were + # previously approved (products with revoked approval) can be whitelisted. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id @@ -2603,13 +2547,10 @@ module Google execute_or_queue_command(command, &block) end - # Updates the details of an EMM-managed user. - # Can be used with EMM-managed users only (not Google managed users). - # Pass the new details in the - # Users - # resource in the request body. Only the displayName field - # can be changed. Other fields must either be unset or have the - # currently active value. + # Updates the details of an EMM-managed user. Can be used with EMM-managed users + # only (not Google managed users). Pass the new details in the Users resource in + # the request body. Only the displayName field can be changed. Other fields must + # either be unset or have the currently active value. # @param [String] enterprise_id # The ID of the enterprise. # @param [String] user_id diff --git a/generated/google/apis/androidmanagement_v1.rb b/generated/google/apis/androidmanagement_v1.rb index a0ae6fd5b..09fc266e2 100644 --- a/generated/google/apis/androidmanagement_v1.rb +++ b/generated/google/apis/androidmanagement_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/android/management module AndroidmanagementV1 VERSION = 'V1' - REVISION = '20200612' + REVISION = '20200803' # Manage Android devices and apps for your customers AUTH_ANDROIDMANAGEMENT = 'https://www.googleapis.com/auth/androidmanagement' diff --git a/generated/google/apis/apigee_v1.rb b/generated/google/apis/apigee_v1.rb index e22cc3308..5d5112a38 100644 --- a/generated/google/apis/apigee_v1.rb +++ b/generated/google/apis/apigee_v1.rb @@ -21,17 +21,16 @@ module Google # Apigee API # # The Apigee API lets you programmatically manage Apigee hybrid with a set of - # RESTful operations, including:

  • Create, edit, and delete API proxies
  • Manage users
  • Deploy and undeploy proxy revisions
  • - # Configure environments

For information on using the APIs described - # in this section, see - # Get started using the APIs.

Note: This product is - # available as a free trial for a time period of 60 days. + # RESTful operations, including: - Create, edit, and delete API proxies - Manage + # users - Deploy and undeploy proxy revisions - Configure environments For + # information on using the APIs described in this section, see Get started using + # the APIs. *Note:* This product is available as a free trial for a time period + # of 60 days. # # @see https://cloud.google.com/apigee-api-management/ module ApigeeV1 VERSION = 'V1' - REVISION = '20200720' + 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/apigee_v1/classes.rb b/generated/google/apis/apigee_v1/classes.rb index 3adf876f2..65bdb31cd 100644 --- a/generated/google/apis/apigee_v1/classes.rb +++ b/generated/google/apis/apigee_v1/classes.rb @@ -23,34 +23,21 @@ module Google module ApigeeV1 # 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 GoogleApiHttpBody 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 @@ -87,30 +74,20 @@ module Google class GoogleCloudApigeeV1Access include Google::Apis::Core::Hashable - # Get action. For example, - # "Get" : ` - # "name" : "target.name", - # "value" : "default" + # Get action. For example, "Get" : ` "name" : "target.name", "value" : "default" # ` # Corresponds to the JSON property `Get` # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AccessGet] attr_accessor :get - # Remove action. For example, - # "Remove" : ` - # "name" : "target.name", - # "success" : true - # ` + # Remove action. For example, "Remove" : ` "name" : "target.name", "success" : + # true ` # Corresponds to the JSON property `Remove` # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AccessRemove] attr_accessor :remove - # Set action. For example, - # "Set" : ` - # "name" : "target.name", - # "success" : true, - # "value" : "default" - # ` + # Set action. For example, "Set" : ` "name" : "target.name", "success" : true, " + # value" : "default" ` # Corresponds to the JSON property `Set` # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1AccessSet] attr_accessor :set @@ -127,10 +104,7 @@ module Google end end - # Get action. For example, - # "Get" : ` - # "name" : "target.name", - # "value" : "default" + # Get action. For example, "Get" : ` "name" : "target.name", "value" : "default" # ` class GoogleCloudApigeeV1AccessGet include Google::Apis::Core::Hashable @@ -156,11 +130,8 @@ module Google end end - # Remove action. For example, - # "Remove" : ` - # "name" : "target.name", - # "success" : true - # ` + # Remove action. For example, "Remove" : ` "name" : "target.name", "success" : + # true ` class GoogleCloudApigeeV1AccessRemove include Google::Apis::Core::Hashable @@ -186,12 +157,8 @@ module Google end end - # Set action. For example, - # "Set" : ` - # "name" : "target.name", - # "success" : true, - # "value" : "default" - # ` + # Set action. For example, "Set" : ` "name" : "target.name", "success" : true, " + # value" : "default" ` class GoogleCloudApigeeV1AccessSet include Google::Apis::Core::Hashable @@ -227,8 +194,8 @@ module Google class GoogleCloudApigeeV1Alias include Google::Apis::Core::Hashable - # The resource ID for this alias. Values must match regular expression - # `[^/]`1,255``. + # The resource ID for this alias. Values must match regular expression `[^/]`1, + # 255``. # Corresponds to the JSON property `alias` # @return [String] attr_accessor :alias @@ -264,9 +231,8 @@ module Google # @return [String] attr_accessor :location - # The name of the alias revision included in the keystore. Must be of the - # form: - # 'organizations/`org`/environments/`env`/keystores/`keystore`/aliases/`alias`/ + # The name of the alias revision included in the keystore. Must be of the form: ' + # organizations/`org`/environments/`env`/keystores/`keystore`/aliases/`alias`/ # revisions/`rev`'. # Corresponds to the JSON property `name` # @return [String] @@ -293,83 +259,58 @@ module Google class GoogleCloudApigeeV1ApiProduct include Google::Apis::Core::Hashable - # Comma-separated list of API resources to be bundled in the API Product. - # By default, the resource paths are mapped from the `proxy.pathsuffix` - # variable. + # Comma-separated list of API resources to be bundled in the API Product. By + # default, the resource paths are mapped from the `proxy.pathsuffix` variable. # The proxy path suffix is defined as the URI fragment following the - # ProxyEndpoint base path. - # For example, if the `apiResources` element is defined to be - # `/forecastrss` and the base path defined for the API proxy is - # `/weather`, then only requests to `/weather/forecastrss` are permitted by - # the API product. + # ProxyEndpoint base path. For example, if the `apiResources` element is defined + # to be `/forecastrss` and the base path defined for the API proxy is `/weather`, + # then only requests to `/weather/forecastrss` are permitted by the API product. # You can select a specific path, or you can select all subpaths with the - # following wildcard: - # - /**: Indicates that all sub-URIs are included. - # - /* : Indicates that only URIs one level down are included. - # By default, / supports the same resources as /** as well as the base path - # defined by the API proxy. - # For example, if the base path of the API proxy is `/v1/weatherapikey`, - # then the API product supports requests to `/v1/weatherapikey` and to any - # sub-URIs, such as `/v1/weatherapikey/forecastrss`, - # `/v1/weatherapikey/region/CA`, and so on. - # For more information, see: - # - Manage API - # products - # - Managing - # a transaction recording policy using the API + # following wildcard: - /**: Indicates that all sub-URIs are included. - /* : + # Indicates that only URIs one level down are included. By default, / supports + # the same resources as /** as well as the base path defined by the API proxy. + # For example, if the base path of the API proxy is `/v1/weatherapikey`, then + # the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, + # such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so + # on. For more information, see: - Manage API products - Managing a transaction + # recording policy using the API # Corresponds to the JSON property `apiResources` # @return [Array] attr_accessor :api_resources # Specifies how API keys are approved to access the APIs defined by the API - # product. - # If set to `manual`, the consumer key is generated and returned in "pending" - # state. In this case, the API keys won't work until they have been - # explicitly approved. - # If set to `auto`, the consumer key is generated and returned in "approved" - # state and can be used immediately. - #

+ # product. If set to `manual`, the consumer key is generated and returned in " + # pending" state. In this case, the API keys won't work until they have been + # explicitly approved. If set to `auto`, the consumer key is generated and + # returned in "approved" state and can be used immediately. *NOTE:* Typically, ` + # auto` is used to provide access to free or trial API products that provide + # limited quota or capabilities. # Corresponds to the JSON property `approvalType` # @return [String] attr_accessor :approval_type - # Array of attributes that may be used to extend the default API product - # profile with customer-specific metadata. You can specify a maximum of 18 - # attributes. - # Use this property to specify the access level of the API product as either - # `public`, `private`, or `internal`. - # Only products marked `public` are available to developers in the Apigee - # developer portal. For example, you can set a product to `internal` while it - # is in development and then change access to `public` when it is ready to - # release on the portal. - # API products marked as `private` do not appear on the portal but - # can be accessed by external developers. - # For monetization, you can use the attributes field to: - # - Specify transaction success criteria - # - Specify custom attributes on which you base rate plan - # charges. + # Array of attributes that may be used to extend the default API product profile + # with customer-specific metadata. You can specify a maximum of 18 attributes. + # Use this property to specify the access level of the API product as either ` + # public`, `private`, or `internal`. Only products marked `public` are available + # to developers in the Apigee developer portal. For example, you can set a + # product to `internal` while it is in development and then change access to ` + # public` when it is ready to release on the portal. API products marked as ` + # private` do not appear on the portal but can be accessed by external + # developers. For monetization, you can use the attributes field to: - Specify + # transaction success criteria - Specify custom attributes on which you base + # rate plan charges. # Corresponds to the JSON property `attributes` # @return [Array] attr_accessor :attributes - # Response only. Creation time of this environment as milliseconds since - # epoch. + # Response only. Creation time of this environment as milliseconds since epoch. # Corresponds to the JSON property `createdAt` # @return [Fixnum] attr_accessor :created_at - # An overview of the API product. Include key information about the API - # product that is not captured by other fields. + # An overview of the API product. Include key information about the API product + # that is not captured by other fields. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -380,49 +321,43 @@ module Google # @return [String] attr_accessor :display_name - # A comma-separated list of environment names to which the API product is - # bound. Requests to environments that are not listed are rejected. - # By specifying one or more environments, you can bind the resources listed - # in the API product to a specific environment, preventing developers from - # accessing those resources through API proxies deployed in another - # environment. - # This setting is used, for example, to prevent resources associated with - # API proxies in 'prod' from being accessed by API proxies deployed in - # 'test'. + # A comma-separated list of environment names to which the API product is bound. + # Requests to environments that are not listed are rejected. By specifying one + # or more environments, you can bind the resources listed in the API product to + # a specific environment, preventing developers from accessing those resources + # through API proxies deployed in another environment. This setting is used, for + # example, to prevent resources associated with API proxies in 'prod' from being + # accessed by API proxies deployed in 'test'. # Corresponds to the JSON property `environments` # @return [Array] attr_accessor :environments - # Response only. Modified time of this environment as milliseconds since - # epoch. + # Response only. Modified time of this environment as milliseconds since epoch. # Corresponds to the JSON property `lastModifiedAt` # @return [Fixnum] attr_accessor :last_modified_at - # The internal name of the API Product. Characters you can use in the name - # are restricted to: A-Z0-9._\-$ %. - # + # The internal name of the API Product. Characters you can use in the name are + # restricted to: A-Z0-9._\-$ %. *NOTE:* The internal name cannot be edited when + # updating the API product. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # A comma-separated list of API proxy names to which this API product is - # bound. By specifying API proxies, you can associate resources in the API - # product with specific API proxies, preventing developers from accessing - # those resources through other API proxies. - # Edge rejects requests to API proxies that are not listed. - # + # A comma-separated list of API proxy names to which this API product is bound. + # By specifying API proxies, you can associate resources in the API product with + # specific API proxies, preventing developers from accessing those resources + # through other API proxies. Edge rejects requests to API proxies that are not + # listed. *NOTE:* The API proxy names must already exist in the specified + # environment as they will be validated upon creation. # Corresponds to the JSON property `proxies` # @return [Array] attr_accessor :proxies - # The number of request messages permitted per app by this API product for - # the specified `quotaInterval` and `quotaTimeUnit`. - # For example, a `quota` of 50, for a `quotaInterval` of 12 and a - # `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours. + # The number of request messages permitted per app by this API product for the + # specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, + # for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests + # are allowed every 12 hours. # Corresponds to the JSON property `quota` # @return [String] attr_accessor :quota @@ -438,9 +373,9 @@ module Google # @return [String] attr_accessor :quota_time_unit - # A comma-separated list of OAuth scopes that are validated at runtime. - # Edge validates that the scopes in any access token presented match the - # scopes defined in the OAuth policy assoicated with the API product. + # A comma-separated list of OAuth scopes that are validated at runtime. Edge + # validates that the scopes in any access token presented match the scopes + # defined in the OAuth policy assoicated with the API product. # Corresponds to the JSON property `scopes` # @return [Array] attr_accessor :scopes @@ -550,8 +485,7 @@ module Google # @return [String] attr_accessor :context_info - # Time that the API proxy revision was created in milliseconds since - # epoch. + # Time that the API proxy revision was created in milliseconds since epoch. # Corresponds to the JSON property `createdAt` # @return [Fixnum] attr_accessor :created_at @@ -571,8 +505,7 @@ module Google # @return [Hash] attr_accessor :entity_meta_data_as_properties - # Time that the API proxy revision was last modified in - # milliseconds since epoch. + # Time that the API proxy revision was last modified in milliseconds since epoch. # Corresponds to the JSON property `lastModifiedAt` # @return [Fixnum] attr_accessor :last_modified_at @@ -592,10 +525,10 @@ module Google # @return [Array] attr_accessor :proxies - # List of ProxyEndpoints in the `/proxies` directory of the API proxy. - # Typically, this element is included only when the API proxy was created - # using the Edge UI. This is a 'manifest' setting designed to - # provide visibility into the contents of the API proxy. + # List of ProxyEndpoints in the `/proxies` directory of the API proxy. Typically, + # this element is included only when the API proxy was created using the Edge + # UI. This is a 'manifest' setting designed to provide visibility into the + # contents of the API proxy. # Corresponds to the JSON property `proxyEndpoints` # @return [Array] attr_accessor :proxy_endpoints @@ -605,8 +538,8 @@ module Google # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFiles] attr_accessor :resource_files - # List of the resources included in the API proxy revision formatted as - # "`type`://`name`". + # List of the resources included in the API proxy revision formatted as "`type`:/ + # /`name`". # Corresponds to the JSON property `resources` # @return [Array] attr_accessor :resources @@ -621,24 +554,24 @@ module Google # @return [Array] attr_accessor :shared_flows - # OpenAPI Specification that is associated with the API proxy. - # The value is set to a URL or to a path in the specification store. + # OpenAPI Specification that is associated with the API proxy. The value is set + # to a URL or to a path in the specification store. # Corresponds to the JSON property `spec` # @return [String] attr_accessor :spec # List of TargetEndpoints in the `/targets` directory of the API proxy. - # Typically, this element is included only when the API proxy was created - # using the Edge UI. This is a 'manifest' setting designed to - # provide visibility into the contents of the API proxy. + # Typically, this element is included only when the API proxy was created using + # the Edge UI. This is a 'manifest' setting designed to provide visibility into + # the contents of the API proxy. # Corresponds to the JSON property `targetEndpoints` # @return [Array] attr_accessor :target_endpoints - # List of TargetServers referenced in any TargetEndpoint in the API - # proxy. Typically, you will see this element only when the API proxy was - # created using the Edge UI. This is a 'manifest' setting - # designed to provide visibility into the contents of the API proxy. + # List of TargetServers referenced in any TargetEndpoint in the API proxy. + # Typically, you will see this element only when the API proxy was created using + # the Edge UI. This is a 'manifest' setting designed to provide visibility into + # the contents of the API proxy. # Corresponds to the JSON property `targetServers` # @return [Array] attr_accessor :target_servers @@ -653,8 +586,8 @@ module Google # @return [Array] attr_accessor :teams - # Type. Set to `Application`. Maintained for compatibility with - # the Apigee Edge API. + # Type. Set to `Application`. Maintained for compatibility with the Apigee Edge + # API. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -725,21 +658,20 @@ module Google # @return [Fixnum] attr_accessor :created_at - # Output only. Set of credentials for the app. Credentials are API - # key/secret pairs associated with API products. + # Output only. Set of credentials for the app. Credentials are API key/secret + # pairs associated with API products. # Corresponds to the JSON property `credentials` # @return [Array] attr_accessor :credentials - # ID of the developer. + # ID of the developer. # Corresponds to the JSON property `developerId` # @return [String] attr_accessor :developer_id - # Duration, in milliseconds, of the consumer key that will - # be generated for the app. The default value, -1, indicates an - # infinite validity period. Once set, the expiration can't be updated. - # json key: keyExpiresIn + # Duration, in milliseconds, of the consumer key that will be generated for the + # app. The default value, -1, indicates an infinite validity period. Once set, + # the expiration can't be updated. json key: keyExpiresIn # Corresponds to the JSON property `keyExpiresIn` # @return [Fixnum] attr_accessor :key_expires_in @@ -754,8 +686,8 @@ module Google # @return [String] attr_accessor :name - # Scopes to apply to the app. The specified scope names must already - # exist on the API product that you associate with the app. + # Scopes to apply to the app. The specified scope names must already exist on + # the API product that you associate with the app. # Corresponds to the JSON property `scopes` # @return [Array] attr_accessor :scopes @@ -836,10 +768,8 @@ module Google # @return [Fixnum] attr_accessor :result_rows - # Self link of the query. - # Example: - # `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f- - # 318d0cb961bd` + # Self link of the query. Example: `/organizations/myorg/environments/myenv/ + # queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` # Corresponds to the JSON property `self` # @return [String] attr_accessor :self @@ -884,10 +814,8 @@ module Google # @return [String] attr_accessor :expires - # Self link of the query results. - # Example: - # `/organizations/myorg/environments/myenv/queries/9cfc0d85-0f30-46d6-ae6f- - # 318d0cb961bd/result` + # Self link of the query results. Example: `/organizations/myorg/environments/ + # myenv/queries/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd/result` # Corresponds to the JSON property `self` # @return [String] attr_accessor :self @@ -961,8 +889,7 @@ module Google # @return [Fixnum] attr_accessor :expiry_date - # "Yes" if certificate is valid, "No" if expired and "Not yet" - # if not yet valid. + # "Yes" if certificate is valid, "No" if expired and "Not yet" if not yet valid. # Corresponds to the JSON property `isValid` # @return [String] attr_accessor :is_valid @@ -997,8 +924,7 @@ module Google # @return [Array] attr_accessor :subject_alternative_names - # The X.509 validity / notBefore in milliseconds since the - # epoch. + # The X.509 validity / notBefore in milliseconds since the epoch. # Corresponds to the JSON property `validFrom` # @return [Fixnum] attr_accessor :valid_from @@ -1133,8 +1059,8 @@ module Google # @return [Fixnum] attr_accessor :issued_at - # List of scopes to apply to the app. Specified scopes must already - # exist on the API product that you associate with the app. + # List of scopes to apply to the app. Specified scopes must already exist on the + # API product that you associate with the app. # Corresponds to the JSON property `scopes` # @return [Array] attr_accessor :scopes @@ -1170,14 +1096,13 @@ module Google # @return [String] attr_accessor :chart_type - # Legacy field: not used. This field contains a list of comments associated - # with custom report + # Legacy field: not used. This field contains a list of comments associated with + # custom report # Corresponds to the JSON property `comments` # @return [Array] attr_accessor :comments - # Output only. Unix time when the app was created - # json key: createdAt + # Output only. Unix time when the app was created json key: createdAt # Corresponds to the JSON property `createdAt` # @return [Fixnum] attr_accessor :created_at @@ -1207,8 +1132,8 @@ module Google # @return [String] attr_accessor :from_time - # Output only. Modified time of this entity as milliseconds since epoch. - # json key: lastModifiedAt + # Output only. Modified time of this entity as milliseconds since epoch. json + # key: lastModifiedAt # Corresponds to the JSON property `lastModifiedAt` # @return [Fixnum] attr_accessor :last_modified_at @@ -1218,8 +1143,7 @@ module Google # @return [Fixnum] attr_accessor :last_viewed_at - # Legacy field: not used This field contains the limit for the result - # retrieved + # Legacy field: not used This field contains the limit for the result retrieved # Corresponds to the JSON property `limit` # @return [String] attr_accessor :limit @@ -1229,8 +1153,8 @@ module Google # @return [Array] attr_accessor :metrics - # Required. Unique identifier for the report - # T his is a legacy field used to encode custom report unique id + # Required. Unique identifier for the report T his is a legacy field used to + # encode custom report unique id # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1276,8 +1200,8 @@ module Google # @return [String] attr_accessor :to_time - # Legacy field: not used. This field contains the top k parameter value - # for restricting the result + # Legacy field: not used. This field contains the top k parameter value for + # restricting the result # Corresponds to the JSON property `topk` # @return [String] attr_accessor :topk @@ -1313,8 +1237,8 @@ module Google end end - # This encapsulates a metric property of the form sum(message_count) - # where name is message_count and function is sum + # This encapsulates a metric property of the form sum(message_count) where name + # is message_count and function is sum class GoogleCloudApigeeV1CustomReportMetric include Google::Apis::Core::Hashable @@ -1343,8 +1267,8 @@ module Google class GoogleCloudApigeeV1DataCollectorConfig include Google::Apis::Core::Hashable - # The name of the data collector. Must be of the form - # 'organizations/`org`/datacollectors/`dc`'. + # The name of the data collector. Must be of the form 'organizations/`org`/ + # datacollectors/`dc`'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1365,14 +1289,13 @@ module Google end end - # The data store defines the connection to export data repository - # (Cloud Storage, BigQuery), including the credentials used to access the data - # repository. + # The data store defines the connection to export data repository (Cloud Storage, + # BigQuery), including the credentials used to access the data repository. class GoogleCloudApigeeV1Datastore include Google::Apis::Core::Hashable - # Output only. Datastore create time, in milliseconds since the epoch - # of 1970-01-01T00:00:00Z + # Output only. Datastore create time, in milliseconds since the epoch of 1970-01- + # 01T00:00:00Z # Corresponds to the JSON property `createTime` # @return [Fixnum] attr_accessor :create_time @@ -1387,8 +1310,8 @@ module Google # @return [String] attr_accessor :display_name - # Output only. Datastore last update time, in milliseconds since the epoch - # of 1970-01-01T00:00:00Z + # Output only. Datastore last update time, in milliseconds since the epoch of + # 1970-01-01T00:00:00Z # Corresponds to the JSON property `lastUpdateTime` # @return [Fixnum] attr_accessor :last_update_time @@ -1398,14 +1321,13 @@ module Google # @return [String] attr_accessor :org - # Output only. Resource link of Datastore. - # Example: `/organizations/`org`/analytics/datastores/`uuid`` + # Output only. Resource link of Datastore. Example: `/organizations/`org`/ + # analytics/datastores/`uuid`` # Corresponds to the JSON property `self` # @return [String] attr_accessor :self - # Destination storage type. - # Supported types `gcs` or `bigquery`. + # Destination storage type. Supported types `gcs` or `bigquery`. # Corresponds to the JSON property `targetType` # @return [String] attr_accessor :target_type @@ -1430,20 +1352,17 @@ module Google class GoogleCloudApigeeV1DatastoreConfig include Google::Apis::Core::Hashable - # Name of the Cloud Storage bucket. - # Required for `gcs` target_type. + # Name of the Cloud Storage bucket. Required for `gcs` target_type. # Corresponds to the JSON property `bucketName` # @return [String] attr_accessor :bucket_name - # BigQuery dataset name - # Required for `bigquery` target_type. + # BigQuery dataset name Required for `bigquery` target_type. # Corresponds to the JSON property `datasetName` # @return [String] attr_accessor :dataset_name - # Path of Cloud Storage bucket - # Required for `gcs` target_type. + # Path of Cloud Storage bucket Required for `gcs` target_type. # Corresponds to the JSON property `path` # @return [String] attr_accessor :path @@ -1453,8 +1372,7 @@ module Google # @return [String] attr_accessor :project_id - # Prefix of BigQuery table - # Required for `bigquery` target_type. + # Prefix of BigQuery table Required for `bigquery` target_type. # Corresponds to the JSON property `tablePrefix` # @return [String] attr_accessor :table_prefix @@ -1478,15 +1396,14 @@ module Google include Google::Apis::Core::Hashable # Required. End date (exclusive) of the data to export in the format `yyyy-mm-dd` - # . - # The date range ends at 00:00:00 UTC on the end date- which will not be in + # . The date range ends at 00:00:00 UTC on the end date- which will not be in # the output. # Corresponds to the JSON property `end` # @return [String] attr_accessor :end - # Required. Start date of the data to export in the format `yyyy-mm-dd`. - # The date range begins at 00:00:00 UTC on the start date. + # Required. Start date of the data to export in the format `yyyy-mm-dd`. The + # date range begins at 00:00:00 UTC on the start date. # Corresponds to the JSON property `start` # @return [String] attr_accessor :start @@ -1512,8 +1429,8 @@ module Google # @return [Array] attr_accessor :fault_json_paths - # List of XPaths that specify the XML elements to be filtered from XML - # payloads in error flows. + # List of XPaths that specify the XML elements to be filtered from XML payloads + # in error flows. # Corresponds to the JSON property `faultXPaths` # @return [Array] attr_accessor :fault_x_paths @@ -1534,8 +1451,8 @@ module Google # @return [Array] attr_accessor :request_json_paths - # List of XPaths that specify the XML elements to be filtered from XML - # request message payloads. + # List of XPaths that specify the XML elements to be filtered from XML request + # message payloads. # Corresponds to the JSON property `requestXPaths` # @return [Array] attr_accessor :request_x_paths @@ -1546,8 +1463,8 @@ module Google # @return [Array] attr_accessor :response_json_paths - # List of XPaths that specify the XML elements to be filtered from XML - # response message payloads. + # List of XPaths that specify the XML elements to be filtered from XML response + # message payloads. # Corresponds to the JSON property `responseXPaths` # @return [Array] attr_accessor :response_x_paths @@ -1579,15 +1496,14 @@ module Google class GoogleCloudApigeeV1DebugSession include Google::Apis::Core::Hashable - # Optional. The number of request to be traced. Min = 1, Max = 15, Default - # = 10. + # Optional. The number of request to be traced. Min = 1, Max = 15, Default = 10. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count # Optional. A conditional statement which is evaluated against the request - # message to determine if it should be traced. Syntax matches that of on - # API Proxy bundle flow Condition. + # message to determine if it should be traced. Syntax matches that of on API + # Proxy bundle flow Condition. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter @@ -1597,14 +1513,14 @@ module Google # @return [String] attr_accessor :name - # Optional. The time in seconds after which this DebugSession should end. - # This value will override the value in query param, if both are provided. + # Optional. The time in seconds after which this DebugSession should end. This + # value will override the value in query param, if both are provided. # Corresponds to the JSON property `timeout` # @return [Fixnum] attr_accessor :timeout - # Optional. The maximum number of bytes captured from the response payload. - # Min = 0, Max = 5120, Default = 5120. + # Optional. The maximum number of bytes captured from the response payload. Min = + # 0, Max = 5120, Default = 5120. # Corresponds to the JSON property `tracesize` # @return [Fixnum] attr_accessor :tracesize @@ -1631,10 +1547,9 @@ module Google end end - # A transaction contains all of the debug information of the entire message - # flow of an API call processed by the runtime plane. The information is - # collected and recorded at critical points of the message flow in the runtime - # apiproxy. + # A transaction contains all of the debug information of the entire message flow + # of an API call processed by the runtime plane. The information is collected + # and recorded at critical points of the message flow in the runtime apiproxy. class GoogleCloudApigeeV1DebugSessionTransaction include Google::Apis::Core::Hashable @@ -1644,8 +1559,8 @@ module Google attr_accessor :completed alias_method :completed?, :completed - # List of debug data collected by runtime plane at various defined points in - # the flow. + # List of debug data collected by runtime plane at various defined points in the + # flow. # Corresponds to the JSON property `point` # @return [Array] attr_accessor :point @@ -1694,8 +1609,8 @@ module Google # @return [String] attr_accessor :base_path - # Time the API proxy was marked `deployed` in the control plane in - # millisconds since epoch. + # Time the API proxy was marked `deployed` in the control plane in millisconds + # since epoch. # Corresponds to the JSON property `deployStartTime` # @return [Fixnum] attr_accessor :deploy_start_time @@ -1705,20 +1620,19 @@ module Google # @return [String] attr_accessor :environment - # Errors reported for this deployment. Populated only when state == ERROR. - # This field is not populated in List APIs. + # Errors reported for this deployment. Populated only when state == ERROR. This + # field is not populated in List APIs. # Corresponds to the JSON property `errors` # @return [Array] attr_accessor :errors - # Status reported by each runtime instance. - # This field is not populated in List APIs. + # Status reported by each runtime instance. This field is not populated in List + # APIs. # Corresponds to the JSON property `instances` # @return [Array] attr_accessor :instances - # Status reported by runtime pods. This field is not populated for List - # APIs. + # Status reported by runtime pods. This field is not populated for List APIs. # Corresponds to the JSON property `pods` # @return [Array] attr_accessor :pods @@ -1729,17 +1643,16 @@ module Google attr_accessor :revision # Conflicts in the desired state routing configuration. The presence of - # conflicts does not cause the state to be ERROR, but it will mean that - # some of the deployments basepaths are not routed to its environment. If - # the conflicts change, the state will transition to PROGRESSING until the - # latest configuration is rolled out to all instances. - # This field is not populated in List APIs. + # conflicts does not cause the state to be ERROR, but it will mean that some of + # the deployments basepaths are not routed to its environment. If the conflicts + # change, the state will transition to PROGRESSING until the latest + # configuration is rolled out to all instances. This field is not populated in + # List APIs. # Corresponds to the JSON property `routeConflicts` # @return [Array] attr_accessor :route_conflicts - # Current state of the deployment. - # This field is not populated in List APIs. + # Current state of the deployment. This field is not populated in List APIs. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -1763,22 +1676,18 @@ module Google end end - # Response for - # GenerateDeployChangeReport - # and - # GenerateUndeployChangeReport. - # This report contains any validation failures that would cause the deployment - # to be rejected, as well changes and conflicts in routing that may occur due - # to the new deployment. - # The existence of a routing warning does not necessarily imply that the - # deployment request is bad, if the desired state of the deployment request is - # to effect a routing change. The primary purposes of the routing messages are: - # 1) To inform users of routing changes that may have an effect on traffic - # currently being routed to other existing deployments. - # 2) To warn users if some basepath in the proxy will not receive traffic due - # to an existing deployment having already claimed that basepath. - # The presence of routing conflicts/changes will not cause non-dry-run - # DeployApiProxy/UndeployApiProxy requests to be rejected. + # Response for GenerateDeployChangeReport and GenerateUndeployChangeReport. This + # report contains any validation failures that would cause the deployment to be + # rejected, as well changes and conflicts in routing that may occur due to the + # new deployment. The existence of a routing warning does not necessarily imply + # that the deployment request is bad, if the desired state of the deployment + # request is to effect a routing change. The primary purposes of the routing + # messages are: 1) To inform users of routing changes that may have an effect on + # traffic currently being routed to other existing deployments. 2) To warn users + # if some basepath in the proxy will not receive traffic due to an existing + # deployment having already claimed that basepath. The presence of routing + # conflicts/changes will not cause non-dry-run DeployApiProxy/UndeployApiProxy + # requests to be rejected. class GoogleCloudApigeeV1DeploymentChangeReport include Google::Apis::Core::Hashable @@ -1792,10 +1701,9 @@ module Google # @return [Array] attr_accessor :routing_conflicts - # Describes what preconditions have failed. - # For example, if an RPC failed because it required the Terms of Service to be - # acknowledged, it could list the terms of service violation in the - # PreconditionFailure message. + # Describes what preconditions have failed. For example, if an RPC failed + # because it required the Terms of Service to be acknowledged, it could list the + # terms of service violation in the PreconditionFailure message. # Corresponds to the JSON property `validationErrors` # @return [Google::Apis::ApigeeV1::GoogleRpcPreconditionFailure] attr_accessor :validation_errors @@ -1812,8 +1720,8 @@ module Google end end - # Describes a potential routing change that may occur as a result - # of some deployment operation. + # Describes a potential routing change that may occur as a result of some + # deployment operation. class GoogleCloudApigeeV1DeploymentChangeReportRoutingChange include Google::Apis::Core::Hashable @@ -1832,9 +1740,9 @@ module Google # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeploymentChangeReportRoutingDeployment] attr_accessor :from_deployment - # True if using sequenced rollout would make this routing change safer. - # Note: this does not necessarily imply that automated sequenced rollout - # mode is supported for the operation. + # True if using sequenced rollout would make this routing change safer. Note: + # this does not necessarily imply that automated sequenced rollout mode is + # supported for the operation. # Corresponds to the JSON property `shouldSequenceRollout` # @return [Boolean] attr_accessor :should_sequence_rollout @@ -1937,8 +1845,8 @@ module Google # @return [Hash] attr_accessor :attributes - # Base path where the application needs to be hosted. Default value is - # assumed to be "/". + # Base path where the application needs to be hosted. Default value is assumed + # to be "/". # Corresponds to the JSON property `basePath` # @return [String] attr_accessor :base_path @@ -1949,8 +1857,8 @@ module Google attr_accessor :location # The name of the API or shared flow revision to be deployed. Must be of the - # form 'organizations/`org`/apis/`api`/revisions/`rev`' or - # 'organizations/`org`/sharedflows/`sf`/revisions/`rev`'. + # form 'organizations/`org`/apis/`api`/revisions/`rev`' or 'organizations/`org`/ + # sharedflows/`sf`/revisions/`rev`'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1960,8 +1868,7 @@ module Google # @return [String] attr_accessor :proxy_uid - # A unique id that will only change if the deployment is deleted and - # recreated. + # A unique id that will only change if the deployment is deleted and recreated. # Corresponds to the JSON property `uid` # @return [String] attr_accessor :uid @@ -2011,22 +1918,20 @@ module Google # @return [Array] attr_accessor :companies - # Output only. Time at which the developer was created in milliseconds - # since epoch. + # Output only. Time at which the developer was created in milliseconds since + # epoch. # Corresponds to the JSON property `createdAt` # @return [Fixnum] attr_accessor :created_at - # ID of the developer. - # **Note**: IDs are generated internally by Apigee and are not - # guaranteed to stay the same over time. + # ID of the developer. **Note**: IDs are generated internally by Apigee and are + # not guaranteed to stay the same over time. # Corresponds to the JSON property `developerId` # @return [String] attr_accessor :developer_id # Required. Email address of the developer. This value is used to uniquely - # identify - # the developer in Apigee hybrid. + # identify the developer in Apigee hybrid. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email @@ -2036,8 +1941,8 @@ module Google # @return [String] attr_accessor :first_name - # Output only. Time at which the developer was last modified in - # milliseconds since epoch. + # Output only. Time at which the developer was last modified in milliseconds + # since epoch. # Corresponds to the JSON property `lastModifiedAt` # @return [Fixnum] attr_accessor :last_modified_at @@ -2131,10 +2036,9 @@ module Google # @return [String] attr_accessor :developer_id - # Expiration time, in milliseconds, for the consumer key that - # is generated for the developer app. If not set or left to the default - # value of `-1`, the API key never expires. - # The expiration time can't be updated after it is set. + # Expiration time, in milliseconds, for the consumer key that is generated for + # the developer app. If not set or left to the default value of `-1`, the API + # key never expires. The expiration time can't be updated after it is set. # Corresponds to the JSON property `keyExpiresIn` # @return [Fixnum] attr_accessor :key_expires_in @@ -2149,9 +2053,8 @@ module Google # @return [String] attr_accessor :name - # Scopes to apply to the developer app. The specified scopes must - # already exist for the API product that you associate with the developer - # app. + # Scopes to apply to the developer app. The specified scopes must already exist + # for the API product that you associate with the developer app. # Corresponds to the JSON property `scopes` # @return [Array] attr_accessor :scopes @@ -2187,11 +2090,10 @@ module Google class GoogleCloudApigeeV1DeveloperAppKey include Google::Apis::Core::Hashable - # List of API products for which the credential can be used. - # **Note**: Do not specify the list of API products when creating a consumer - # key and secret for a developer app. Instead, use the - # UpdateDeveloperAppKey API to - # make the association after the consumer key and secret are created. + # List of API products for which the credential can be used. **Note**: Do not + # specify the list of API products when creating a consumer key and secret for a + # developer app. Instead, use the UpdateDeveloperAppKey API to make the + # association after the consumer key and secret are created. # Corresponds to the JSON property `apiProducts` # @return [Array] attr_accessor :api_products @@ -2221,8 +2123,8 @@ module Google # @return [Fixnum] attr_accessor :issued_at - # Scopes to apply to the app. The specified scope names must already - # be defined for the API product that you associate with the app. + # Scopes to apply to the app. The specified scope names must already be defined + # for the API product that you associate with the app. # Corresponds to the JSON property `scopes` # @return [Array] attr_accessor :scopes @@ -2283,8 +2185,8 @@ module Google # @return [Fixnum] attr_accessor :created_at - # Time at which the API proxy was most recently modified, in milliseconds - # since epoch. + # Time at which the API proxy was most recently modified, in milliseconds since + # epoch. # Corresponds to the JSON property `lastModifiedAt` # @return [Fixnum] attr_accessor :last_modified_at @@ -2325,14 +2227,14 @@ module Google # @return [String] attr_accessor :display_name - # Output only. Last modification time of this environment as milliseconds - # since epoch. + # Output only. Last modification time of this environment as milliseconds since + # epoch. # Corresponds to the JSON property `lastModifiedAt` # @return [Fixnum] attr_accessor :last_modified_at - # Required. Name of the environment. Values must match the - # regular expression `^[.\\p`Alnum`-_]`1,255`$` + # Required. Name of the environment. Values must match the regular expression `^[ + # .\\p`Alnum`-_]`1,255`$` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2397,15 +2299,15 @@ module Google # @return [Array] attr_accessor :keystores - # The name of the environment config. Must be of the form - # 'organizations/`org`/environments/`env`/configs/`config_id` + # The name of the environment config. Must be of the form 'organizations/`org`/ + # environments/`env`/configs/`config_id` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # This field can be used by the control plane to add some context - # information about itself. This information could help detect the source of - # the document during diagnostics and debugging. + # This field can be used by the control plane to add some context information + # about itself. This information could help detect the source of the document + # during diagnostics and debugging. # Corresponds to the JSON property `provider` # @return [String] attr_accessor :provider @@ -2425,9 +2327,8 @@ module Google # @return [Array] attr_accessor :resources - # Revision id that defines the ordering on the environment config. - # The higher the revision, the more recently the configuration - # was deployed. + # Revision id that defines the ordering on the environment config. The higher + # the revision, the more recently the configuration was deployed. # Corresponds to the JSON property `revisionId` # @return [Fixnum] attr_accessor :revision_id @@ -2437,8 +2338,8 @@ module Google # @return [Fixnum] attr_accessor :sequence_number - # A list of target servers in the environment. Disabled target servers are - # not included. + # A list of target servers in the environment. Disabled target servers are not + # included. # Corresponds to the JSON property `targets` # @return [Array] attr_accessor :targets @@ -2480,8 +2381,7 @@ module Google include Google::Apis::Core::Hashable # Output only. The time at which the environment group was created as - # milliseconds since - # epoch. + # milliseconds since epoch. # Corresponds to the JSON property `createdAt` # @return [Fixnum] attr_accessor :created_at @@ -2492,8 +2392,7 @@ module Google attr_accessor :hostnames # Output only. The time at which the environment group was last updated as - # milliseconds - # since epoch. + # milliseconds since epoch. # Corresponds to the JSON property `lastModifiedAt` # @return [Fixnum] attr_accessor :last_modified_at @@ -2549,8 +2448,8 @@ module Google end end - # EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and - # its associated routing rules. + # EnvironmentGroupConfig is a revisioned snapshot of an EnvironmentGroup and its + # associated routing rules. class GoogleCloudApigeeV1EnvironmentGroupConfig include Google::Apis::Core::Hashable @@ -2559,27 +2458,26 @@ module Google # @return [Array] attr_accessor :hostnames - # Name of the environment group in the following format: - # `organizations/`org`/envgroups/`envgroup``. + # Name of the environment group in the following format: `organizations/`org`/ + # envgroups/`envgroup``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Revision id that defines the ordering of the EnvironmentGroupConfig - # resource. The higher the revision, the more recently the - # configuration was deployed. + # Revision id that defines the ordering of the EnvironmentGroupConfig resource. + # The higher the revision, the more recently the configuration was deployed. # Corresponds to the JSON property `revisionId` # @return [Fixnum] attr_accessor :revision_id - # Ordered list of routing rules defining how traffic to this environment - # group's hostnames should be routed to different environments. + # Ordered list of routing rules defining how traffic to this environment group's + # hostnames should be routed to different environments. # Corresponds to the JSON property `routingRules` # @return [Array] attr_accessor :routing_rules - # A unique id for the environment group config that will only change if - # the environment group is deleted and recreated. + # A unique id for the environment group config that will only change if the + # environment group is deleted and recreated. # Corresponds to the JSON property `uid` # @return [String] attr_accessor :uid @@ -2622,10 +2520,9 @@ module Google # @return [String] attr_accessor :error - # Output only. Execution time for this export job. - # If the job is still in progress, it will be set to the amount of time that - # has elapsed since`created`, in seconds. - # Else, it will set to (`updated` - `created`), in seconds. + # Output only. Execution time for this export job. If the job is still in + # progress, it will be set to the amount of time that has elapsed since`created`, + # in seconds. Else, it will set to (`updated` - `created`), in seconds. # Corresponds to the JSON property `executionTime` # @return [String] attr_accessor :execution_time @@ -2635,17 +2532,15 @@ module Google # @return [String] attr_accessor :name - # Output only. Self link of the export job. - # A URI that can be used to retrieve the status of an export job. - # Example: - # `/organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6- - # ae6f-318d0cb961bd` + # Output only. Self link of the export job. A URI that can be used to retrieve + # the status of an export job. Example: `/organizations/myorg/environments/myenv/ + # analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` # Corresponds to the JSON property `self` # @return [String] attr_accessor :self - # Output only. Status of the export job. - # Valid values include `enqueued`, `running`, `completed`, and `failed`. + # Output only. Status of the export job. Valid values include `enqueued`, ` + # running`, `completed`, and `failed`. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -2677,10 +2572,9 @@ module Google class GoogleCloudApigeeV1ExportRequest include Google::Apis::Core::Hashable - # Optional. Delimiter used in the CSV file, if `outputFormat` is set - # to `csv`. Defaults to the `,` (comma) character. - # Supported delimiter characters include comma (`,`), pipe (`|`), - # and tab (`\t`). + # Optional. Delimiter used in the CSV file, if `outputFormat` is set to `csv`. + # Defaults to the `,` (comma) character. Supported delimiter characters include + # comma (`,`), pipe (`|`), and tab (`\t`). # Corresponds to the JSON property `csvDelimiter` # @return [String] attr_accessor :csv_delimiter @@ -2705,10 +2599,9 @@ module Google # @return [String] attr_accessor :name - # Optional. Output format of the export. - # Valid values include: `csv` or `json`. Defaults to `json`. - # Note: Configure the delimiter for CSV output using the `csvDelimiter` - # property. + # Optional. Output format of the export. Valid values include: `csv` or `json`. + # Defaults to `json`. Note: Configure the delimiter for CSV output using the ` + # csvDelimiter` property. # Corresponds to the JSON property `outputFormat` # @return [String] attr_accessor :output_format @@ -2733,10 +2626,8 @@ module Google include Google::Apis::Core::Hashable # Optional. Flag that specifies whether execution should continue if the flow - # hook - # throws an exception. Set to `true` to continue execution. Set to - # `false` to stop execution if the flow hook throws an exception.Defaults - # to `true`. + # hook throws an exception. Set to `true` to continue execution. Set to `false` + # to stop execution if the flow hook throws an exception.Defaults to `true`. # Corresponds to the JSON property `continueOnError` # @return [Boolean] attr_accessor :continue_on_error @@ -2748,9 +2639,8 @@ module Google attr_accessor :description # Output only. Where in the API call flow the flow hook is invoked. Must be one - # of - # `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, or - # `PostTargetFlowHook`. + # of `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, or ` + # PostTargetFlowHook`. # Corresponds to the JSON property `flowHookPoint` # @return [String] attr_accessor :flow_hook_point @@ -2777,23 +2667,22 @@ module Google class GoogleCloudApigeeV1FlowHookConfig include Google::Apis::Core::Hashable - # Should the flow abort after an error in the flow hook. - # Should default to true if unset. + # Should the flow abort after an error in the flow hook. Should default to true + # if unset. # Corresponds to the JSON property `continueOnError` # @return [Boolean] attr_accessor :continue_on_error alias_method :continue_on_error?, :continue_on_error - # The name of the flow hook. Must be of the form - # 'organizations/`org`/environments/`env`/flowhooks/`point`'. - # Known points are PreProxyFlowHook, PostProxyFlowHook, PreTargetFlowHook, - # and PostTargetFlowHook + # The name of the flow hook. Must be of the form 'organizations/`org`/ + # environments/`env`/flowhooks/`point`'. Known points are PreProxyFlowHook, + # PostProxyFlowHook, PreTargetFlowHook, and PostTargetFlowHook # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The name of the shared flow to invoke. Must be of the form - # 'organizations/`org`/sharedflows/`sharedflow`'. + # The name of the shared flow to invoke. Must be of the form 'organizations/`org` + # /sharedflows/`sharedflow`'. # Corresponds to the JSON property `sharedFlowName` # @return [String] attr_accessor :shared_flow_name @@ -2810,8 +2699,7 @@ module Google end end - # Request for - # GetSyncAuthorization. + # Request for GetSyncAuthorization. class GoogleCloudApigeeV1GetSyncAuthorizationRequest include Google::Apis::Core::Hashable @@ -2833,8 +2721,8 @@ module Google # @return [Array] attr_accessor :environment_groups - # Name of the resource in the following format: - # `organizations/`org`/deployedIngressConfig`. + # Name of the resource in the following format: `organizations/`org`/ + # deployedIngressConfig`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2844,15 +2732,14 @@ module Google # @return [String] attr_accessor :revision_create_time - # Revision id that defines the ordering on IngressConfig resources. - # The higher the revision, the more recently the configuration - # was deployed. + # Revision id that defines the ordering on IngressConfig resources. The higher + # the revision, the more recently the configuration was deployed. # Corresponds to the JSON property `revisionId` # @return [Fixnum] attr_accessor :revision_id - # A unique id for the ingress config that will only change if the - # organization is deleted and recreated. + # A unique id for the ingress config that will only change if the organization + # is deleted and recreated. # Corresponds to the JSON property `uid` # @return [String] attr_accessor :uid @@ -2897,8 +2784,7 @@ module Google attr_accessor :display_name # Output only. Hostname or IP address of the exposed Apigee endpoint used by - # clients to - # connect to the service. + # clients to connect to the service. # Corresponds to the JSON property `host` # @return [String] attr_accessor :host @@ -2913,8 +2799,8 @@ module Google # @return [String] attr_accessor :location - # Required. Resource ID of the instance. Values must match the - # regular expression `^a-z`0,30`[a-z\d]$`. + # Required. Resource ID of the instance. Values must match the regular + # expression `^a-z`0,30`[a-z\d]$`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3078,8 +2964,8 @@ module Google # @return [String] attr_accessor :alias_id - # The reference name. Must be of the form: - # organizations/`org`/environments/`env`/references/`ref`. + # The reference name. Must be of the form: organizations/`org`/environments/`env` + # /references/`ref`. # Corresponds to the JSON property `reference` # @return [String] attr_accessor :reference @@ -3130,8 +3016,8 @@ module Google # @return [Array] attr_accessor :aliases - # Required. The resource ID for this keystore. Values must match the - # regular expression `[\w[:space:]-.]`1,255``. + # Required. The resource ID for this keystore. Values must match the regular + # expression `[\w[:space:]-.]`1,255``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3156,9 +3042,8 @@ module Google # @return [Array] attr_accessor :aliases - # The resource name. Must be of the - # form: - # 'organizations/`org`/environments/`env`/keystores/`keystore`'. + # The resource name. Must be of the form: 'organizations/`org`/environments/`env` + # /keystores/`keystore`'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3292,14 +3177,14 @@ module Google class GoogleCloudApigeeV1ListDebugSessionsResponse include Google::Apis::Core::Hashable - # Page token that you can include in a ListDebugSessionsRequest to - # retrieve the next page. If omitted, no subsequent pages exist. + # Page token that you can include in a ListDebugSessionsRequest to retrieve the + # next page. If omitted, no subsequent pages exist. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # Session info that includes debug session ID and the first transaction - # creation timestamp. + # Session info that includes debug session ID and the first transaction creation + # timestamp. # Corresponds to the JSON property `sessions` # @return [Array] attr_accessor :sessions @@ -3353,8 +3238,7 @@ module Google end end - # Response for - # ListEnvironmentGroupAttachments. + # Response for ListEnvironmentGroupAttachments. class GoogleCloudApigeeV1ListEnvironmentGroupAttachmentsResponse include Google::Apis::Core::Hashable @@ -3363,8 +3247,8 @@ module Google # @return [Array] attr_accessor :environment_group_attachments - # Page token that you can include in a ListEnvironmentGroupAttachments - # request to retrieve the next page. If omitted, no subsequent pages exist. + # Page token that you can include in a ListEnvironmentGroupAttachments request + # to retrieve the next page. If omitted, no subsequent pages exist. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -3380,8 +3264,7 @@ module Google end end - # Response for - # ListEnvironmentGroups. + # Response for ListEnvironmentGroups. class GoogleCloudApigeeV1ListEnvironmentGroupsResponse include Google::Apis::Core::Hashable @@ -3390,8 +3273,8 @@ module Google # @return [Array] attr_accessor :environment_groups - # Page token that you can include in a ListEnvironmentGroups request to - # retrieve the next page. If omitted, no subsequent pages exist. + # Page token that you can include in a ListEnvironmentGroups request to retrieve + # the next page. If omitted, no subsequent pages exist. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -3407,8 +3290,7 @@ module Google end end - # Response for - # ListEnvironmentResources + # Response for ListEnvironmentResources class GoogleCloudApigeeV1ListEnvironmentResourcesResponse include Google::Apis::Core::Hashable @@ -3465,8 +3347,7 @@ module Google end end - # Response for - # ListInstanceAttachments. + # Response for ListInstanceAttachments. class GoogleCloudApigeeV1ListInstanceAttachmentsResponse include Google::Apis::Core::Hashable @@ -3501,8 +3382,8 @@ module Google # @return [Array] attr_accessor :instances - # Page token that you can include in a ListInstance request to retrieve - # the next page of content. If omitted, no subsequent pages exist. + # Page token that you can include in a ListInstance request to retrieve the next + # page of content. If omitted, no subsequent pages exist. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -3584,15 +3465,10 @@ module Google # @return [Array] attr_accessor :errors - # List of additional information such as data source, if result was - # truncated etc. - # E.g - # "notices": [ - # "Source:Postgres", - # "PG Host:uappg0rw.e2e.apigeeks.net", - # "query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", - # "Table used: edge.api.uapgroup2.agg_api" - # ] + # List of additional information such as data source, if result was truncated + # etc. E.g "notices": [ "Source:Postgres", "PG Host:uappg0rw.e2e.apigeeks.net", " + # query served by:4b64601e-40de-4eb1-bfb9-eeee7ac929ed", "Table used: edge.api. + # uapgroup2.agg_api" ] # Corresponds to the JSON property `notices` # @return [Array] attr_accessor :notices @@ -3608,24 +3484,10 @@ module Google end end - # This message type encapsulates the metric data point. - # Example: - # ` - # "name": "sum(message_count)", - # "values" : [ ` - # "timestamp": 1549004400000, - # "value": "39.0" - # `, - # ` - # "timestamp" : 1548997200000, - # "value" : "0.0" - # ` ] - # ` - # or - # ` - # "name": "sum(message_count)", - # "values" : ["39.0"] - # ` + # This message type encapsulates the metric data point. Example: ` "name": "sum( + # message_count)", "values" : [ ` "timestamp": 1549004400000, "value": "39.0" `, + # ` "timestamp" : 1548997200000, "value" : "0.0" ` ] ` or ` "name": "sum( + # message_count)", "values" : ["39.0"] ` class GoogleCloudApigeeV1Metric include Google::Apis::Core::Hashable @@ -3634,10 +3496,8 @@ module Google # @return [String] attr_accessor :name - # List of metric values. - # Possible value format: - # "values":["39.0"] or - # "values":[ ` "value": "39.0", "timestamp": 1232434354` ] + # List of metric values. Possible value format: "values":["39.0"] or "values":[ ` + # "value": "39.0", "timestamp": 1232434354` ] # Corresponds to the JSON property `values` # @return [Array] attr_accessor :values @@ -3703,37 +3563,12 @@ module Google end end - # This message type encapsulates a data node as represented below: - # ` - # "identifier": ` - # "names": [ - # "apiproxy" - # ], - # "values": [ - # "sirjee" - # ] - # `, - # "metric": [ - # ` - # "env": "prod", - # "name": "sum(message_count)", - # "values": [ - # 36.0 - # ] - # ` - # ] - # ` - # OR - # ` - # "env": "prod", - # "name": "sum(message_count)", - # "values": [ - # 36.0 - # ] - # ` - # Depending on whether a dimension is present in the query or not - # the data node type can be a simple metric value or dimension identifier - # with list of metrics. + # This message type encapsulates a data node as represented below: ` "identifier" + # : ` "names": [ "apiproxy" ], "values": [ "sirjee" ] `, "metric": [ ` "env": " + # prod", "name": "sum(message_count)", "values": [ 36.0 ] ` ] ` OR ` "env": " + # prod", "name": "sum(message_count)", "values": [ 36.0 ] ` Depending on whether + # a dimension is present in the query or not the data node type can be a simple + # metric value or dimension identifier with list of metrics. class GoogleCloudApigeeV1OptimizedStatsNode include Google::Apis::Core::Hashable @@ -3756,8 +3591,8 @@ module Google class GoogleCloudApigeeV1OptimizedStatsResponse include Google::Apis::Core::Hashable - # This field contains a list of time unit values. Time unit refers to - # an epoch timestamp value. + # This field contains a list of time unit values. Time unit refers to an epoch + # timestamp value. # Corresponds to the JSON property `TimeUnit` # @return [Array] attr_accessor :time_unit @@ -3767,44 +3602,19 @@ module Google # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Metadata] attr_accessor :meta_data - # This ia a boolean field to indicate if the results were truncated - # based on the limit parameter. + # This ia a boolean field to indicate if the results were truncated based on the + # limit parameter. # Corresponds to the JSON property `resultTruncated` # @return [Boolean] attr_accessor :result_truncated alias_method :result_truncated?, :result_truncated - # This message type encapsulates a data node as represented below: - # ` - # "identifier": ` - # "names": [ - # "apiproxy" - # ], - # "values": [ - # "sirjee" - # ] - # `, - # "metric": [ - # ` - # "env": "prod", - # "name": "sum(message_count)", - # "values": [ - # 36.0 - # ] - # ` - # ] - # ` - # OR - # ` - # "env": "prod", - # "name": "sum(message_count)", - # "values": [ - # 36.0 - # ] - # ` - # Depending on whether a dimension is present in the query or not - # the data node type can be a simple metric value or dimension identifier - # with list of metrics. + # This message type encapsulates a data node as represented below: ` "identifier" + # : ` "names": [ "apiproxy" ], "values": [ "sirjee" ] `, "metric": [ ` "env": " + # prod", "name": "sum(message_count)", "values": [ 36.0 ] ` ] ` OR ` "env": " + # prod", "name": "sum(message_count)", "values": [ 36.0 ] ` Depending on whether + # a dimension is present in the query or not the data node type can be a simple + # metric value or dimension identifier with list of metrics. # Corresponds to the JSON property `stats` # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1OptimizedStatsNode] attr_accessor :stats @@ -3827,8 +3637,8 @@ module Google include Google::Apis::Core::Hashable # Required. Primary GCP region for analytics data storage. For valid values, see - # [Create an - # organization](https://docs.apigee.com/hybrid/latest/precog-provision). + # [Create an organization](https://docs.apigee.com/hybrid/latest/precog- + # provision). # Corresponds to the JSON property `analyticsRegion` # @return [String] attr_accessor :analytics_region @@ -3838,15 +3648,12 @@ module Google # @return [Array] attr_accessor :attributes - # Compute Engine network used for ServiceNetworking to - # be peered with Apigee runtime instances. See - # [Getting started with the Service Networking - # API](https://cloud.google.com/service-infrastructure/docs/service-networking/ - # getting-started). - # Valid only when [RuntimeType] is set to CLOUD. The value can be updated - # only when there are no runtime instances. - # For example: "default". - # **Note:** Not supported for Apigee hybrid. + # Compute Engine network used for ServiceNetworking to be peered with Apigee + # runtime instances. See [Getting started with the Service Networking API](https: + # //cloud.google.com/service-infrastructure/docs/service-networking/getting- + # started). Valid only when [RuntimeType] is set to CLOUD. The value can be + # updated only when there are no runtime instances. For example: "default". ** + # Note:** Not supported for Apigee hybrid. # Corresponds to the JSON property `authorizedNetwork` # @return [String] attr_accessor :authorized_network @@ -3885,8 +3692,7 @@ module Google attr_accessor :environments # Output only. Time that the Apigee organization was last modified in - # milliseconds - # since epoch. + # milliseconds since epoch. # Corresponds to the JSON property `lastModifiedAt` # @return [Fixnum] attr_accessor :last_modified_at @@ -3908,17 +3714,15 @@ module Google attr_accessor :properties # Output only. Runtime type of the Apigee organization based on the Apigee - # subscription - # purchased. + # subscription purchased. # Corresponds to the JSON property `runtimeType` # @return [String] attr_accessor :runtime_type # Output only. Subscription type of the Apigee organization. Valid values - # include trial - # (free, limited, and for evaluation purposes only) or paid (full - # subscription has been purchased). See - # [Apigee pricing](https://cloud.google.com/apigee/pricing/). + # include trial (free, limited, and for evaluation purposes only) or paid (full + # subscription has been purchased). See [Apigee pricing](https://cloud.google. + # com/apigee/pricing/). # Corresponds to the JSON property `subscriptionType` # @return [String] attr_accessor :subscription_type @@ -3987,11 +3791,8 @@ module Google # @return [String] attr_accessor :app_version - # Status of the deployment. Valid values - # include: - # - `deployed`: Successful. - # - `error` : Failed. - # - `pending` : Pod has not yet reported on the deployment. + # Status of the deployment. Valid values include: - `deployed`: Successful. - ` + # error` : Failed. - `pending` : Pod has not yet reported on the deployment. # Corresponds to the JSON property `deploymentStatus` # @return [String] attr_accessor :deployment_status @@ -4011,12 +3812,9 @@ module Google # @return [String] attr_accessor :pod_name - # Overall status of the pod (not this specific deployment). Valid values - # include: - # - `active`: Up to date. - # - `stale` : Recently out of date. - # Pods that have not reported status in a - # long time are excluded from the output. + # Overall status of the pod (not this specific deployment). Valid values include: + # - `active`: Up to date. - `stale` : Recently out of date. Pods that have not + # reported status in a long time are excluded from the output. # Corresponds to the JSON property `podStatus` # @return [String] attr_accessor :pod_status @@ -4055,34 +3853,14 @@ module Google end # Point is a group of information collected by runtime plane at critical points - # of the message flow of the processed API request. - # This is a list of supported point IDs, categorized to three major buckets. - # For each category, debug points that we are currently supporting are listed - # below: - # - Flow status debug points: - # StateChange - # FlowInfo - # Condition - # Execution - # DebugMask - # Error - # - Flow control debug points: - # FlowCallout - # Paused - # Resumed - # FlowReturn - # BreakFlow - # Error - # - Runtime debug points: - # ScriptExecutor - # FlowCalloutStepDefinition - # CustomTarget - # StepDefinition - # Oauth2ServicePoint - # RaiseFault - # NodeJS - # The detail information of the given debug point is stored in a list of - # results. + # of the message flow of the processed API request. This is a list of supported + # point IDs, categorized to three major buckets. For each category, debug points + # that we are currently supporting are listed below: - Flow status debug points: + # StateChange FlowInfo Condition Execution DebugMask Error - Flow control debug + # points: FlowCallout Paused Resumed FlowReturn BreakFlow Error - Runtime debug + # points: ScriptExecutor FlowCalloutStepDefinition CustomTarget StepDefinition + # Oauth2ServicePoint RaiseFault NodeJS The detail information of the given debug + # point is stored in a list of results. class GoogleCloudApigeeV1Point include Google::Apis::Core::Hashable @@ -4156,41 +3934,36 @@ module Google class GoogleCloudApigeeV1Query include Google::Apis::Core::Hashable - # Delimiter used in the CSV file, if `outputFormat` is set - # to `csv`. Defaults to the `,` (comma) character. - # Supported delimiter characters include comma (`,`), pipe (`|`), - # and tab (`\t`). + # Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to + # the `,` (comma) character. Supported delimiter characters include comma (`,`), + # pipe (`|`), and tab (`\t`). # Corresponds to the JSON property `csvDelimiter` # @return [String] attr_accessor :csv_delimiter - # A list of dimensions. - # https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions + # A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics- + # reference#dimensions # Corresponds to the JSON property `dimensions` # @return [Array] attr_accessor :dimensions - # Boolean expression that can be used to filter data. - # Filter expressions can be combined using AND/OR terms and should be fully - # parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and - # filters reference - # https://docs.apigee.com/api-platform/analytics/analytics-reference - # for more information on the fields available to filter - # on. For more information on the tokens that you use to build filter - # expressions, see Filter expression syntax. + # Boolean expression that can be used to filter data. Filter expressions can be + # combined using AND/OR terms and should be fully parenthesized to avoid + # ambiguity. See Analytics metrics, dimensions, and filters reference https:// + # docs.apigee.com/api-platform/analytics/analytics-reference for more + # information on the fields available to filter on. For more information on the + # tokens that you use to build filter expressions, see Filter expression syntax. # https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter- # expression-syntax # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter - # Time unit used to group the result set. - # Valid values include: second, minute, hour, day, week, or month. - # If a query includes groupByTimeUnit, then the result is an aggregation - # based on the specified time unit and the resultant timestamp does not - # include milliseconds precision. - # If a query omits groupByTimeUnit, then the resultant timestamp includes - # milliseconds precision. + # Time unit used to group the result set. Valid values include: second, minute, + # hour, day, week, or month. If a query includes groupByTimeUnit, then the + # result is an aggregation based on the specified time unit and the resultant + # timestamp does not include milliseconds precision. If a query omits + # groupByTimeUnit, then the resultant timestamp includes milliseconds precision. # Corresponds to the JSON property `groupByTimeUnit` # @return [String] attr_accessor :group_by_time_unit @@ -4210,9 +3983,8 @@ module Google # @return [String] attr_accessor :name - # Valid values include: `csv` or `json`. Defaults to `json`. - # Note: Configure the delimiter for CSV output using the csvDelimiter - # property. + # Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the + # delimiter for CSV output using the csvDelimiter property. # Corresponds to the JSON property `outputFormat` # @return [String] attr_accessor :output_format @@ -4222,18 +3994,11 @@ module Google # @return [String] attr_accessor :report_definition_id - # Required. Time range for the query. - # Can use the following predefined strings to specify the time range: - # `last60minutes` - # `last24hours` - # `last7days` - # Or, specify the timeRange as a structure describing start and end - # timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. - # Example: - # "timeRange": ` - # "start": "2018-07-29T00:13:00Z", - # "end": "2018-08-01T00:18:00Z" - # ` + # Required. Time range for the query. Can use the following predefined strings + # to specify the time range: `last60minutes` `last24hours` `last7days` Or, + # specify the timeRange as a structure describing start and end timestamps in + # the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": ` "start": "2018- + # 07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" ` # Corresponds to the JSON property `timeRange` # @return [Object] attr_accessor :time_range @@ -4271,8 +4036,8 @@ module Google # @return [String] attr_accessor :end_timestamp - # Metrics of the AsyncQuery. - # Example: ["name:message_count,func:sum,alias:sum_message_count"] + # Metrics of the AsyncQuery. Example: ["name:message_count,func:sum,alias: + # sum_message_count"] # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics @@ -4307,13 +4072,13 @@ module Google end end - # More info about Metric: - # https://docs.apigee.com/api-platform/analytics/analytics-reference#metrics + # More info about Metric: https://docs.apigee.com/api-platform/analytics/ + # analytics-reference#metrics class GoogleCloudApigeeV1QueryMetric include Google::Apis::Core::Hashable - # Alias for the metric. Alias will be used to replace metric name - # in query results. + # Alias for the metric. Alias will be used to replace metric name in query + # results. # Corresponds to the JSON property `alias` # @return [String] attr_accessor :alias @@ -4352,8 +4117,8 @@ module Google end end - # A Reference configuration. References must refer to a keystore - # that also exists in the parent environment. + # A Reference configuration. References must refer to a keystore that also + # exists in the parent environment. class GoogleCloudApigeeV1Reference include Google::Apis::Core::Hashable @@ -4362,21 +4127,21 @@ module Google # @return [String] attr_accessor :description - # Required. The resource id of this reference. Values must match the - # regular expression [\w\s\-.]+. + # Required. The resource id of this reference. Values must match the regular + # expression [\w\s\-.]+. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The id of the resource to which this reference refers. - # Must be the id of a resource that exists in the parent environment and is - # of the given resource_type. + # Required. The id of the resource to which this reference refers. Must be the + # id of a resource that exists in the parent environment and is of the given + # resource_type. # Corresponds to the JSON property `refers` # @return [String] attr_accessor :refers - # The type of resource referred to by this reference. Valid values - # are 'KeyStore' or 'TrustStore'. + # The type of resource referred to by this reference. Valid values are 'KeyStore' + # or 'TrustStore'. # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -4398,15 +4163,15 @@ module Google class GoogleCloudApigeeV1ReferenceConfig include Google::Apis::Core::Hashable - # The name of the reference. Must be of the form - # 'organizations/`org`/environments/`env`/references/`ref`'. + # The name of the reference. Must be of the form 'organizations/`org`/ + # environments/`env`/references/`ref`'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The name of the referred resource. Only references to keystore resources - # are supported. Must be of the form - # 'organizations/`org`/environments/`env`/keystores/`ks`'. + # The name of the referred resource. Only references to keystore resources are + # supported. Must be of the form 'organizations/`org`/environments/`env`/ + # keystores/`ks`'. # Corresponds to the JSON property `resourceName` # @return [String] attr_accessor :resource_name @@ -4426,15 +4191,15 @@ module Google class GoogleCloudApigeeV1ReportInstanceStatusRequest include Google::Apis::Core::Hashable - # A unique ID for the instance which is guaranteed to be unique in case the - # user installs multiple hybrid runtimes with the same instance ID. + # A unique ID for the instance which is guaranteed to be unique in case the user + # installs multiple hybrid runtimes with the same instance ID. # Corresponds to the JSON property `instanceUid` # @return [String] attr_accessor :instance_uid # The time the report was generated in the runtime. Used to prevent an old - # status from overwriting a newer one. An instance should space out it's - # status reports so that clock skew does not play a factor. + # status from overwriting a newer one. An instance should space out it's status + # reports so that clock skew does not play a factor. # Corresponds to the JSON property `reportTime` # @return [String] attr_accessor :report_time @@ -4503,10 +4268,9 @@ module Google # @return [String] attr_accessor :location - # The resource name. Only environment-scoped resource files are supported. - # Must be of the form - # 'organizations/`org`/environments/`env`/resourcefiles/`type`/`file`/revisions/` - # rev`'. + # The resource name. Only environment-scoped resource files are supported. Must + # be of the form 'organizations/`org`/environments/`env`/resourcefiles/`type`/` + # file`/revisions/`rev`'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4571,8 +4335,7 @@ module Google include Google::Apis::Core::Hashable # The resource name. Currently only two resources are supported: - # EnvironmentGroup - organizations/`org`/envgroups/`envgroup` - # EnvironmentConfig - + # EnvironmentGroup - organizations/`org`/envgroups/`envgroup` EnvironmentConfig - # organizations/`org`/environments/`environment`/deployedConfig # Corresponds to the JSON property `resource` # @return [String] @@ -4588,8 +4351,8 @@ module Google # @return [Fixnum] attr_accessor :total_replicas - # The uid of the resource. In the unexpected case that the instance has - # multiple uids for the same name, they should be reported under separate + # The uid of the resource. In the unexpected case that the instance has multiple + # uids for the same name, they should be reported under separate # ResourceStatuses. # Corresponds to the JSON property `uid` # @return [String] @@ -4608,52 +4371,43 @@ module Google end end - # Result is short for "action result", could be different types identified by - # "action_result" field. Supported types: - # 1. DebugInfo : generic debug info collected by runtime recorded as a list of - # properties. For example, the contents could be virtual host info, state - # change result, or execution metadata. Required fields : properties, timestamp - # 2. RequestMessage: information of a http request. Contains headers, request - # URI and http methods type.Required fields : headers, uri, verb - # 3. ResponseMessage: information of a http response. Contains headers, reason - # phrase and http status code. Required fields : headers, reasonPhrase, - # statusCode - # 4. ErrorMessage: information of a http error message. Contains detail error - # message, reason phrase and status code. Required fields : content, headers, - # reasonPhrase, statusCode - # 5. VariableAccess: a list of variable access actions, can be Get, Set and - # Remove. Required fields : accessList + # Result is short for "action result", could be different types identified by " + # action_result" field. Supported types: 1. DebugInfo : generic debug info + # collected by runtime recorded as a list of properties. For example, the + # contents could be virtual host info, state change result, or execution + # metadata. Required fields : properties, timestamp 2. RequestMessage: + # information of a http request. Contains headers, request URI and http methods + # type.Required fields : headers, uri, verb 3. ResponseMessage: information of a + # http response. Contains headers, reason phrase and http status code. Required + # fields : headers, reasonPhrase, statusCode 4. ErrorMessage: information of a + # http error message. Contains detail error message, reason phrase and status + # code. Required fields : content, headers, reasonPhrase, statusCode 5. + # VariableAccess: a list of variable access actions, can be Get, Set and Remove. + # Required fields : accessList class GoogleCloudApigeeV1Result include Google::Apis::Core::Hashable - # Type of the action result. Can be one of the five: DebugInfo, - # RequestMessage, ResponseMessage, ErrorMessage, VariableAccess + # Type of the action result. Can be one of the five: DebugInfo, RequestMessage, + # ResponseMessage, ErrorMessage, VariableAccess # Corresponds to the JSON property `ActionResult` # @return [String] attr_accessor :action_result - # A list of variable access actions agaist the api proxy. - # Supported values: Get, Set, Remove. + # A list of variable access actions agaist the api proxy. Supported values: Get, + # Set, Remove. # Corresponds to the JSON property `accessList` # @return [Array] attr_accessor :access_list - # Error message content. for example, - # "content" : "`\"fault\":`\"faultstring\":\"API timed - # out\",\"detail\":`\"errorcode\":\"flow.APITimedOut\"```" + # Error message content. for example, "content" : "`\"fault\":`\"faultstring\":\" + # API timed out\",\"detail\":`\"errorcode\":\"flow.APITimedOut\"```" # Corresponds to the JSON property `content` # @return [String] attr_accessor :content - # A list of HTTP headers. - # for example, - # '"headers" : [ ` - # "name" : "Content-Length", - # "value" : "83" - # `, ` - # "name" : "Content-Type", - # "value" : "application/json" - # ` ]' + # A list of HTTP headers. for example, '"headers" : [ ` "name" : "Content-Length" + # , "value" : "83" `, ` "name" : "Content-Type", "value" : "application/json" ` ] + # ' # Corresponds to the JSON property `headers` # @return [Array] attr_accessor :headers @@ -4674,14 +4428,13 @@ module Google # @return [String] attr_accessor :status_code - # Timestamp of when the result is recorded. Its format is dd-mm-yy - # hh:mm:ss:xxx. For example, `"timestamp" : "12-08-19 00:31:59:960"` + # Timestamp of when the result is recorded. Its format is dd-mm-yy hh:mm:ss:xxx. + # For example, `"timestamp" : "12-08-19 00:31:59:960"` # Corresponds to the JSON property `timestamp` # @return [String] attr_accessor :timestamp - # The relative path of the api proxy. - # for example, `"uRI" : "/iloveapis"` + # The relative path of the api proxy. for example, `"uRI" : "/iloveapis"` # Corresponds to the JSON property `uRI` # @return [String] attr_accessor :u_ri @@ -4751,15 +4504,15 @@ module Google class GoogleCloudApigeeV1RoutingRule include Google::Apis::Core::Hashable - # URI path prefix used to route to the specified environment. May contain - # one or more wildcards. For example, path segments consisting of a single - # `*` character will match any string. + # URI path prefix used to route to the specified environment. May contain one or + # more wildcards. For example, path segments consisting of a single `*` + # character will match any string. # Corresponds to the JSON property `basepath` # @return [String] attr_accessor :basepath - # Name of an environment bound to the environment group in the following - # format: `organizations/`org`/environments/`env``. + # Name of an environment bound to the environment group in the following format: + # `organizations/`org`/environments/`env``. # Corresponds to the JSON property `environment` # @return [String] attr_accessor :environment @@ -4784,14 +4537,14 @@ module Google # @return [Array] attr_accessor :dimensions - # Additional metadata associated with schema. This is - # a legacy field and usually consists of an empty array of strings. + # Additional metadata associated with schema. This is a legacy field and usually + # consists of an empty array of strings. # Corresponds to the JSON property `meta` # @return [Array] attr_accessor :meta - # List of schema fields grouped as dimensions. These are fields - # that can be used with an aggregate function such as sum, avg, min, max. + # List of schema fields grouped as dimensions. These are fields that can be used + # with an aggregate function such as sum, avg, min, max. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics @@ -4842,8 +4595,8 @@ module Google # @return [String] attr_accessor :create_time - # Custom is a flag signifying if the field was provided as - # part of the standard dataset or a custom field created by the customer + # Custom is a flag signifying if the field was provided as part of the standard + # dataset or a custom field created by the customer # Corresponds to the JSON property `custom` # @return [String] attr_accessor :custom @@ -5009,8 +4762,8 @@ module Google # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ResourceFiles] attr_accessor :resource_files - # A list of the resources included in this shared flow revision formatted as - # "`type`://`name`". + # A list of the resources included in this shared flow revision formatted as "` + # type`://`name`". # Corresponds to the JSON property `resources` # @return [Array] attr_accessor :resources @@ -5078,20 +4831,9 @@ module Google end end - # This message type encapsulates the environment wrapper: - # "environments": [ - # ` - # "metrics": [ - # ` - # "name": "sum(message_count)", - # "values": [ - # "2.52056245E8" - # ] - # ` - # ], - # "name": "prod" - # ` - # ] + # This message type encapsulates the environment wrapper: "environments": [ ` " + # metrics": [ ` "name": "sum(message_count)", "values": [ "2.52056245E8" ] ` ], " + # name": "prod" ` ] class GoogleCloudApigeeV1StatsEnvironmentStats include Google::Apis::Core::Hashable @@ -5100,45 +4842,15 @@ module Google # @return [Array] attr_accessor :dimensions - # In the final response, only one of the following fields will be present - # based on the dimensions provided. If no dimensions are provided, then - # only a top level metrics is provided. If dimensions are included, then - # there will be a top level dimensions field under environments which will - # contain metrics values and the dimension name. - # Example: - # "environments": [ - # ` - # "dimensions": [ - # ` - # "metrics": [ - # ` - # "name": "sum(message_count)", - # "values": [ - # "2.14049521E8" - # ] - # ` - # ], - # "name": "nit_proxy" - # ` - # ], - # "name": "prod" - # ` - # ] - # OR - # "environments": [ - # ` - # "metrics": [ - # ` - # "name": "sum(message_count)", - # "values": [ - # "2.19026331E8" - # ] - # ` - # ], - # "name": "prod" - # ` - # ] - # This field contains the list of metric values. + # In the final response, only one of the following fields will be present based + # on the dimensions provided. If no dimensions are provided, then only a top + # level metrics is provided. If dimensions are included, then there will be a + # top level dimensions field under environments which will contain metrics + # values and the dimension name. Example: "environments": [ ` "dimensions": [ ` " + # metrics": [ ` "name": "sum(message_count)", "values": [ "2.14049521E8" ] ` ], " + # name": "nit_proxy" ` ], "name": "prod" ` ] OR "environments": [ ` "metrics": [ + # ` "name": "sum(message_count)", "values": [ "2.19026331E8" ] ` ], "name": " + # prod" ` ] This field contains the list of metric values. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics @@ -5165,8 +4877,7 @@ module Google include Google::Apis::Core::Hashable # Full name of the Pub/Sub subcription. Use the following structure in your - # request: - # `subscription "projects/foo/subscription/bar"` + # request: `subscription "projects/foo/subscription/bar"` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -5186,33 +4897,28 @@ module Google include Google::Apis::Core::Hashable # Entity tag (ETag) used for optimistic concurrency control as a way to help - # prevent simultaneous updates from overwriting each other. - # For example, when you call [getSyncAuthorization](getSyncAuthorization) - # an ETag is returned in the response. Pass that ETag when calling - # the [setSyncAuthorization](setSyncAuthorization) to ensure - # that you are updating the correct version. If you don't pass the - # ETag in the call to `setSyncAuthorization`, then the - # existing authorization is overwritten indiscriminately. - # **Note**: We strongly recommend that you use the ETag in the - # read-modify-write cycle to avoid race conditions. + # prevent simultaneous updates from overwriting each other. For example, when + # you call [getSyncAuthorization](getSyncAuthorization) an ETag is returned in + # the response. Pass that ETag when calling the [setSyncAuthorization]( + # setSyncAuthorization) to ensure that you are updating the correct version. If + # you don't pass the ETag in the call to `setSyncAuthorization`, then the + # existing authorization is overwritten indiscriminately. **Note**: We strongly + # recommend that you use the ETag in the read-modify-write cycle to avoid race + # conditions. # Corresponds to the JSON property `etag` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :etag - # Required. Array of service accounts to grant access to control plane - # resources, each specified using the following - # format: `serviceAccount:`service-account-name. - # The service-account-name is formatted like an email address. For - # example: - # `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` - # You might specify multiple service accounts, for example, if you have - # multiple environments and wish to assign a unique service account to each - # one. - # The service accounts must have **Apigee Synchronizer Manager** role. - # See also [Create service - # accounts](https://docs.apigee.com/hybrid/latest/sa-about#create-the-service- - # accounts). + # Required. Array of service accounts to grant access to control plane resources, + # each specified using the following format: `serviceAccount:` service-account- + # name. The service-account-name is formatted like an email address. For example: + # `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount. + # com` You might specify multiple service accounts, for example, if you have + # multiple environments and wish to assign a unique service account to each one. + # The service accounts must have **Apigee Synchronizer Manager** role. See also [ + # Create service accounts](https://docs.apigee.com/hybrid/latest/sa-about#create- + # the-service-accounts). # Corresponds to the JSON property `identities` # @return [Array] attr_accessor :identities @@ -5244,16 +4950,16 @@ module Google # @return [String] attr_accessor :host - # Optional. Enabling/disabling a TargetServer is useful when TargetServers - # are used in load balancing configurations, and one or more TargetServers - # need to taken out of rotation periodically. Defaults to true. + # Optional. Enabling/disabling a TargetServer is useful when TargetServers are + # used in load balancing configurations, and one or more TargetServers need to + # taken out of rotation periodically. Defaults to true. # Corresponds to the JSON property `isEnabled` # @return [Boolean] attr_accessor :is_enabled alias_method :is_enabled?, :is_enabled - # Required. The resource id of this target server. Values must match the - # regular expression + # Required. The resource id of this target server. Values must match the regular + # expression # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -5264,9 +4970,7 @@ module Google # @return [Fixnum] attr_accessor :port - # TLS configuration information for - # VirtualHosts and - # TargetServers. + # TLS configuration information for VirtualHosts and TargetServers. # Corresponds to the JSON property `sSLInfo` # @return [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TlsInfo] attr_accessor :s_sl_info @@ -5295,8 +4999,8 @@ module Google # @return [String] attr_accessor :host - # The target server revision name. Must be of the form - # 'organizations/`org`/environments/`env`/targetservers/`ts_id`/revisions/`rev`'. + # The target server revision name. Must be of the form 'organizations/`org`/ + # environments/`env`/targetservers/`ts_id`/revisions/`rev`'. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -5349,16 +5053,13 @@ module Google end end - # TLS configuration information for - # VirtualHosts and - # TargetServers. + # TLS configuration information for VirtualHosts and TargetServers. class GoogleCloudApigeeV1TlsInfo include Google::Apis::Core::Hashable # The SSL/TLS cipher suites to be used. Must be one of the cipher suite names - # listed in: - # http://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames. - # html#ciphersuites + # listed in: http://docs.oracle.com/javase/8/docs/technotes/guides/security/ + # StandardNames.html#ciphersuites # Corresponds to the JSON property `ciphers` # @return [Array] attr_accessor :ciphers @@ -5380,26 +5081,25 @@ module Google attr_accessor :enabled alias_method :enabled?, :enabled - # If true, Edge ignores TLS certificate errors. Valid when configuring TLS - # for target servers and target endpoints, and when configuring virtual hosts - # that use 2-way TLS. - # When used with a target endpoint/target server, if the backend system uses - # SNI and returns a cert with a subject Distinguished Name (DN) that does not - # match the hostname, there is no way to ignore the error and the connection - # fails. + # If true, Edge ignores TLS certificate errors. Valid when configuring TLS for + # target servers and target endpoints, and when configuring virtual hosts that + # use 2-way TLS. When used with a target endpoint/target server, if the backend + # system uses SNI and returns a cert with a subject Distinguished Name (DN) that + # does not match the hostname, there is no way to ignore the error and the + # connection fails. # Corresponds to the JSON property `ignoreValidationErrors` # @return [Boolean] attr_accessor :ignore_validation_errors alias_method :ignore_validation_errors?, :ignore_validation_errors - # Required if `client_auth_enabled` is true. The resource ID for the - # alias containing the private key and cert. + # Required if `client_auth_enabled` is true. The resource ID for the alias + # containing the private key and cert. # Corresponds to the JSON property `keyAlias` # @return [String] attr_accessor :key_alias - # Required if `client_auth_enabled` is true. The resource ID of the - # keystore. References not yet supported. + # Required if `client_auth_enabled` is true. The resource ID of the keystore. + # References not yet supported. # Corresponds to the JSON property `keyStore` # @return [String] attr_accessor :key_store @@ -5409,8 +5109,7 @@ module Google # @return [Array] attr_accessor :protocols - # The resource ID of the truststore. - # References not yet supported. + # The resource ID of the truststore. References not yet supported. # Corresponds to the JSON property `trustStore` # @return [String] attr_accessor :trust_store @@ -5507,10 +5206,10 @@ module Google # @return [Array] attr_accessor :protocols - # The name of the Keystore or keystore reference containing trusted - # certificates for the server. It must be of either the form - # organizations/`org`/environments/`env`/keystores/`keystore` or - # organizations/`org`/environments/`env`/references/`reference`. + # The name of the Keystore or keystore reference containing trusted certificates + # for the server. It must be of either the form organizations/`org`/environments/ + # `env`/keystores/`keystore` or organizations/`org`/environments/`env`/ + # references/`reference`. # Corresponds to the JSON property `trustStore` # @return [String] attr_accessor :trust_store @@ -5553,8 +5252,8 @@ module Google # @return [String] attr_accessor :resource - # A string that uniquely identifies the type of error. This provides a - # more reliable means to deduplicate errors across revisions and instances. + # A string that uniquely identifies the type of error. This provides a more + # reliable means to deduplicate errors across revisions and instances. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -5572,53 +5271,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 GoogleIamV1AuditConfig include Google::Apis::Core::Hashable @@ -5627,9 +5294,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 @@ -5645,28 +5312,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 GoogleIamV1AuditLogConfig 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] @@ -5692,69 +5346,57 @@ module Google class GoogleIamV1Binding 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::ApigeeV1::GoogleTypeExpr] 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 @@ -5772,66 +5414,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 GoogleIamV1Policy include Google::Apis::Core::Hashable @@ -5840,48 +5448,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 @@ -5904,74 +5508,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::ApigeeV1::GoogleIamV1Policy] 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 @@ -5991,10 +5560,9 @@ module Google class GoogleIamV1TestIamPermissionsRequest 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 @@ -6013,8 +5581,7 @@ module Google class GoogleIamV1TestIamPermissionsResponse 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 @@ -6059,47 +5626,45 @@ module Google class GoogleLongrunningOperation 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::ApigeeV1::GoogleRpcStatus] 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 @@ -6118,13 +5683,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 @@ -6137,10 +5700,9 @@ module Google end end - # Describes what preconditions have failed. - # For example, if an RPC failed because it required the Terms of Service to be - # acknowledged, it could list the terms of service violation in the - # PreconditionFailure message. + # Describes what preconditions have failed. For example, if an RPC failed + # because it required the Terms of Service to be acknowledged, it could list the + # terms of service violation in the PreconditionFailure message. class GoogleRpcPreconditionFailure include Google::Apis::Core::Hashable @@ -6164,22 +5726,22 @@ module Google include Google::Apis::Core::Hashable # A description of how the precondition failed. Developers can use this - # description to understand how to fix the failure. - # For example: "Terms of service not accepted". + # description to understand how to fix the failure. For example: "Terms of + # service not accepted". # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # The subject, relative to the type, that failed. - # For example, "google.com/cloud" relative to the "TOS" type would indicate - # which terms of service is being referenced. + # The subject, relative to the type, that failed. For example, "google.com/cloud" + # relative to the "TOS" type would indicate which terms of service is being + # referenced. # Corresponds to the JSON property `subject` # @return [String] attr_accessor :subject - # The type of PreconditionFailure. We recommend using a service-specific - # enum type to define the supported precondition violation subjects. For - # example, "TOS" for "Terms of Service violation". + # The type of PreconditionFailure. We recommend using a service-specific enum + # type to define the supported precondition violation subjects. For example, " + # TOS" for "Terms of Service violation". # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -6196,12 +5758,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 GoogleRpcStatus include Google::Apis::Core::Hashable @@ -6210,15 +5772,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 @@ -6235,52 +5797,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 GoogleTypeExpr 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 diff --git a/generated/google/apis/apigee_v1/service.rb b/generated/google/apis/apigee_v1/service.rb index b7c48eeb9..f43bc2cf9 100644 --- a/generated/google/apis/apigee_v1/service.rb +++ b/generated/google/apis/apigee_v1/service.rb @@ -23,12 +23,11 @@ module Google # Apigee API # # The Apigee API lets you programmatically manage Apigee hybrid with a set of - # RESTful operations, including:
  • Create, edit, and delete API proxies
  • Manage users
  • Deploy and undeploy proxy revisions
  • - # Configure environments

For information on using the APIs described - # in this section, see - # Get started using the APIs.

Note: This product is - # available as a free trial for a time period of 60 days. + # RESTful operations, including: - Create, edit, and delete API proxies - Manage + # users - Deploy and undeploy proxy revisions - Configure environments For + # information on using the APIs described in this section, see Get started using + # the APIs. *Note:* This product is available as a free trial for a time period + # of 60 days. # # @example # require 'google/apis/apigee_v1' @@ -53,10 +52,9 @@ module Google @batch_path = 'batch' end - # Lists hybrid services and its trusted issuers service account ids. - # This api is authenticated and unauthorized(allow all the users) and used by - # runtime authn-authz service to query control plane's issuer service account - # ids. + # Lists hybrid services and its trusted issuers service account ids. This api is + # authenticated and unauthorized(allow all the users) and used by runtime authn- + # authz service to query control plane's issuer service account ids. # @param [String] name # Required. Must be of the form `hybrid/issuers`. # @param [String] fields @@ -86,16 +84,13 @@ module Google execute_or_queue_command(command, &block) end - # Creates an Apigee organization. See - # [Create an - # organization](https://docs.apigee.com/hybrid/latest/precog-provision). + # Creates an Apigee organization. See [Create an organization](https://docs. + # apigee.com/hybrid/latest/precog-provision). # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization] google_cloud_apigee_v1_organization_object # @param [String] parent # Required. Name of the GCP project in which to associate the Apigee - # organization. - # Pass the information as a query parameter using the following structure - # in your request: - # `projects/` + # organization. Pass the information as a query parameter using the following + # structure in your request: `projects/` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -125,13 +120,11 @@ module Google execute_or_queue_command(command, &block) end - # Gets the profile for an Apigee organization. - # See - # [Organizations](https://docs.apigee.com/hybrid/latest/terminology# - # organizations). + # Gets the profile for an Apigee organization. See [Organizations](https://docs. + # apigee.com/hybrid/latest/terminology#organizations). # @param [String] name - # Required. Apigee organization name in the following format: - # `organizations/`org`` + # Required. Apigee organization name in the following format: `organizations/` + # org`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -162,8 +155,7 @@ module Google # Gets the deployed ingress configuration for an organization. # @param [String] name # Required. Name of the deployed configuration for the organization in the - # following - # format: 'organizations/`org`/deployedIngressConfig'. + # following format: 'organizations/`org`/deployedIngressConfig'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -191,22 +183,18 @@ module Google execute_or_queue_command(command, &block) end - # Lists the service accounts with the permissions required to allow - # the Synchronizer to download environment data from the control plane. - # An ETag is returned in the response to `getSyncAuthorization`. - # Pass that ETag when calling [setSyncAuthorization](setSyncAuthorization) - # to ensure that you are updating the correct version. If you don't pass the - # ETag in the call to `setSyncAuthorization`, then the existing authorization - # is overwritten indiscriminately. - # For more information, see - # [Enable Synchronizer - # access](https://docs.apigee.com/hybrid/latest/synchronizer-access#enable- - # synchronizer-access). - # **Note**: Available to Apigee hybrid only. + # Lists the service accounts with the permissions required to allow the + # Synchronizer to download environment data from the control plane. An ETag is + # returned in the response to `getSyncAuthorization`. Pass that ETag when + # calling [setSyncAuthorization](setSyncAuthorization) to ensure that you are + # updating the correct version. If you don't pass the ETag in the call to ` + # setSyncAuthorization`, then the existing authorization is overwritten + # indiscriminately. For more information, see [Enable Synchronizer access](https: + # //docs.apigee.com/hybrid/latest/synchronizer-access#enable-synchronizer-access) + # . **Note**: Available to Apigee hybrid only. # @param [String] name # Required. Name of the Apigee organization. Use the following structure in your - # request: - # `organizations/`org`` + # request: `organizations/`org`` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1GetSyncAuthorizationRequest] google_cloud_apigee_v1_get_sync_authorization_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -238,12 +226,10 @@ module Google end # Lists the Apigee organizations and associated GCP projects that you have - # permission to access. See - # [Organizations](https://docs.apigee.com/hybrid/latest/terminology# - # organizations). + # permission to access. See [Organizations](https://docs.apigee.com/hybrid/ + # latest/terminology#organizations). # @param [String] parent - # Required. Use the following structure in your request: - # `organizations` + # Required. Use the following structure in your request: `organizations` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -273,21 +259,16 @@ module Google # Sets the permissions required to allow the Synchronizer to download # environment data from the control plane. You must call this API to enable - # proper functioning of hybrid. - # Pass the ETag when calling `setSyncAuthorization` to ensure that - # you are updating the correct version. To get an ETag, - # call [getSyncAuthorization](getSyncAuthorization). - # If you don't pass the ETag in the call to `setSyncAuthorization`, then the - # existing authorization is overwritten indiscriminately. - # For more information, see - # [Enable Synchronizer - # access](https://docs.apigee.com/hybrid/latest/synchronizer-access#enable- - # synchronizer-access). - # **Note**: Available to Apigee hybrid only. + # proper functioning of hybrid. Pass the ETag when calling `setSyncAuthorization` + # to ensure that you are updating the correct version. To get an ETag, call [ + # getSyncAuthorization](getSyncAuthorization). If you don't pass the ETag in the + # call to `setSyncAuthorization`, then the existing authorization is overwritten + # indiscriminately. For more information, see [Enable Synchronizer access](https: + # //docs.apigee.com/hybrid/latest/synchronizer-access#enable-synchronizer-access) + # . **Note**: Available to Apigee hybrid only. # @param [String] name # Required. Name of the Apigee organization. Use the following structure in your - # request: - # `organizations/`org`` + # request: `organizations/`org`` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1SyncAuthorization] google_cloud_apigee_v1_sync_authorization_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -321,8 +302,8 @@ module Google # Updates the properties for an Apigee organization. No other fields in the # organization profile will be updated. # @param [String] name - # Required. Apigee organization name in the following format: - # `organizations/`org`` + # Required. Apigee organization name in the following format: `organizations/` + # org`` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Organization] google_cloud_apigee_v1_organization_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -355,8 +336,8 @@ module Google # Create a Datastore for an org # @param [String] parent - # Required. The parent organization name. - # Must be of the form `organizations/`org``. + # Required. The parent organization name. Must be of the form `organizations/` + # org``. # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore] google_cloud_apigee_v1_datastore_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -389,8 +370,8 @@ module Google # Delete a Datastore from an org. # @param [String] name - # Required. Resource name of the Datastore to be deleted. Must be of the - # form `organizations/`org`/analytics/datastores/`datastoreId`` + # Required. Resource name of the Datastore to be deleted. Must be of the form ` + # organizations/`org`/analytics/datastores/`datastoreId`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -420,8 +401,8 @@ module Google # Get a Datastore # @param [String] name - # Required. Resource name of the Datastore to be get. Must be of the - # form `organizations/`org`/analytics/datastores/`datastoreId`` + # Required. Resource name of the Datastore to be get. Must be of the form ` + # organizations/`org`/analytics/datastores/`datastoreId`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -451,8 +432,8 @@ module Google # List Datastores # @param [String] parent - # Required. The parent organization name. - # Must be of the form `organizations/`org``. + # Required. The parent organization name. Must be of the form `organizations/` + # org``. # @param [String] target_type # Optional. TargetType is used to fetch all Datastores that match the type # @param [String] fields @@ -483,12 +464,12 @@ module Google execute_or_queue_command(command, &block) end - # Test if Datastore configuration is correct. This includes checking - # if credentials provided by customer have required permissions in target + # Test if Datastore configuration is correct. This includes checking if + # credentials provided by customer have required permissions in target # destination storage # @param [String] parent - # Required. The parent organization name - # Must be of the form `organizations/`org`` + # Required. The parent organization name Must be of the form `organizations/`org` + # ` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore] google_cloud_apigee_v1_datastore_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -521,8 +502,8 @@ module Google # Update a Datastore # @param [String] name - # Required. The resource name of datastore to be updated. Must be of the - # form `organizations/`org`/analytics/datastores/`datastoreId`` + # Required. The resource name of datastore to be updated. Must be of the form ` + # organizations/`org`/analytics/datastores/`datastoreId`` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Datastore] google_cloud_apigee_v1_datastore_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -553,20 +534,19 @@ module Google execute_or_queue_command(command, &block) end - # Updates or creates API product attributes. This API **replaces** the - # current list of attributes with the attributes specified in the request - # body. In this way, you can update existing attributes, add new attributes, - # or delete existing attributes by omitting them from the request body. - # OAuth access tokens and Key Management Service (KMS) entities (apps, - # developers, and API products) are cached for 180 seconds (current default). - # Any custom attributes associated with entities also get cached for at least - # 180 seconds after entity is accessed during runtime. - # In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able - # to expire an access token in less than 180 seconds. + # Updates or creates API product attributes. This API **replaces** the current + # list of attributes with the attributes specified in the request body. In this + # way, you can update existing attributes, add new attributes, or delete + # existing attributes by omitting them from the request body. OAuth access + # tokens and Key Management Service (KMS) entities (apps, developers, and API + # products) are cached for 180 seconds (current default). Any custom attributes + # associated with entities also get cached for at least 180 seconds after entity + # is accessed during runtime. In this case, the `ExpiresIn` element on the + # OAuthV2 policy won't be able to expire an access token in less than 180 + # seconds. # @param [String] name - # **Required.** API product name in the following form: - # 

organizations/organization_ID/apiproducts/
-        #   api_product_name
+ # **Required.** API product name in the following form: organizations/ + # organization_ID/apiproducts/api_product_name # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] google_cloud_apigee_v1_attributes_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -597,38 +577,25 @@ module Google execute_or_queue_command(command, &block) end - # Creates an API product in an organization. - # You create API products after - # you have proxied backend services using API proxies. - # An API product is a - # collection of API resources combined with quota settings and metadata that - # you can use to deliver customized and productized API bundles to your - # developer community. This metadata can include: - # - Scope - # - Environments - # - API proxies - # - Extensible profile - # API products enable you repackage APIs - # on-the-fly, without having to do any additional coding or configuration. - # Apigee recommends that you start with a simple API product including only - # required elements. You then provision credentials to apps to enable them to - # start testing your APIs. - # After you have authentication and authorization - # working against a simple API product, you can iterate to create finer - # grained API products, defining different sets of API resources for each API - # product. - # + # Creates an API product in an organization. You create API products after you + # have proxied backend services using API proxies. An API product is a + # collection of API resources combined with quota settings and metadata that you + # can use to deliver customized and productized API bundles to your developer + # community. This metadata can include: - Scope - Environments - API proxies - + # Extensible profile API products enable you repackage APIs on-the-fly, without + # having to do any additional coding or configuration. Apigee recommends that + # you start with a simple API product including only required elements. You then + # provision credentials to apps to enable them to start testing your APIs. After + # you have authentication and authorization working against a simple API product, + # you can iterate to create finer grained API products, defining different sets + # of API resources for each API product. *WARNING:* - If you don't specify an + # API proxy in the request body, *any* app associated with the product can make + # calls to *any* API in your entire organization. - If you don't specify an + # environment in the request body, the product allows access to all environments. # For more information, see ``what_api_product`` # @param [String] parent - # Required. The parent organization name under which the API product will - # be created. Must be in the following form: - # 
organizations/organization_ID
+ # Required. The parent organization name under which the API product will be + # created. Must be in the following form: organizations/organization_ID # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] google_cloud_apigee_v1_api_product_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -659,21 +626,17 @@ module Google execute_or_queue_command(command, &block) end - # Deletes an API product from an organization. - # Deleting an API product - # causes app requests to the resource URIs defined in the API product to - # fail. - # Ensure that you create a new API product to serve existing apps, unless - # your intention is to disable access to the resources defined in the API - # product. - # The API product name required in the request URL is the internal name of - # the product, not the display name. While they may be the same, it depends - # on whether the API product was created via the UI or the API. View the list - # of API products to verify the internal name. + # Deletes an API product from an organization. Deleting an API product causes + # app requests to the resource URIs defined in the API product to fail. Ensure + # that you create a new API product to serve existing apps, unless your + # intention is to disable access to the resources defined in the API product. + # The API product name required in the request URL is the internal name of the + # product, not the display name. While they may be the same, it depends on + # whether the API product was created via the UI or the API. View the list of + # API products to verify the internal name. # @param [String] name - # Required. API product name in the following form: - # 
organizations/organization_ID/apiproducts/
-        #   api_product_name
+ # Required. API product name in the following form: organizations/ + # organization_ID/apiproducts/api_product_name # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -701,15 +664,14 @@ module Google execute_or_queue_command(command, &block) end - # Gets configuration details for an API product. - # The API product name required in the request URL is the internal name of - # the product, not the display name. While they may be the same, it depends - # on whether the API product was created via the UI or the API. View the list - # of API products to verify the internal name. + # Gets configuration details for an API product. The API product name required + # in the request URL is the internal name of the product, not the display name. + # While they may be the same, it depends on whether the API product was created + # via the UI or the API. View the list of API products to verify the internal + # name. # @param [String] name - # **Required.** API product name in the following form: - # 
organizations/organization_ID/apiproducts/
-        #   api_product_name
+ # **Required.** API product name in the following form: organizations/ + # organization_ID/apiproducts/api_product_name # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -737,29 +699,28 @@ module Google execute_or_queue_command(command, &block) end - # Lists all API product names for an organization. - # Filter the list by passing an `attributename` and `attibutevalue`. - # The limit on the number of API products returned by the API is 1000. You - # can paginate the list of API products returned using the `startKey` and - # `count` query parameters. + # Lists all API product names for an organization. Filter the list by passing an + # `attributename` and `attibutevalue`. The limit on the number of API products + # returned by the API is 1000. You can paginate the list of API products + # returned using the `startKey` and `count` query parameters. # @param [String] parent # **Required.** The parent organization name in the following form: - # 
organizations/organization_ID
+ # organizations/organization_ID # @param [String] attributename # The name of the attribute to search. # @param [String] attributevalue # The value of the attribute. # @param [Fixnum] count - # Enter the number of API products you want returned in the API call. The - # limit is 1000. + # Enter the number of API products you want returned in the API call. The limit + # is 1000. # @param [Boolean] expand # Set to `true` to get expanded details about each API. # @param [String] start_key - # Gets a list of API products starting with a specific API product in the - # list. For example, if you're returning 50 API products at a time (using the - # `count` query parameter), you can view products 50-99 by entering the name - # of the 50th API product in the first API (without using `startKey`). - # Product name is case sensitive. + # Gets a list of API products starting with a specific API product in the list. + # For example, if you're returning 50 API products at a time (using the `count` + # query parameter), you can view products 50-99 by entering the name of the 50th + # API product in the first API (without using `startKey`). Product name is case + # sensitive. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -792,17 +753,15 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing API product. You must include all required values, - # whether or not you are updating them, as well as any optional values that - # you are updating. - # The API product name required in the request URL is the - # internal name of the product, not the Display Name. While they may be the - # same, it depends on whether the API product was created via UI or API. View - # the list of API products to identify their internal names. + # Updates an existing API product. You must include all required values, whether + # or not you are updating them, as well as any optional values that you are + # updating. The API product name required in the request URL is the internal + # name of the product, not the Display Name. While they may be the same, it + # depends on whether the API product was created via UI or API. View the list of + # API products to identify their internal names. # @param [String] name - # **Required.** API product name in the following form: - # 
organizations/organization_ID/apiproducts/
-        #   api_product_name
+ # **Required.** API product name in the following form: organizations/ + # organization_ID/apiproducts/api_product_name # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ApiProduct] google_cloud_apigee_v1_api_product_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -835,9 +794,8 @@ module Google # Deletes an API product attribute. # @param [String] name - # **Required.** API product name in the following form: - # 
organizations/organization_ID/apiproducts/
-        #   api_product_name/attributes/attribute_name
+ # **Required.** API product name in the following form: organizations/ + # organization_ID/apiproducts/api_product_name/attributes/attribute_name # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -867,9 +825,8 @@ module Google # Returns the value of an API product attribute. # @param [String] name - # **Required.** API product name in the following form: - # 
organizations/organization_ID/apiproducts/
-        #   api_product_name/attributes/attribute_name
+ # **Required.** API product name in the following form: organizations/ + # organization_ID/apiproducts/api_product_name/attributes/attribute_name # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -900,8 +857,7 @@ module Google # Returns a list of all API product attributes. # @param [String] parent # Required. The parent organization name. Must be in the following form: - # 
organizations/organization_ID/apiproducts/
-        #   api_product_name
+ # organizations/organization_ID/apiproducts/api_product_name # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -929,17 +885,16 @@ module Google execute_or_queue_command(command, &block) end - # Updates the value of an API product attribute. Limitations are: - # OAuth access tokens and Key Management Service (KMS) entities (apps, - # developers, and API products) are cached for 180 seconds (current default). - # Any custom attributes associated with entities also get cached for at least - # 180 seconds after entity is accessed during runtime. - # In this case, the `ExpiresIn` element on the OAuthV2 policy won't be able - # to expire an access token in less than 180 seconds. + # Updates the value of an API product attribute. Limitations are: OAuth access + # tokens and Key Management Service (KMS) entities (apps, developers, and API + # products) are cached for 180 seconds (current default). Any custom attributes + # associated with entities also get cached for at least 180 seconds after entity + # is accessed during runtime. In this case, the `ExpiresIn` element on the + # OAuthV2 policy won't be able to expire an access token in less than 180 + # seconds. # @param [String] name - # **Required.** API product name in the following form: - # 
organizations/organization_ID/apiproducts/
-        #   api_product_name
+ # **Required.** API product name in the following form: organizations/ + # organization_ID/apiproducts/api_product_name # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] google_cloud_apigee_v1_attribute_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -970,42 +925,34 @@ module Google execute_or_queue_command(command, &block) end - # Creates an API proxy. - # The API proxy created will not be accessible at runtime until it is - # deployed to an environment. - # Create a new API proxy by setting the `name` query parameter to the - # name of the API proxy. - # Import an API proxy configuration bundle stored in zip format - # on your local machine to your organization by doing the following: - # * Set the `name` query parameter to the name of the API proxy. - # * Set the `action` query parameter to `import`. - # * Set the `Content-Type` header to `multipart/form-data`. - # * Pass as a file the name of API proxy - # configuration bundle stored in zip format on your local machine using - # the `file` form field. - # **Note**: To validate the API proxy configuration bundle only - # without importing it, set the `action` query - # parameter to `validate`. - # When importing an API proxy configuration bundle, if the API proxy - # does not exist, it will be created. - # If the API proxy exists, then a new revision is created. Invalid API - # proxy configurations are rejected, and a list of validation errors is - # returned to the client. + # Creates an API proxy. The API proxy created will not be accessible at runtime + # until it is deployed to an environment. Create a new API proxy by setting the ` + # name` query parameter to the name of the API proxy. Import an API proxy + # configuration bundle stored in zip format on your local machine to your + # organization by doing the following: * Set the `name` query parameter to the + # name of the API proxy. * Set the `action` query parameter to `import`. * Set + # the `Content-Type` header to `multipart/form-data`. * Pass as a file the name + # of API proxy configuration bundle stored in zip format on your local machine + # using the `file` form field. **Note**: To validate the API proxy configuration + # bundle only without importing it, set the `action` query parameter to ` + # validate`. When importing an API proxy configuration bundle, if the API proxy + # does not exist, it will be created. If the API proxy exists, then a new + # revision is created. Invalid API proxy configurations are rejected, and a list + # of validation errors is returned to the client. # @param [String] parent - # Required. Name of the organization in the following format: - # `organizations/`org`` + # Required. Name of the organization in the following format: `organizations/` + # org`` # @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object # @param [String] action - # Action to perform when importing an API proxy configuration bundle. Set - # this parameter to one of the following values: - # * `import` to import the API proxy configuration bundle. - # * `validate` to validate the API proxy configuration bundle without - # importing it. + # Action to perform when importing an API proxy configuration bundle. Set this + # parameter to one of the following values: * `import` to import the API proxy + # configuration bundle. * `validate` to validate the API proxy configuration + # bundle without importing it. # @param [String] name # Name of the API proxy. Restrict the characters used to: A-Za-z0-9._- # @param [Boolean] validate - # Ignored. All uploads are validated regardless of the value of this - # field. Maintained for compatibility with Apigee Edge API. + # Ignored. All uploads are validated regardless of the value of this field. + # Maintained for compatibility with Apigee Edge API. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1041,8 +988,8 @@ module Google # Deletes an API proxy and all associated endpoints, policies, resources, and # revisions. The API proxy must be undeployed before you can delete it. # @param [String] name - # Required. Name of the API proxy in the following format: - # `organizations/`org`/apis/`api`` + # Required. Name of the API proxy in the following format: `organizations/`org`/ + # apis/`api`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1072,8 +1019,8 @@ module Google # Gets an API proxy including a list of existing revisions. # @param [String] name - # Required. Name of the API proxy in the following format: - # `organizations/`org`/apis/`api`` + # Required. Name of the API proxy in the following format: `organizations/`org`/ + # apis/`api`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1102,11 +1049,10 @@ module Google end # Lists the names of all API proxies in an organization. The names returned - # correspond to the names defined in the configuration files for each API - # proxy. + # correspond to the names defined in the configuration files for each API proxy. # @param [String] parent - # Required. Name of the organization in the following format: - # `organizations/`org`` + # Required. Name of the organization in the following format: `organizations/` + # org`` # @param [Boolean] include_meta_data # Flag that specifies whether to include API proxy metadata in the response. # @param [Boolean] include_revisions @@ -1143,9 +1089,7 @@ module Google # Lists all deployments of an API proxy. # @param [String] parent # Required. Name of the API proxy for which to return deployment information in - # the - # following format: - # `organizations/`org`/apis/`api`` + # the following format: `organizations/`org`/apis/`api`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1176,8 +1120,7 @@ module Google # Creates a key value map in an api proxy. # @param [String] parent # Required. The name of the environment in which to create the key value map. - # Must be of the form - # `organizations/`organization`/apis/`api``. + # Must be of the form `organizations/`organization`/apis/`api``. # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] google_cloud_apigee_v1_key_value_map_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1210,9 +1153,8 @@ module Google # Delete a key value map in an api proxy. # @param [String] name - # Required. The name of the key value map. - # Must be of the form - # `organizations/`organization`/apis/`api`/keyvaluemaps/`keyvaluemap``. + # Required. The name of the key value map. Must be of the form `organizations/` + # organization`/apis/`api`/keyvaluemaps/`keyvaluemap``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1240,12 +1182,12 @@ module Google execute_or_queue_command(command, &block) end - # Deletes an API proxy revision and all policies, resources, endpoints, - # and revisions associated with it. The API proxy revision must be undeployed - # before you can delete it. + # Deletes an API proxy revision and all policies, resources, endpoints, and + # revisions associated with it. The API proxy revision must be undeployed before + # you can delete it. # @param [String] name - # Required. API proxy revision in the following format: - # `organizations/`org`/apis/`api`/revisions/`rev`` + # Required. API proxy revision in the following format: `organizations/`org`/ + # apis/`api`/revisions/`rev`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1273,23 +1215,19 @@ module Google execute_or_queue_command(command, &block) end - # Gets an API proxy revision. - # To download the API proxy configuration bundle for the specified revision - # as a zip file, do the following: - # * Set the `format` query parameter to `bundle`. - # * Set the `Accept` header to `application/zip`. - # If you are using curl, specify `-o filename.zip` to save the output to a - # file; otherwise, it displays to `stdout`. Then, develop the API proxy - # configuration locally and upload the updated API proxy configuration - # revision, as described in - # [updateApiProxyRevision](updateApiProxyRevision). + # Gets an API proxy revision. To download the API proxy configuration bundle for + # the specified revision as a zip file, do the following: * Set the `format` + # query parameter to `bundle`. * Set the `Accept` header to `application/zip`. + # If you are using curl, specify `-o filename.zip` to save the output to a file; + # otherwise, it displays to `stdout`. Then, develop the API proxy configuration + # locally and upload the updated API proxy configuration revision, as described + # in [updateApiProxyRevision](updateApiProxyRevision). # @param [String] name - # Required. API proxy revision in the following format: - # `organizations/`org`/apis/`api`/revisions/`rev`` + # Required. API proxy revision in the following format: `organizations/`org`/ + # apis/`api`/revisions/`rev`` # @param [String] format - # Format used when downloading the API proxy configuration revision. - # Set to `bundle` to download the API proxy configuration revision as a zip - # file. + # Format used when downloading the API proxy configuration revision. Set to ` + # bundle` to download the API proxy configuration revision as a zip file. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1319,15 +1257,14 @@ module Google end # Updates an existing API proxy revision by uploading the API proxy - # configuration bundle as a zip file from your local machine. - # You can update only API proxy revisions - # that have never been deployed. After deployment, an API proxy revision - # becomes immutable, even if it is undeployed. - # Set the `Content-Type` header to either - # `multipart/form-data` or `application/octet-stream`. + # configuration bundle as a zip file from your local machine. You can update + # only API proxy revisions that have never been deployed. After deployment, an + # API proxy revision becomes immutable, even if it is undeployed. Set the ` + # Content-Type` header to either `multipart/form-data` or `application/octet- + # stream`. # @param [String] name - # Required. API proxy revision to update in the following format: - # `organizations/`org`/apis/`api`/revisions/`rev`` + # Required. API proxy revision to update in the following format: `organizations/ + # `org`/apis/`api`/revisions/`rev`` # @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object # @param [Boolean] validate # Ignored. All uploads are validated regardless of the value of this field. @@ -1365,9 +1302,8 @@ module Google # Lists all deployments of an API proxy revision. # @param [String] parent # Required. Name of the API proxy revision for which to return deployment - # information - # in the following format: - # `organizations/`org`/apis/`api`/revisions/`rev``. + # information in the following format: `organizations/`org`/apis/`api`/revisions/ + # `rev``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1397,8 +1333,7 @@ module Google # Gets the app profile for the specified app ID. # @param [String] name - # Required. App ID in the following format: - # `organizations/`org`/apps/`app`` + # Required. App ID in the following format: `organizations/`org`/apps/`app`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1426,35 +1361,33 @@ module Google execute_or_queue_command(command, &block) end - # Lists IDs of apps within an organization that have the specified app status - # (approved or revoked) or are of the specified app type - # (developer or company). + # Lists IDs of apps within an organization that have the specified app status ( + # approved or revoked) or are of the specified app type (developer or company). # @param [String] parent - # Required. Resource path of the parent in the following format: - # `organizations/`org`` + # Required. Resource path of the parent in the following format: `organizations/` + # org`` # @param [String] api_product # API product. # @param [String] apptype - # Optional. Filter by the type of the app. Valid values are `company` or - # `developer`. Defaults to `developer`. + # Optional. Filter by the type of the app. Valid values are `company` or ` + # developer`. Defaults to `developer`. # @param [Boolean] expand - # Optional. Flag that specifies whether to return an expanded list of - # apps for the organization. Defaults to `false`. + # Optional. Flag that specifies whether to return an expanded list of apps for + # the organization. Defaults to `false`. # @param [String] ids # Optional. Comma-separated list of app IDs on which to filter. # @param [Boolean] include_cred - # Optional. Flag that specifies whether to include credentials in the - # response. + # Optional. Flag that specifies whether to include credentials in the response. # @param [String] key_status - # Optional. Key status of the app. Valid values include `approved` or - # `revoked`. Defaults to `approved`. + # Optional. Key status of the app. Valid values include `approved` or `revoked`. + # Defaults to `approved`. # @param [Fixnum] rows # Optional. Maximum number of app IDs to return. Defaults to 10000. # @param [String] start_key # Returns the list of apps starting from the specified app ID. # @param [String] status - # Optional. Filter by the status of the app. Valid values are `approved` - # or `revoked`. Defaults to `approved`. + # Optional. Filter by the status of the app. Valid values are `approved` or ` + # revoked`. Defaults to `approved`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1494,13 +1427,10 @@ module Google # Lists all deployments of API proxies or shared flows. # @param [String] parent # Required. Name of the organization for which to return deployment information - # in the - # following format: - # `organizations/`org`` + # in the following format: `organizations/`org`` # @param [Boolean] shared_flows # Optional. Flag that specifies whether to return shared flow or API proxy - # deployments. - # Set to `true` to return shared flow deployments; set to `false` + # deployments. Set to `true` to return shared flow deployments; set to `false` # to return API proxy deployments. Defaults to `false`. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1530,24 +1460,19 @@ module Google execute_or_queue_command(command, &block) end - # Updates developer attributes. - # This API replaces the - # existing attributes with those specified in the request. - # Add new attributes, and include or exclude any existing - # attributes that you want to retain or - # remove, respectively. - # The custom attribute limit is 18. - # **Note**: OAuth access tokens and Key Management Service (KMS) entities - # (apps, developers, and API products) are cached for 180 seconds - # (default). Any custom attributes associated with these entities - # are cached for at least 180 seconds after the entity is accessed at - # runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy - # won't be able to expire an access token in less than 180 seconds. + # Updates developer attributes. This API replaces the existing attributes with + # those specified in the request. Add new attributes, and include or exclude any + # existing attributes that you want to retain or remove, respectively. The + # custom attribute limit is 18. **Note**: OAuth access tokens and Key Management + # Service (KMS) entities (apps, developers, and API products) are cached for 180 + # seconds (default). Any custom attributes associated with these entities are + # cached for at least 180 seconds after the entity is accessed at runtime. + # Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to + # expire an access token in less than 180 seconds. # @param [String] parent # Required. Email address of the developer for which attributes are being - # updated in - # the following format: - # `organizations/`org`/developers/`developer_email`` + # updated in the following format: `organizations/`org`/developers/` + # developer_email`` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] google_cloud_apigee_v1_attributes_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1578,14 +1503,12 @@ module Google execute_or_queue_command(command, &block) end - # Creates a developer. Once created, - # the developer can register an app and obtain an API key. - # At creation time, a developer is set as `active`. To change the developer - # status, use the SetDeveloperStatus API. + # Creates a developer. Once created, the developer can register an app and + # obtain an API key. At creation time, a developer is set as `active`. To change + # the developer status, use the SetDeveloperStatus API. # @param [String] parent # Required. Name of the Apigee organization in which the developer is created. - # Use the following structure in your request: - # `organizations/`org``. + # Use the following structure in your request: `organizations/`org``. # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] google_cloud_apigee_v1_developer_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1616,21 +1539,16 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a developer. All apps and API keys associated - # with the developer are also removed. - # **Warning**: This API will permanently delete the developer - # and related artifacts. - # To avoid permanently deleting developers and their artifacts, - # set the developer status to `inactive` using - # the SetDeveloperStatus API. - # **Note**: The delete operation is asynchronous. The developer app is - # deleted immediately, - # but its associated resources, such as apps and API keys, may take anywhere - # from a few seconds to a few minutes to be deleted. + # Deletes a developer. All apps and API keys associated with the developer are + # also removed. **Warning**: This API will permanently delete the developer and + # related artifacts. To avoid permanently deleting developers and their + # artifacts, set the developer status to `inactive` using the SetDeveloperStatus + # API. **Note**: The delete operation is asynchronous. The developer app is + # deleted immediately, but its associated resources, such as apps and API keys, + # may take anywhere from a few seconds to a few minutes to be deleted. # @param [String] name # Required. Email address of the developer. Use the following structure in your - # request: - # `organizations/`org`/developers/`developer_email`` + # request: `organizations/`org`/developers/`developer_email`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1658,13 +1576,12 @@ module Google execute_or_queue_command(command, &block) end - # Returns the developer details, including the - # developer's name, email address, apps, and other information. - # **Note**: The response includes only the first 100 developer apps. + # Returns the developer details, including the developer's name, email address, + # apps, and other information. **Note**: The response includes only the first + # 100 developer apps. # @param [String] name # Required. Email address of the developer. Use the following structure in your - # request: - # `organizations/`org`/developers/`developer_email`` + # request: `organizations/`org`/developers/`developer_email`` # @param [String] action # Status of the developer. Valid values are `active` or `inactive`. # @param [String] fields @@ -1695,44 +1612,32 @@ module Google execute_or_queue_command(command, &block) end - # Lists all developers in an organization by email address. - # By default, - # the response does not include company developers. Set the `includeCompany` - # query parameter to `true` to include company developers. - # **Note**: A maximum of 1000 developers are returned in the response. You - # paginate the list of developers returned using the `startKey` and `count` - # query parameters. + # Lists all developers in an organization by email address. By default, the + # response does not include company developers. Set the `includeCompany` query + # parameter to `true` to include company developers. **Note**: A maximum of 1000 + # developers are returned in the response. You paginate the list of developers + # returned using the `startKey` and `count` query parameters. # @param [String] parent # Required. Name of the Apigee organization. Use the following structure in your - # request: - # `organizations/`org``. + # request: `organizations/`org``. # @param [Fixnum] count # Optional. Number of developers to return in the API call. Use with the ` - # startKey` - # parameter to provide more targeted filtering. - # The limit is 1000. + # startKey` parameter to provide more targeted filtering. The limit is 1000. # @param [Boolean] expand - # Specifies whether to expand the results. Set to `true` - # to expand the results. This query parameter is not valid if you use - # the `count` or `startKey` query parameters. + # Specifies whether to expand the results. Set to `true` to expand the results. + # This query parameter is not valid if you use the `count` or `startKey` query + # parameters. # @param [String] ids # Optional. List of IDs to include, separated by commas. # @param [Boolean] include_company # Flag that specifies whether to include company details in the response. # @param [String] start_key - # **Note**: Must be used in conjunction with the `count` parameter. - # Email address of the developer from which to start displaying the list of - # developers. For example, if the an unfiltered list returns: - # ``` - # westley@example.com - # fezzik@example.com - # buttercup@example.com - # ``` - # and your `startKey` is `fezzik@example.com`, the list returned will be - # ``` - # fezzik@example.com - # buttercup@example.com - # ``` + # **Note**: Must be used in conjunction with the `count` parameter. Email + # address of the developer from which to start displaying the list of developers. + # For example, if the an unfiltered list returns: ``` westley@example.com + # fezzik@example.com buttercup@example.com ``` and your `startKey` is `fezzik@ + # example.com`, the list returned will be ``` fezzik@example.com buttercup@ + # example.com ``` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1765,18 +1670,16 @@ module Google execute_or_queue_command(command, &block) end - # Sets the status of a developer. Valid values are `active` or `inactive`. - # A developer is `active` by default. If you set a developer's status to - # `inactive`, the API keys assigned to the developer apps are no longer valid - # even though the API keys are set to `approved`. Inactive developers - # can still sign in to the developer portal and create apps; however, any - # new API keys generated during app creation won't work. - # If successful, the API call returns the + # Sets the status of a developer. Valid values are `active` or `inactive`. A + # developer is `active` by default. If you set a developer's status to `inactive` + # , the API keys assigned to the developer apps are no longer valid even though + # the API keys are set to `approved`. Inactive developers can still sign in to + # the developer portal and create apps; however, any new API keys generated + # during app creation won't work. If successful, the API call returns the # following HTTP status code: `204 No Content` # @param [String] name # Required. Email address of the developer. Use the following structure in your - # request: - # `organizations/`org`/developers/`developer_email`` + # request: `organizations/`org`/developers/`developer_email`` # @param [String] action # Status of the developer. Valid values are `active` and `inactive`. # @param [String] fields @@ -1807,21 +1710,18 @@ module Google execute_or_queue_command(command, &block) end - # Updates a developer. - # This API replaces the existing developer details with those specified - # in the request. Include or exclude any existing details that - # you want to retain or delete, respectively. - # The custom attribute limit is 18. - # **Note**: OAuth access tokens and Key Management Service (KMS) entities - # (apps, developers, and API products) are cached for 180 seconds - # (current default). Any custom attributes associated with these entities - # are cached for at least 180 seconds after the entity is accessed at - # runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy - # won't be able to expire an access token in less than 180 seconds. + # Updates a developer. This API replaces the existing developer details with + # those specified in the request. Include or exclude any existing details that + # you want to retain or delete, respectively. The custom attribute limit is 18. * + # *Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, + # developers, and API products) are cached for 180 seconds (current default). + # Any custom attributes associated with these entities are cached for at least + # 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` + # element on the OAuthV2 policy won't be able to expire an access token in less + # than 180 seconds. # @param [String] name # Required. Email address of the developer. Use the following structure in your - # request: - # `organizations/`org`/developers/`developer_email`` + # request: `organizations/`org`/developers/`developer_email`` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Developer] google_cloud_apigee_v1_developer_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1852,12 +1752,11 @@ module Google execute_or_queue_command(command, &block) end - # Updates attributes for a developer app. This API replaces the - # current attributes with those specified in the request. + # Updates attributes for a developer app. This API replaces the current + # attributes with those specified in the request. # @param [String] name # Required. Name of the developer app. Use the following structure in your - # request: - # `organizations/`org`/developers/`developer_email`/apps/`app`` + # request: `organizations/`org`/developers/`developer_email`/apps/`app`` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attributes] google_cloud_apigee_v1_attributes_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1888,17 +1787,15 @@ module Google execute_or_queue_command(command, &block) end - # Creates an app associated with a developer. This API associates the - # developer app with the specified API - # product and auto-generates an API key for the app to use in calls to API - # proxies inside that API product. - # The `name` is the unique ID of the app - # that you can use in API calls. The `DisplayName` (set as an - # attribute) appears in the UI. If you don't set the - # `DisplayName` attribute, the `name` appears in the UI. + # Creates an app associated with a developer. This API associates the developer + # app with the specified API product and auto-generates an API key for the app + # to use in calls to API proxies inside that API product. The `name` is the + # unique ID of the app that you can use in API calls. The `DisplayName` (set as + # an attribute) appears in the UI. If you don't set the `DisplayName` attribute, + # the `name` appears in the UI. # @param [String] parent - # Required. Name of the developer. Use the following structure in your request: - # `organizations/`org`/developers/`developer_email`` + # Required. Name of the developer. Use the following structure in your request: ` + # organizations/`org`/developers/`developer_email`` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] google_cloud_apigee_v1_developer_app_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1929,16 +1826,13 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a developer app. - # **Note**: The delete operation is asynchronous. The developer app is - # deleted immediately, - # but its associated resources, such as app - # keys or access tokens, may take anywhere from a few seconds to a - # few minutes to be deleted. + # Deletes a developer app. **Note**: The delete operation is asynchronous. The + # developer app is deleted immediately, but its associated resources, such as + # app keys or access tokens, may take anywhere from a few seconds to a few + # minutes to be deleted. # @param [String] name # Required. Name of the developer app. Use the following structure in your - # request: - # `organizations/`org`/developers/`developer_email`/apps/`app`` + # request: `organizations/`org`/developers/`developer_email`/apps/`app`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1966,41 +1860,32 @@ module Google execute_or_queue_command(command, &block) end - # Manages access to a developer app by enabling you to: - # * Approve or revoke a developer app - # * Generate a new consumer key and secret for a developer app - # To approve or revoke a developer app, set the `action` query parameter to - # `approved` or `revoked`, respectively, and the - # `Content-Type` header to `application/octet-stream`. If a developer app is - # revoked, none of its API keys are valid for API calls even though - # the keys are still `approved`. If successful, the API call returns the - # following HTTP status code: `204 No Content` - # To generate a new consumer key and secret for a developer - # app, pass the new key/secret details. Rather than - # replace an existing key, this API generates a new - # key. In this case, multiple key - # pairs may be associated with a single developer app. Each key pair has an - # independent status (`approved` or `revoked`) and expiration time. - # Any approved, non-expired key can be used in an API call. - # For example, if you're using API key rotation, you can generate new - # keys with expiration times that overlap keys that are going to expire. - # You might also generate a new consumer key/secret if the security of the - # original key/secret is compromised. - # The `keyExpiresIn` property defines the - # expiration time for the API key in milliseconds. If you don't set - # this property or set it to `-1`, the API key never expires. - # **Notes**: - # * When generating a new key/secret, this API replaces the - # existing attributes, notes, and callback URLs with those specified in the - # request. Include or exclude any existing information that you want to - # retain or delete, respectively. - # * To migrate existing consumer keys and secrets to hybrid from another - # system, see the + # Manages access to a developer app by enabling you to: * Approve or revoke a + # developer app * Generate a new consumer key and secret for a developer app To + # approve or revoke a developer app, set the `action` query parameter to ` + # approved` or `revoked`, respectively, and the `Content-Type` header to ` + # application/octet-stream`. If a developer app is revoked, none of its API keys + # are valid for API calls even though the keys are still `approved`. If + # successful, the API call returns the following HTTP status code: `204 No + # Content` To generate a new consumer key and secret for a developer app, pass + # the new key/secret details. Rather than replace an existing key, this API + # generates a new key. In this case, multiple key pairs may be associated with a + # single developer app. Each key pair has an independent status (`approved` or ` + # revoked`) and expiration time. Any approved, non-expired key can be used in an + # API call. For example, if you're using API key rotation, you can generate new + # keys with expiration times that overlap keys that are going to expire. You + # might also generate a new consumer key/secret if the security of the original + # key/secret is compromised. The `keyExpiresIn` property defines the expiration + # time for the API key in milliseconds. If you don't set this property or set it + # to `-1`, the API key never expires. **Notes**: * When generating a new key/ + # secret, this API replaces the existing attributes, notes, and callback URLs + # with those specified in the request. Include or exclude any existing + # information that you want to retain or delete, respectively. * To migrate + # existing consumer keys and secrets to hybrid from another system, see the # CreateDeveloperAppKey API. # @param [String] name # Required. Name of the developer app. Use the following structure in your - # request: - # `organizations/`org`/developers/`developer_email`/apps/`app`` + # request: `organizations/`org`/developers/`developer_email`/apps/`app`` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] google_cloud_apigee_v1_developer_app_object # @param [String] action # Action. Valid values are `approve` or `revoke`. @@ -2037,19 +1922,15 @@ module Google # Returns the details for a developer app. # @param [String] name # Required. Name of the developer app. Use the following structure in your - # request: - # `organizations/`org`/developers/`developer_email`/apps/`app`` + # request: `organizations/`org`/developers/`developer_email`/apps/`app`` # @param [String] entity - # **Note**: Must be used in conjunction with the `query` parameter. - # Set to `apiresources` - # to return the number of API resources - # that have been approved for access by a developer app in the - # specified Apigee organization. + # **Note**: Must be used in conjunction with the `query` parameter. Set to ` + # apiresources` to return the number of API resources that have been approved + # for access by a developer app in the specified Apigee organization. # @param [String] query - # **Note**: Must be used in conjunction with the `entity` parameter. - # Set to `count` to return the number of API resources - # that have been approved for access by a developer app in the - # specified Apigee organization. + # **Note**: Must be used in conjunction with the `entity` parameter. Set to ` + # count` to return the number of API resources that have been approved for + # access by a developer app in the specified Apigee organization. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2079,32 +1960,29 @@ module Google execute_or_queue_command(command, &block) end - # Lists all apps created by a developer in an Apigee organization. - # Optionally, you can request an expanded view of the developer apps. - # A maximum of 100 developer apps are returned per API call. You can paginate - # the list of deveoper apps returned using the `startKey` and `count` query - # parameters. + # Lists all apps created by a developer in an Apigee organization. Optionally, + # you can request an expanded view of the developer apps. A maximum of 100 + # developer apps are returned per API call. You can paginate the list of + # deveoper apps returned using the `startKey` and `count` query parameters. # @param [String] parent - # Required. Name of the developer. Use the following structure in your request: - # `organizations/`org`/developers/`developer_email`` + # Required. Name of the developer. Use the following structure in your request: ` + # organizations/`org`/developers/`developer_email`` # @param [Fixnum] count # Number of developer apps to return in the API call. Use with the `startKey` - # parameter to provide more targeted filtering. - # The limit is 1000. + # parameter to provide more targeted filtering. The limit is 1000. # @param [Boolean] expand - # Optional. Specifies whether to expand the results. Set to `true` - # to expand the results. This query parameter is not valid if you use - # the `count` or `startKey` query parameters. + # Optional. Specifies whether to expand the results. Set to `true` to expand the + # results. This query parameter is not valid if you use the `count` or `startKey` + # query parameters. # @param [Boolean] shallow_expand - # Optional. Specifies whether to expand the results in shallow mode. - # Set to `true` to expand the results in shallow mode. + # Optional. Specifies whether to expand the results in shallow mode. Set to ` + # true` to expand the results in shallow mode. # @param [String] start_key - # **Note**: Must be used in conjunction with the `count` parameter. - # Name of the developer app from which to start displaying the list of - # developer apps. For example, if you're returning 50 developer apps at - # a time (using the `count` query parameter), you can view developer apps - # 50-99 by entering the name of the 50th developer app. - # The developer app name is case sensitive. + # **Note**: Must be used in conjunction with the `count` parameter. Name of the + # developer app from which to start displaying the list of developer apps. For + # example, if you're returning 50 developer apps at a time (using the `count` + # query parameter), you can view developer apps 50-99 by entering the name of + # the 50th developer app. The developer app name is case sensitive. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2136,26 +2014,19 @@ module Google execute_or_queue_command(command, &block) end - # Updates the details for a developer app. In addition, you can - # add an API product to a developer app and automatically generate - # an API key for the app to use when calling APIs in the API product. - # If you want to use an existing API key for the API product, - # add the API product to the API key using the - # UpdateDeveloperAppKey - # API. - # Using this API, you cannot update the following: - # * App name as it is the primary key used to identify the app and cannot - # be changed. - # * Scopes associated with the app. Instead, use the - # ReplaceDeveloperAppKey API. - # This API replaces the - # existing attributes with those specified in the request. - # Include or exclude any existing attributes that you want to retain or - # delete, respectively. + # Updates the details for a developer app. In addition, you can add an API + # product to a developer app and automatically generate an API key for the app + # to use when calling APIs in the API product. If you want to use an existing + # API key for the API product, add the API product to the API key using the + # UpdateDeveloperAppKey API. Using this API, you cannot update the following: * + # App name as it is the primary key used to identify the app and cannot be + # changed. * Scopes associated with the app. Instead, use the + # ReplaceDeveloperAppKey API. This API replaces the existing attributes with + # those specified in the request. Include or exclude any existing attributes + # that you want to retain or delete, respectively. # @param [String] name # Required. Name of the developer app. Use the following structure in your - # request: - # `organizations/`org`/developers/`developer_email`/apps/`app`` + # request: `organizations/`org`/developers/`developer_email`/apps/`app`` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperApp] google_cloud_apigee_v1_developer_app_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2189,10 +2060,8 @@ module Google # Deletes a developer app attribute. # @param [String] name # Required. Name of the developer app attribute. Use the following structure in - # your - # request: - # `organizations/`org`/developers/`developer_email`/apps/`app`/attributes/` - # attribute`` + # your request: `organizations/`org`/developers/`developer_email`/apps/`app`/ + # attributes/`attribute`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2223,10 +2092,8 @@ module Google # Returns a developer app attribute. # @param [String] name # Required. Name of the developer app attribute. Use the following structure in - # your - # request: - # `organizations/`org`/developers/`developer_email`/apps/`app`/attributes/` - # attribute`` + # your request: `organizations/`org`/developers/`developer_email`/apps/`app`/ + # attributes/`attribute`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2257,8 +2124,7 @@ module Google # Returns a list of all developer app attributes. # @param [String] parent # Required. Name of the developer app. Use the following structure in your - # request: - # `organizations/`org`/developers/`developer_email`/apps/`app`` + # request: `organizations/`org`/developers/`developer_email`/apps/`app`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2286,19 +2152,16 @@ module Google execute_or_queue_command(command, &block) end - # Updates a developer app attribute. - # **Note**: OAuth access tokens and Key Management Service (KMS) entities - # (apps, developers, and API products) are cached for 180 seconds - # (current default). Any custom attributes associated with these entities - # are cached for at least 180 seconds after the entity is accessed at - # runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy + # Updates a developer app attribute. **Note**: OAuth access tokens and Key + # Management Service (KMS) entities (apps, developers, and API products) are + # cached for 180 seconds (current default). Any custom attributes associated + # with these entities are cached for at least 180 seconds after the entity is + # accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy # won't be able to expire an access token in less than 180 seconds. # @param [String] name # Required. Name of the developer app attribute. Use the following structure in - # your - # request: - # `organizations/`org`/developers/`developer_email`/apps/`app`/attributes/` - # attribute`` + # your request: `organizations/`org`/developers/`developer_email`/apps/`app`/ + # attributes/`attribute`` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] google_cloud_apigee_v1_attribute_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2330,23 +2193,19 @@ module Google end # Creates a custom consumer key and secret for a developer app. This is - # particularly useful if you want to migrate existing consumer keys and - # secrets to Apigee hybrid from another system. - # Consumer keys and secrets can contain letters, numbers, underscores, and - # hyphens. No other special characters are allowed. To avoid service - # disruptions, a consumer key and secret should not exceed 2 KBs each. - # **Note**: When creating the consumer key and secret, an association to - # API products will not be made. Therefore, you should not specify the - # associated API products in your request. Instead, use the - # UpdateDeveloperAppKey API to - # make the association after the consumer key and secret are created. - # If a consumer key and secret already exist, you can keep them or - # delete them using the - # DeleteDeveloperAppKey API. + # particularly useful if you want to migrate existing consumer keys and secrets + # to Apigee hybrid from another system. Consumer keys and secrets can contain + # letters, numbers, underscores, and hyphens. No other special characters are + # allowed. To avoid service disruptions, a consumer key and secret should not + # exceed 2 KBs each. **Note**: When creating the consumer key and secret, an + # association to API products will not be made. Therefore, you should not + # specify the associated API products in your request. Instead, use the + # UpdateDeveloperAppKey API to make the association after the consumer key and + # secret are created. If a consumer key and secret already exist, you can keep + # them or delete them using the DeleteDeveloperAppKey API. # @param [String] parent - # Parent of the developer app key. Use the following structure in your - # request: - # `organizations/`org`/developers/`developer_email`/apps` + # Parent of the developer app key. Use the following structure in your request: ` + # organizations/`org`/developers/`developer_email`/apps` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] google_cloud_apigee_v1_developer_app_key_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2377,18 +2236,16 @@ module Google execute_or_queue_command(command, &block) end - # Deletes an app's consumer key and removes all API products - # associated with the app. After the consumer key is deleted, - # it cannot be used to access any APIs. - # **Note**: After you delete a consumer key, you may want to: - # 1. Create a new consumer key and secret for the developer app using the - # CreateDeveloperAppKey API, and - # subsequently add an API product to the key using the - # UpdateDeveloperAppKey API. - # 2. Delete the developer app, if it is no longer required. + # Deletes an app's consumer key and removes all API products associated with the + # app. After the consumer key is deleted, it cannot be used to access any APIs. * + # *Note**: After you delete a consumer key, you may want to: 1. Create a new + # consumer key and secret for the developer app using the CreateDeveloperAppKey + # API, and subsequently add an API product to the key using the + # UpdateDeveloperAppKey API. 2. Delete the developer app, if it is no longer + # required. # @param [String] name - # Name of the developer app key. Use the following structure in your request: - # `organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`` + # Name of the developer app key. Use the following structure in your request: ` + # organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2416,11 +2273,11 @@ module Google execute_or_queue_command(command, &block) end - # Returns details for a consumer key for a developer app, including the key - # and secret value, associated API products, and other information. + # Returns details for a consumer key for a developer app, including the key and + # secret value, associated API products, and other information. # @param [String] name - # Name of the developer app key. Use the following structure in your request: - # `organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`` + # Name of the developer app key. Use the following structure in your request: ` + # organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2448,17 +2305,14 @@ module Google execute_or_queue_command(command, &block) end - # Updates the scope of an app. - # This API replaces the - # existing scopes with those specified in the request. - # Include or exclude any existing scopes that you want to retain or - # delete, respectively. The specified scopes must already - # be defined for the API products associated with the app. - # This API sets the `scopes` element - # under the `apiProducts` element in the attributes of the app. + # Updates the scope of an app. This API replaces the existing scopes with those + # specified in the request. Include or exclude any existing scopes that you want + # to retain or delete, respectively. The specified scopes must already be + # defined for the API products associated with the app. This API sets the ` + # scopes` element under the `apiProducts` element in the attributes of the app. # @param [String] name - # Name of the developer app key. Use the following structure in your request: - # `organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`` + # Name of the developer app key. Use the following structure in your request: ` + # organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] google_cloud_apigee_v1_developer_app_key_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2489,22 +2343,19 @@ module Google execute_or_queue_command(command, &block) end - # Adds an API product to a developer app key, enabling the app that holds - # the key to access the API resources bundled in the API product. - # In addition, you can add - # attributes to a developer app key. This API replaces the - # existing attributes with those specified in the request. - # Include or exclude any existing attributes that you want to retain or - # delete, respectively. - # You can use the same key to access all API products - # associated with the app. + # Adds an API product to a developer app key, enabling the app that holds the + # key to access the API resources bundled in the API product. In addition, you + # can add attributes to a developer app key. This API replaces the existing + # attributes with those specified in the request. Include or exclude any + # existing attributes that you want to retain or delete, respectively. You can + # use the same key to access all API products associated with the app. # @param [String] name - # Name of the developer app key. Use the following structure in your request: - # `organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`` + # Name of the developer app key. Use the following structure in your request: ` + # organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] google_cloud_apigee_v1_developer_app_key_object # @param [String] action - # Approve or revoke the consumer key by setting this value to - # `approve` or `revoke`, respectively. + # Approve or revoke the consumer key by setting this value to `approve` or ` + # revoke`, respectively. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2536,14 +2387,12 @@ module Google end # Removes an API product from an app's consumer key. After the API product is - # removed, the app cannot access the API resources defined in - # that API product. - # **Note**: The consumer key is not removed, only its association with the - # API product. + # removed, the app cannot access the API resources defined in that API product. * + # *Note**: The consumer key is not removed, only its association with the API + # product. # @param [String] name - # Name of the API product in the developer app key in the following - # format: - # `organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`/ + # Name of the API product in the developer app key in the following format: ` + # organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`/ # apiproducts/`apiproduct`` # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2572,20 +2421,18 @@ module Google execute_or_queue_command(command, &block) end - # Approve or revoke an app's consumer key. After a consumer key is approved, - # the app can use it to access APIs. - # A consumer key that is revoked or pending cannot be used to access an API. - # Any access tokens associated with a revoked consumer key will remain - # active. However, Apigee hybrid checks the status of the consumer key and - # if set to `revoked` will not allow access to the API. + # Approve or revoke an app's consumer key. After a consumer key is approved, the + # app can use it to access APIs. A consumer key that is revoked or pending + # cannot be used to access an API. Any access tokens associated with a revoked + # consumer key will remain active. However, Apigee hybrid checks the status of + # the consumer key and if set to `revoked` will not allow access to the API. # @param [String] name - # Name of the API product in the developer app key in the following - # format: - # `organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`/ + # Name of the API product in the developer app key in the following format: ` + # organizations/`org`/developers/`developer_email`/apps/`app`/keys/`key`/ # apiproducts/`apiproduct`` # @param [String] action - # Approve or revoke the consumer key by setting this value to - # `approve` or `revoke`, respectively. + # Approve or revoke the consumer key by setting this value to `approve` or ` + # revoke`, respectively. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2615,23 +2462,19 @@ module Google end # Creates a custom consumer key and secret for a developer app. This is - # particularly useful if you want to migrate existing consumer keys and - # secrets to Apigee hybrid from another system. - # Consumer keys and secrets can contain letters, numbers, underscores, and - # hyphens. No other special characters are allowed. To avoid service - # disruptions, a consumer key and secret should not exceed 2 KBs each. - # **Note**: When creating the consumer key and secret, an association to - # API products will not be made. Therefore, you should not specify the - # associated API products in your request. Instead, use the - # UpdateDeveloperAppKey API to - # make the association after the consumer key and secret are created. - # If a consumer key and secret already exist, you can keep them or - # delete them using the - # DeleteDeveloperAppKey API. + # particularly useful if you want to migrate existing consumer keys and secrets + # to Apigee hybrid from another system. Consumer keys and secrets can contain + # letters, numbers, underscores, and hyphens. No other special characters are + # allowed. To avoid service disruptions, a consumer key and secret should not + # exceed 2 KBs each. **Note**: When creating the consumer key and secret, an + # association to API products will not be made. Therefore, you should not + # specify the associated API products in your request. Instead, use the + # UpdateDeveloperAppKey API to make the association after the consumer key and + # secret are created. If a consumer key and secret already exist, you can keep + # them or delete them using the DeleteDeveloperAppKey API. # @param [String] parent - # Parent of the developer app key. Use the following structure in your - # request: - # `organizations/`org`/developers/`developer_email`/apps` + # Parent of the developer app key. Use the following structure in your request: ` + # organizations/`org`/developers/`developer_email`/apps` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DeveloperAppKey] google_cloud_apigee_v1_developer_app_key_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2665,8 +2508,8 @@ module Google # Deletes a developer attribute. # @param [String] name # Required. Name of the developer attribute. Use the following structure in your - # request: - # `organizations/`org`/developers/`developer_email`/attributes/`attribute`` + # request: `organizations/`org`/developers/`developer_email`/attributes/` + # attribute`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2697,8 +2540,8 @@ module Google # Returns the value of the specified developer attribute. # @param [String] name # Required. Name of the developer attribute. Use the following structure in your - # request: - # `organizations/`org`/developers/`developer_email`/attributes/`attribute`` + # request: `organizations/`org`/developers/`developer_email`/attributes/` + # attribute`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2729,9 +2572,7 @@ module Google # Returns a list of all developer attributes. # @param [String] parent # Required. Email address of the developer for which attributes are being listed - # in the - # following format: - # `organizations/`org`/developers/`developer_email`` + # in the following format: `organizations/`org`/developers/`developer_email`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2759,17 +2600,16 @@ module Google execute_or_queue_command(command, &block) end - # Updates a developer attribute. - # **Note**: OAuth access tokens and Key Management Service (KMS) entities - # (apps, developers, and API products) are cached for 180 seconds - # (default). Any custom attributes associated with these entities - # are cached for at least 180 seconds after the entity is accessed at - # runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy - # won't be able to expire an access token in less than 180 seconds. + # Updates a developer attribute. **Note**: OAuth access tokens and Key + # Management Service (KMS) entities (apps, developers, and API products) are + # cached for 180 seconds (default). Any custom attributes associated with these + # entities are cached for at least 180 seconds after the entity is accessed at + # runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able + # to expire an access token in less than 180 seconds. # @param [String] name # Required. Name of the developer attribute. Use the following structure in your - # request: - # `organizations/`org`/developers/`developer_email`/attributes/`attribute`` + # request: `organizations/`org`/developers/`developer_email`/attributes/` + # attribute`` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Attribute] google_cloud_apigee_v1_attribute_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2803,8 +2643,7 @@ module Google # Creates a new environment group. # @param [String] parent # Required. Name of the organization in which to create the environment group in - # the - # following format: `organizations/`org``. + # the following format: `organizations/`org``. # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroup] google_cloud_apigee_v1_environment_group_object # @param [String] name # ID of the environment group. Overrides any ID in the environment_group @@ -2841,8 +2680,8 @@ module Google # Deletes an environment group. # @param [String] name - # Required. Name of the environment group in the following format: - # `organizations/`org`/envgroups/`envgroup``. + # Required. Name of the environment group in the following format: ` + # organizations/`org`/envgroups/`envgroup``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2872,8 +2711,8 @@ module Google # Gets an environment group. # @param [String] name - # Required. Name of the environment group in the following format: - # `organizations/`org`/envgroups/`envgroup``. + # Required. Name of the environment group in the following format: ` + # organizations/`org`/envgroups/`envgroup``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2906,11 +2745,10 @@ module Google # Required. Name of the organization for which to list environment groups in the # following format: `organizations/`org``. # @param [Fixnum] page_size - # Maximum number of environment groups to return. The page size defaults - # to 25. + # Maximum number of environment groups to return. The page size defaults to 25. # @param [String] page_token - # Page token, returned from a previous ListEnvironmentGroups call, that you - # can use to retrieve the next page. + # Page token, returned from a previous ListEnvironmentGroups call, that you can + # use to retrieve the next page. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2942,8 +2780,8 @@ module Google # Updates an environment group. # @param [String] name - # Required. Name of the environment group to update in the format: - # `organizations/`org`/envgroups/`envgroup`. + # Required. Name of the environment group to update in the format: ` + # organizations/`org`/envgroups/`envgroup`. # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroup] google_cloud_apigee_v1_environment_group_object # @param [String] update_mask # List of fields to be updated. @@ -2980,8 +2818,7 @@ module Google # Creates a new attachment of an environment to an environment group. # @param [String] parent # Required. EnvironmentGroup under which to create the attachment in the - # following - # format: `organizations/`org`/envgroups/`envgroup``. + # following format: `organizations/`org`/envgroups/`envgroup``. # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1EnvironmentGroupAttachment] google_cloud_apigee_v1_environment_group_attachment_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3015,8 +2852,7 @@ module Google # Deletes an environment group attachment. # @param [String] name # Required. Name of the environment group attachment to delete in the following - # format: - # `organizations/`org`/envgroups/`envgroup`/attachments/`attachment``. + # format: `organizations/`org`/envgroups/`envgroup`/attachments/`attachment``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3046,8 +2882,8 @@ module Google # Gets an environment group attachment. # @param [String] name - # Required. Name of the environment group attachment in the following format: - # `organizations/`org`/envgroups/`envgroup`/attachments/`attachment`` + # Required. Name of the environment group attachment in the following format: ` + # organizations/`org`/envgroups/`envgroup`/attachments/`attachment`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3083,8 +2919,8 @@ module Google # Maximum number of environment group attachments to return. The page size # defaults to 25. # @param [String] page_token - # Page token, returned by a previous ListEnvironmentGroupAttachments call, - # that you can use to retrieve the next page. + # Page token, returned by a previous ListEnvironmentGroupAttachments call, that + # you can use to retrieve the next page. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3116,14 +2952,12 @@ module Google # Creates an environment in an organization. # @param [String] parent - # Required. Name of the organization in which the environment will - # be created. Use the following structure in your request: - # `organizations/`org`` + # Required. Name of the organization in which the environment will be created. + # Use the following structure in your request: `organizations/`org`` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Environment] google_cloud_apigee_v1_environment_object # @param [String] name - # Optional. Name of the environment. Alternatively, the name may - # be specified in the request body in the - # name field. + # Optional. Name of the environment. Alternatively, the name may be specified in + # the request body in the name field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3156,8 +2990,7 @@ module Google # Deletes an environment from an organization. # @param [String] name - # Required. Name of the environment. Use the following structure in your - # request: + # Required. Name of the environment. Use the following structure in your request: # `organizations/`org`/environments/`env`` # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3251,9 +3084,8 @@ module Google # Gets the deployed configuration for an environment. # @param [String] name # Required. Name of the environment deployed configuration resource. Use the - # following - # structure in your request: - # `organizations/`org`/environments/`env`/deployedConfig` + # following structure in your request: `organizations/`org`/environments/`env`/ + # deployedConfig` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3281,24 +3113,21 @@ module Google execute_or_queue_command(command, &block) end - # Gets the IAM policy on an environment. For more information, see - # [Manage users, roles, and permissions - # using the API](https://docs.apigee.com/hybrid/latest/manage-users-roles). - # You must have the `apigee.environments.getIamPolicy` permission to call - # this API. + # Gets the IAM policy on an environment. For more information, see [Manage users, + # roles, and permissions using the API](https://docs.apigee.com/hybrid/latest/ + # manage-users-roles). You must have the `apigee.environments.getIamPolicy` + # permission to call this API. # @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 @@ -3327,15 +3156,13 @@ module Google execute_or_queue_command(command, &block) end - # Sets the IAM policy on an environment, if the policy already - # exists it will be replaced. For more information, see - # [Manage users, roles, and permissions - # using the API](https://docs.apigee.com/hybrid/latest/manage-users-roles). - # You must have the `apigee.environments.setIamPolicy` permission to - # call this API. + # Sets the IAM policy on an environment, if the policy already exists it will be + # replaced. For more information, see [Manage users, roles, and permissions + # using the API](https://docs.apigee.com/hybrid/latest/manage-users-roles). You + # must have the `apigee.environments.setIamPolicy` permission to call this API. # @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::ApigeeV1::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3366,9 +3193,9 @@ module Google execute_or_queue_command(command, &block) end - # Creates a subscription for the environment's Pub/Sub topic. - # The server will assign a random name for this subscription. - # The "name" and "push_config" must *not* be specified. + # Creates a subscription for the environment's Pub/Sub topic. The server will + # assign a random name for this subscription. The "name" and "push_config" must * + # not* be specified. # @param [String] parent # Required. Name of the environment. Use the following structure in your request: # `organizations/`org`/environments/`env`` @@ -3399,13 +3226,12 @@ module Google execute_or_queue_command(command, &block) end - # Tests the permissions of a user on an environment, - # and returns a subset of permissions that the user has on the environment. - # If the environment does not exist, an empty permission set is returned - # (a NOT_FOUND error is not returned). + # Tests the permissions of a user on an environment, and returns a subset of + # permissions that the user has on the environment. If the environment does not + # exist, an empty permission set is returned (a NOT_FOUND error is not returned). # @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::ApigeeV1::GoogleIamV1TestIamPermissionsRequest] google_iam_v1_test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3470,11 +3296,11 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing environment. - # When updating properties, you must pass all existing properties to the API, - # even if they are not being changed. If you omit properties from the - # payload, the properties are removed. To get the current list of - # properties for the environment, use the [Get Environment API](get). + # Updates an existing environment. When updating properties, you must pass all + # existing properties to the API, even if they are not being changed. If you + # omit properties from the payload, the properties are removed. To get the + # current list of properties for the environment, use the [Get Environment API]( + # get). # @param [String] name # Required. Name of the environment. Use the following structure in your request: # `organizations/`org`/environments/`env`` @@ -3514,8 +3340,8 @@ module Google # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugMask] google_cloud_apigee_v1_debug_mask_object # @param [Boolean] replace_repeated_fields # Boolean flag that specifies whether to replace existing values in the debug - # mask when doing an update. Set to true to replace existing values. - # The default behavior is to append the values (false). + # mask when doing an update. Set to true to replace existing values. The default + # behavior is to append the values (false). # @param [String] update_mask # Field debug mask to support partial updates. # @param [String] fields @@ -3549,11 +3375,11 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing environment. - # When updating properties, you must pass all existing properties to the API, - # even if they are not being changed. If you omit properties from the - # payload, the properties are removed. To get the current list of - # properties for the environment, use the [Get Environment API](get). + # Updates an existing environment. When updating properties, you must pass all + # existing properties to the API, even if they are not being changed. If you + # omit properties from the payload, the properties are removed. To get the + # current list of properties for the environment, use the [Get Environment API]( + # get). # @param [String] name # Required. Name of the environment. Use the following structure in your request: # `organizations/`org`/environments/`env`` @@ -3587,16 +3413,15 @@ module Google execute_or_queue_command(command, &block) end - # Get a list of metrics and dimensions which can be used for creating - # analytics queries and reports. - # Each schema element contains the name of the field with its associated type - # and if it is either custom field or standard field. + # Get a list of metrics and dimensions which can be used for creating analytics + # queries and reports. Each schema element contains the name of the field with + # its associated type and if it is either custom field or standard field. # @param [String] name - # Required. The parent organization and environment names. Must be of the - # form `organizations/`org`/environments/`env`/analytics/admin/schemav2`. + # Required. The parent organization and environment names. Must be of the form ` + # organizations/`org`/environments/`env`/analytics/admin/schemav2`. # @param [String] type - # Required. Type refers to the dataset name whose schema needs to be - # retrieved E.g. type=fact or type=agg_cus1 + # Required. Type refers to the dataset name whose schema needs to be retrieved E. + # g. type=fact or type=agg_cus1 # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3625,13 +3450,12 @@ module Google execute_or_queue_command(command, &block) end - # Submit a data export job to be processed in the background. - # If the request is successful, the API returns a 201 status, a URI that can - # be used to retrieve the status of the export job, and the `state` value of - # "enqueued". + # Submit a data export job to be processed in the background. If the request is + # successful, the API returns a 201 status, a URI that can be used to retrieve + # the status of the export job, and the `state` value of "enqueued". # @param [String] parent - # Required. Names of the parent organization and environment. - # Must be of the form `organizations/`org`/environments/`env``. + # Required. Names of the parent organization and environment. Must be of the + # form `organizations/`org`/environments/`env``. # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ExportRequest] google_cloud_apigee_v1_export_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3662,11 +3486,10 @@ module Google execute_or_queue_command(command, &block) end - # Gets the details and status of an analytics export job. - # If the export job is still in progress, its `state` is set to "running". - # After the export job has completed successfully, its `state` is set to - # "completed". - # If the export job fails, its `state` is set to `failed`. + # Gets the details and status of an analytics export job. If the export job is + # still in progress, its `state` is set to "running". After the export job has + # completed successfully, its `state` is set to "completed". If the export job + # fails, its `state` is set to `failed`. # @param [String] name # Required. Resource name of the export to get. # @param [String] fields @@ -3699,8 +3522,8 @@ module Google # Lists the details and status of all analytics export jobs belonging to the # parent organization and environment. # @param [String] parent - # Required. Names of the parent organization and environment. - # Must be of the form `organizations/`org`/environments/`env``. + # Required. Names of the parent organization and environment. Must be of the + # form `organizations/`org`/environments/`env``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3731,8 +3554,7 @@ module Google # Lists all deployments of an API proxy in an environment. # @param [String] parent # Required. Name representing an API proxy in an environment in the following - # format: - # `organizations/`org`/environments/`env`/apis/`api`` + # format: `organizations/`org`/environments/`env`/apis/`api`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3760,23 +3582,22 @@ module Google execute_or_queue_command(command, &block) end - # Undeploys an API proxy revision from an environment. - # Because multiple revisions of the same API proxy can be deployed in - # the same environment if the base paths are different, you must specify the - # revision number of the API proxy. + # Undeploys an API proxy revision from an environment. Because multiple + # revisions of the same API proxy can be deployed in the same environment if the + # base paths are different, you must specify the revision number of the API + # proxy. # @param [String] name - # Required. Name of the API proxy revision deployment in the following format: - # `organizations/`org`/environments/`env`/apis/`api`/revisions/`rev`` + # Required. Name of the API proxy revision deployment in the following format: ` + # organizations/`org`/environments/`env`/apis/`api`/revisions/`rev`` # @param [Boolean] sequenced_rollout # If true, a best-effort attempt will be made to remove the environment group - # routing rules corresponding to this deployment before removing the - # deployment from the runtime. This is likely to be a rare use case; it is - # only needed when the intended effect of undeploying this proxy is to cause - # the traffic it currently handles to be rerouted to some other existing - # proxy in the environment group. The GenerateUndeployChangeReport API may be - # used to examine routing changes before issuing the undeployment request, - # and its response will indicate if a sequenced rollout is recommended for - # the undeployment. + # routing rules corresponding to this deployment before removing the deployment + # from the runtime. This is likely to be a rare use case; it is only needed when + # the intended effect of undeploying this proxy is to cause the traffic it + # currently handles to be rerouted to some other existing proxy in the + # environment group. The GenerateUndeployChangeReport API may be used to examine + # routing changes before issuing the undeployment request, and its response will + # indicate if a sequenced rollout is recommended for the undeployment. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3808,9 +3629,9 @@ module Google # Gets the deployment of an API proxy revision and actual state reported by # runtime pods. # @param [String] name - # Required. Name representing an API proxy revision in an - # environment in the following format: - # `organizations/`org`/environments/`env`/apis/`api`/revisions/`rev`` + # Required. Name representing an API proxy revision in an environment in the + # following format: `organizations/`org`/environments/`env`/apis/`api`/revisions/ + # `rev`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3840,14 +3661,13 @@ module Google # Creates a debug session for a deployed API Proxy revision. # @param [String] parent - # Required. The resource name of the API Proxy revision deployment for which - # to create the DebugSession. Must be of the form - # `organizations/`organization`/environments/`environment`/apis/`api`/revisions/ - # `revision``. + # Required. The resource name of the API Proxy revision deployment for which to + # create the DebugSession. Must be of the form `organizations/`organization`/ + # environments/`environment`/apis/`api`/revisions/`revision``. # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1DebugSession] google_cloud_apigee_v1_debug_session_object # @param [Fixnum] timeout - # Optional. The time in seconds after which this DebugSession should end. - # A timeout specified in DebugSession will overwrite this value. + # Optional. The time in seconds after which this DebugSession should end. A + # timeout specified in DebugSession will overwrite this value. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3878,14 +3698,13 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the data from a debug session. This does not cancel the debug - # session or prevent further data from being collected if the session is - # still active in runtime pods. + # Deletes the data from a debug session. This does not cancel the debug session + # or prevent further data from being collected if the session is still active in + # runtime pods. # @param [String] name - # Required. The name of the debug session to delete. - # Must be of the form: - # `organizations/`organization`/environments/`environment`/apis/`api`/revisions/ - # `revision`/debugsessions/`debugsession``. + # Required. The name of the debug session to delete. Must be of the form: ` + # organizations/`organization`/environments/`environment`/apis/`api`/revisions/` + # revision`/debugsessions/`debugsession``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3915,10 +3734,9 @@ module Google # Retrieves a debug session. # @param [String] name - # Required. The name of the debug session to retrieve. - # Must be of the form: - # `organizations/`organization`/environments/`environment`/apis/`api`/revisions/ - # `revision`/debugsessions/`session``. + # Required. The name of the debug session to retrieve. Must be of the form: ` + # organizations/`organization`/environments/`environment`/apis/`api`/revisions/` + # revision`/debugsessions/`session``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3946,19 +3764,16 @@ module Google execute_or_queue_command(command, &block) end - # Lists debug sessions that are currently active in the given API Proxy - # revision. + # Lists debug sessions that are currently active in the given API Proxy revision. # @param [String] parent - # Required. The name of the API Proxy revision deployment for which - # to list debug sessions. Must be of the form: - # `organizations/`organization`/environments/`environment`/apis/`api`/revisions/ - # `revision``. + # Required. The name of the API Proxy revision deployment for which to list + # debug sessions. Must be of the form: `organizations/`organization`/ + # environments/`environment`/apis/`api`/revisions/`revision``. # @param [Fixnum] page_size - # Maximum number of debug sessions to return. The page size defaults - # to 25. + # Maximum number of debug sessions to return. The page size defaults to 25. # @param [String] page_token - # Page token, returned from a previous ListDebugSessions call, that you - # can use to retrieve the next page. + # Page token, returned from a previous ListDebugSessions call, that you can use + # to retrieve the next page. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3990,9 +3805,9 @@ module Google # Gets the debug data from a transaction. # @param [String] name - # Required. The name of the debug session transaction. Must be of the form: - # `organizations/`organization`/environments/`environment`/apis/`api`/revisions/ - # `revision`/debugsessions/`session`/data/`transaction``. + # Required. The name of the debug session transaction. Must be of the form: ` + # organizations/`organization`/environments/`environment`/apis/`api`/revisions/` + # revision`/debugsessions/`session`/data/`transaction``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4020,22 +3835,22 @@ module Google execute_or_queue_command(command, &block) end - # Generates a report for a dry run analysis of a DeployApiProxy request - # without committing the deployment. - # In addition to the standard validations performed when adding deployments, - # additional analysis will be done to detect possible traffic routing changes - # that would result from this deployment being created. Any potential routing - # conflicts or unsafe changes will be reported in the response. This routing - # analysis is not performed for a non-dry-run DeployApiProxy request. + # Generates a report for a dry run analysis of a DeployApiProxy request without + # committing the deployment. In addition to the standard validations performed + # when adding deployments, additional analysis will be done to detect possible + # traffic routing changes that would result from this deployment being created. + # Any potential routing conflicts or unsafe changes will be reported in the + # response. This routing analysis is not performed for a non-dry-run + # DeployApiProxy request. # @param [String] name - # Name of the API proxy revision deployment in the following format: - # `organizations/`org`/environments/`env`/apis/`api`/revisions/`rev`` + # Name of the API proxy revision deployment in the following format: ` + # organizations/`org`/environments/`env`/apis/`api`/revisions/`rev`` # @param [String] basepath - # Base path where the API proxy revision should be deployed. Defaults to '/' - # if not provided. + # Base path where the API proxy revision should be deployed. Defaults to '/' if + # not provided. # @param [Boolean] override - # Flag that specifies whether to force the deployment of the new revision - # over the currently deployed revision by overriding conflict checks. + # Flag that specifies whether to force the deployment of the new revision over + # the currently deployed revision by overriding conflict checks. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4066,16 +3881,15 @@ module Google end # Generates a report for a dry run analysis of an UndeployApiProxy request - # without committing the undeploy. - # In addition to the standard validations performed when removing - # deployments, additional analysis will be done to detect possible traffic - # routing changes that would result from this deployment being removed. Any - # potential routing conflicts or unsafe changes will be reported in the - # response. This routing analysis is not performed for a non-dry-run - # UndeployApiProxy request. + # without committing the undeploy. In addition to the standard validations + # performed when removing deployments, additional analysis will be done to + # detect possible traffic routing changes that would result from this deployment + # being removed. Any potential routing conflicts or unsafe changes will be + # reported in the response. This routing analysis is not performed for a non-dry- + # run UndeployApiProxy request. # @param [String] name - # Name of the API proxy revision deployment in the following format: - # `organizations/`org`/environments/`env`/apis/`api`/revisions/`rev`` + # Name of the API proxy revision deployment in the following format: ` + # organizations/`org`/environments/`env`/apis/`api`/revisions/`rev`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4105,9 +3919,8 @@ module Google # Deletes a cache. # @param [String] name - # Required. Cache resource name of the form: - # `organizations/`organization_id`/environments/`environment_id`/caches/` - # cache_id`` + # Required. Cache resource name of the form: `organizations/`organization_id`/ + # environments/`environment_id`/caches/`cache_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4138,13 +3951,10 @@ module Google # Lists all deployments of API proxies or shared flows in an environment. # @param [String] parent # Required. Name of the environment for which to return deployment information - # in the - # following format: - # `organizations/`org`/environments/`env`` + # in the following format: `organizations/`org`/environments/`env`` # @param [Boolean] shared_flows # Optional. Flag that specifies whether to return shared flow or API proxy - # deployments. - # Set to `true` to return shared flow deployments; set to `false` + # deployments. Set to `true` to return shared flow deployments; set to `false` # to return API proxy deployments. Defaults to `false`. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4176,9 +3986,9 @@ module Google # Attaches a shared flow to a flow hook. # @param [String] name - # Required. Name of the flow hook to which the shared flow should be - # attached in the following format: - # `organizations/`org`/environments/`env`/flowhooks/`flowhook`` + # Required. Name of the flow hook to which the shared flow should be attached in + # the following format: `organizations/`org`/environments/`env`/flowhooks/` + # flowhook`` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1FlowHook] google_cloud_apigee_v1_flow_hook_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4211,8 +4021,8 @@ module Google # Detaches a shared flow from a flow hook. # @param [String] name - # Required. Name of the flow hook to detach in the following format: - # `organizations/`org`/environments/`env`/flowhooks/`flowhook`` + # Required. Name of the flow hook to detach in the following format: ` + # organizations/`org`/environments/`env`/flowhooks/`flowhook`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4241,11 +4051,11 @@ module Google end # Returns the name of the shared flow attached to the specified flow hook. If - # there's no shared flow attached to the flow hook, the API does not return - # an error; it simply does not return a name in the response. + # there's no shared flow attached to the flow hook, the API does not return an + # error; it simply does not return a name in the response. # @param [String] name - # Required. Name of the flow hook in the following format: - # `organizations/`org`/environments/`env`/flowhooks/`flowhook`` + # Required. Name of the flow hook in the following format: `organizations/`org`/ + # environments/`env`/flowhooks/`flowhook`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4273,15 +4083,13 @@ module Google execute_or_queue_command(command, &block) end - # Creates a keystore or truststore: - # * Keystore: Contains certificates and their associated keys. - # * Truststore: Contains trusted certificates used to validate a - # server's certificate. These certificates are typically self-signed + # Creates a keystore or truststore: * Keystore: Contains certificates and their + # associated keys. * Truststore: Contains trusted certificates used to validate + # a server's certificate. These certificates are typically self-signed # certificates or certificates that are not signed by a trusted CA. # @param [String] parent - # Required. The name of the environment in which to create the keystore. - # Must be of the form - # `organizations/`organization`/environments/`environment``. + # Required. The name of the environment in which to create the keystore. Must be + # of the form `organizations/`organization`/environments/`environment``. # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Keystore] google_cloud_apigee_v1_keystore_object # @param [String] name # Optional. Overrides the value in Keystore. @@ -4317,8 +4125,8 @@ module Google # Deletes a keystore or truststore. # @param [String] name - # Required. The name of keystore to delete. Must be of the form - # `organizations/`organization`/environments/`environment`/keystores/`keystore``. + # Required. The name of keystore to delete. Must be of the form `organizations/` + # organization`/environments/`environment`/keystores/`keystore``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4348,8 +4156,8 @@ module Google # Gets a keystore or truststore. # @param [String] name - # Required. The name of keystore. Must be of the form - # `organizations/`organization`/environments/`environment`/keystores/`keystore``. + # Required. The name of keystore. Must be of the form `organizations/` + # organization`/environments/`environment`/keystores/`keystore``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4377,38 +4185,35 @@ module Google execute_or_queue_command(command, &block) end - # Creates an alias from a key, certificate pair. - # The structure of the request is controlled by the `format` query parameter: - # * `keycertfile` - Separate PEM-encoded key and certificate files are - # uploaded. The request must have `Content-Type: multipart/form-data` and - # include fields `keyFile` and `certFile`. If uploading to a truststore, - # omit `keyFile`. - # * `pkcs12` - A PKCS12 file is uploaded. The request must have - # `Content-Type: multipart/form-data` with the file provided in the only - # field. - # * `selfsignedcert` - A new private key and certificate are generated. The - # request must have `Content-Type: application/json` and a body of - # CertificateGenerationSpec. + # Creates an alias from a key, certificate pair. The structure of the request is + # controlled by the `format` query parameter: * `keycertfile` - Separate PEM- + # encoded key and certificate files are uploaded. The request must have `Content- + # Type: multipart/form-data` and include fields `keyFile` and `certFile`. If + # uploading to a truststore, omit `keyFile`. * `pkcs12` - A PKCS12 file is + # uploaded. The request must have `Content-Type: multipart/form-data` with the + # file provided in the only field. * `selfsignedcert` - A new private key and + # certificate are generated. The request must have `Content-Type: application/ + # json` and a body of CertificateGenerationSpec. # @param [String] parent - # Required. The name of the keystore. Must be of the form - # `organizations/`organization`/environments/`environment`/keystores/`keystore``. + # Required. The name of the keystore. Must be of the form `organizations/` + # organization`/environments/`environment`/keystores/`keystore``. # @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object # @param [String] _password # The password for the private key file, if it exists. # @param [String] alias_ - # The alias for the key, certificate pair. Values must match - # regular expression `[\w\s-.]`1,255``. This must be provided for all formats - # except 'selfsignedcert'; self-signed certs may specify the alias in either - # this parameter or the JSON body. + # The alias for the key, certificate pair. Values must match regular expression ` + # [\w\s-.]`1,255``. This must be provided for all formats except 'selfsignedcert' + # ; self-signed certs may specify the alias in either this parameter or the JSON + # body. # @param [String] format - # Required. The format of the data. Must be either `selfsignedcert`, - # `keycertfile`, or `pkcs12`. + # Required. The format of the data. Must be either `selfsignedcert`, ` + # keycertfile`, or `pkcs12`. # @param [Boolean] ignore_expiry_validation # If `true`, no expiry validation will be performed. # @param [Boolean] ignore_newline_validation # If `true`, do not throw an error when the file contains a chain with no - # newline between each certificate. By default, a newline is needed between - # each certificate in a chain. + # newline between each certificate. By default, a newline is needed between each + # certificate in a chain. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4443,12 +4248,11 @@ module Google execute_or_queue_command(command, &block) end - # Generates a PKCS #10 Certificate Signing Request for the private key in - # an alias. + # Generates a PKCS #10 Certificate Signing Request for the private key in an + # alias. # @param [String] name - # Required. The name of the alias. Must be of the form - # `organizations/`organization`/environments/`environment`/keystores/`keystore`/ - # aliases/`alias``. + # Required. The name of the alias. Must be of the form `organizations/` + # organization`/environments/`environment`/keystores/`keystore`/aliases/`alias``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4478,9 +4282,8 @@ module Google # Deletes an alias. # @param [String] name - # Required. The name of the alias. Must be of the form - # `organizations/`organization`/environments/`environment`/keystores/`keystore`/ - # aliases/`alias``. + # Required. The name of the alias. Must be of the form `organizations/` + # organization`/environments/`environment`/keystores/`keystore`/aliases/`alias``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4510,9 +4313,8 @@ module Google # Gets an alias. # @param [String] name - # Required. The name of the alias. Must be of the form - # `organizations/`organization`/environments/`environment`/keystores/`keystore`/ - # aliases/`alias``. + # Required. The name of the alias. Must be of the form `organizations/` + # organization`/environments/`environment`/keystores/`keystore`/aliases/`alias``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4542,9 +4344,8 @@ module Google # Gets the certificate from an alias in PEM-encoded form. # @param [String] name - # Required. The name of the alias. Must be of the form - # `organizations/`organization`/environments/`environment`/keystores/`keystore`/ - # aliases/`alias``. + # Required. The name of the alias. Must be of the form `organizations/` + # organization`/environments/`environment`/keystores/`keystore`/aliases/`alias``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4574,16 +4375,15 @@ module Google # Updates the certificate in an alias. # @param [String] name - # Required. The name of the alias. Must be of the form - # `organizations/`organization`/environments/`environment`/keystores/`keystore`/ - # aliases/`alias``. + # Required. The name of the alias. Must be of the form `organizations/` + # organization`/environments/`environment`/keystores/`keystore`/aliases/`alias``. # @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object # @param [Boolean] ignore_expiry_validation # Required. If `true`, no expiry validation will be performed. # @param [Boolean] ignore_newline_validation # If `true`, do not throw an error when the file contains a chain with no - # newline between each certificate. By default, a newline is needed between - # each certificate in a chain. + # newline between each certificate. By default, a newline is needed between each + # certificate in a chain. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4618,8 +4418,7 @@ module Google # Creates a key value map in an environment. # @param [String] parent # Required. The name of the environment in which to create the key value map. - # Must be of the form - # `organizations/`organization`/environments/`environment``. + # Must be of the form `organizations/`organization`/environments/`environment``. # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1KeyValueMap] google_cloud_apigee_v1_key_value_map_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4652,10 +4451,8 @@ module Google # Delete a key value map in an environment. # @param [String] name - # Required. The name of the key value map. - # Must be of the form - # `organizations/`organization`/environments/`environment`/keyvaluemaps/` - # keyvaluemap``. + # Required. The name of the key value map. Must be of the form `organizations/` + # organization`/environments/`environment`/keyvaluemaps/`keyvaluemap``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4683,60 +4480,56 @@ module Google execute_or_queue_command(command, &block) end - # This api is similar to GetStats - # except that the response is less verbose. - # In the current scheme, a query parameter _optimized instructs - # Edge Analytics to change the response but since this behavior - # is not possible with protocol buffer and since this parameter is - # predominantly used by Edge UI, we are introducing a separate api. + # This api is similar to GetStats except that the response is less verbose. In + # the current scheme, a query parameter _optimized instructs Edge Analytics to + # change the response but since this behavior is not possible with protocol + # buffer and since this parameter is predominantly used by Edge UI, we are + # introducing a separate api. # @param [String] name # Required. The resource name for which the interactive query will be executed. - # Must be of the form - # `organizations/`organization_id`/environments/`environment_id/stats/` - # dimensions`` - # Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, - # target_host. The value of dimensions should be comma separated list as - # shown below - # `organizations/`org`/environments/`env`/stats/apiproxy,request_verb` + # Must be of the form `organizations/`organization_id`/environments/` + # environment_id/stats/`dimensions`` Dimensions let you view metrics in + # meaningful groupings. E.g. apiproxy, target_host. The value of dimensions + # should be comma separated list as shown below `organizations/`org`/ + # environments/`env`/stats/apiproxy,request_verb` # @param [String] accuracy # Legacy field: not used anymore. # @param [String] agg_table - # If customers want to query custom aggregate tables, then this parameter - # can be used to specify the table name. If this parameter is skipped, then - # Edge Query will try to retrieve the data from fact tables which will be - # expensive. + # If customers want to query custom aggregate tables, then this parameter can be + # used to specify the table name. If this parameter is skipped, then Edge Query + # will try to retrieve the data from fact tables which will be expensive. # @param [String] filter # Enables drill-down on specific dimension values. # @param [String] limit - # This parameter is used to limit the number of result items. - # Default and the max value is 14400. + # This parameter is used to limit the number of result items. Default and the + # max value is 14400. # @param [String] offset - # Use offset with limit to enable pagination of results. For example, - # to display results 11-20, set limit to '10' and offset to '10'. + # Use offset with limit to enable pagination of results. For example, to display + # results 11-20, set limit to '10' and offset to '10'. # @param [Boolean] realtime # Legacy field: not used anymore. # @param [String] select - # Required. The select parameter contains a comma separated list of metrics. - # E.g. sum(message_count),sum(error_count) + # Required. The select parameter contains a comma separated list of metrics. E.g. + # sum(message_count),sum(error_count) # @param [Boolean] sonar # This parameter routes the query to api monitoring service for last hour. # @param [String] sort - # This parameter specifies if the sort order should be ascending or - # descending Supported values are DESC and ASC. + # This parameter specifies if the sort order should be ascending or descending + # Supported values are DESC and ASC. # @param [String] sortby # Comma separated list of columns to sort the final result. # @param [String] time_range - # Required. Time interval for the interactive query. - # Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59 + # Required. Time interval for the interactive query. Time range is specified as + # start~end E.g. 04/15/2017 00:00~05/15/2017 23:59 # @param [String] time_unit - # A value of second, minute, hour, day, week, month. - # Time Unit specifies the granularity of metrics returned. + # A value of second, minute, hour, day, week, month. Time Unit specifies the + # granularity of metrics returned. # @param [String] topk - # Take 'top k' results from results, for example, to return the top 5 - # results 'topk=5'. + # Take 'top k' results from results, for example, to return the top 5 results ' + # topk=5'. # @param [Boolean] ts_ascending - # Lists timestamps in ascending order if set to true. Recommend setting - # this value to true if you are using sortby with sort=DESC. + # Lists timestamps in ascending order if set to true. Recommend setting this + # value to true if you are using sortby with sort=DESC. # @param [String] tzo # This parameters contains the timezone offset value. # @param [String] fields @@ -4781,13 +4574,13 @@ module Google execute_or_queue_command(command, &block) end - # Submit a query to be processed in the background. - # If the submission of the query succeeds, the API returns a 201 status and - # an ID that refer to the query. In addition to the HTTP status 201, the - # `state` of "enqueued" means that the request succeeded. + # Submit a query to be processed in the background. If the submission of the + # query succeeds, the API returns a 201 status and an ID that refer to the query. + # In addition to the HTTP status 201, the `state` of "enqueued" means that the + # request succeeded. # @param [String] parent - # Required. The parent resource name. - # Must be of the form `organizations/`org`/environments/`env``. + # Required. The parent resource name. Must be of the form `organizations/`org`/ + # environments/`env``. # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Query] google_cloud_apigee_v1_query_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4818,12 +4611,12 @@ module Google execute_or_queue_command(command, &block) end - # Get query status - # If the query is still in progress, the `state` is set to "running" - # After the query has completed successfully, `state` is set to "completed" + # Get query status If the query is still in progress, the `state` is set to " + # running" After the query has completed successfully, `state` is set to " + # completed" # @param [String] name - # Required. Name of the asynchronous query to get. Must be of the form - # `organizations/`org`/environments/`env`/queries/`queryId``. + # Required. Name of the asynchronous query to get. Must be of the form ` + # organizations/`org`/environments/`env`/queries/`queryId``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4851,15 +4644,14 @@ module Google execute_or_queue_command(command, &block) end - # After the query is completed, use this API to retrieve the results. - # If the request succeeds, and there is a non-zero result set, the result is - # downloaded to the client as a zipped JSON file. - # The name of the downloaded file will be: - # OfflineQueryResult-.zip - # Example: `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f-318d0cb961bd.zip` + # After the query is completed, use this API to retrieve the results. If the + # request succeeds, and there is a non-zero result set, the result is downloaded + # to the client as a zipped JSON file. The name of the downloaded file will be: + # OfflineQueryResult-.zip Example: `OfflineQueryResult-9cfc0d85-0f30-46d6-ae6f- + # 318d0cb961bd.zip` # @param [String] name - # Required. Name of the asynchronous query result to get. Must be of the - # form `organizations/`org`/environments/`env`/queries/`queryId`/result`. + # Required. Name of the asynchronous query result to get. Must be of the form ` + # organizations/`org`/environments/`env`/queries/`queryId`/result`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4889,15 +4681,13 @@ module Google # Return a list of Asynchronous Queries # @param [String] parent - # Required. The parent resource name. - # Must be of the form `organizations/`org`/environments/`env``. + # Required. The parent resource name. Must be of the form `organizations/`org`/ + # environments/`env``. # @param [String] dataset - # Filter response list by dataset. - # Example: `api`, `mint` + # Filter response list by dataset. Example: `api`, `mint` # @param [String] from - # Filter response list by returning asynchronous queries that - # created after this date time. - # Time must be in ISO date-time format like '2011-12-03T10:15:30Z'. + # Filter response list by returning asynchronous queries that created after this + # date time. Time must be in ISO date-time format like '2011-12-03T10:15:30Z'. # @param [String] incl_queries_without_report # Flag to include asynchronous queries that don't have a report denifition. # @param [String] status @@ -4905,9 +4695,9 @@ module Google # @param [String] submitted_by # Filter response list by user who submitted queries. # @param [String] to - # Filter response list by returning asynchronous queries that - # created before this date time. - # Time must be in ISO date-time format like '2011-12-03T10:16:30Z'. + # Filter response list by returning asynchronous queries that created before + # this date time. Time must be in ISO date-time format like '2011-12-03T10:16: + # 30Z'. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4943,8 +4733,8 @@ module Google # Creates a Reference in the specified environment. # @param [String] parent - # Required. The parent environment name under which the Reference will - # be created. Must be of the form `organizations/`org`/environments/`env``. + # Required. The parent environment name under which the Reference will be + # created. Must be of the form `organizations/`org`/environments/`env``. # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] google_cloud_apigee_v1_reference_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4975,11 +4765,11 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a Reference from an environment. Returns the deleted - # Reference resource. + # Deletes a Reference from an environment. Returns the deleted Reference + # resource. # @param [String] name - # Required. The name of the Reference to delete. Must be - # of the form `organizations/`org`/environments/`env`/references/`ref``. + # Required. The name of the Reference to delete. Must be of the form ` + # organizations/`org`/environments/`env`/references/`ref``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5009,8 +4799,8 @@ module Google # Gets a Reference resource. # @param [String] name - # Required. The name of the Reference to get. Must be of the form - # `organizations/`org`/environments/`env`/references/`ref``. + # Required. The name of the Reference to get. Must be of the form `organizations/ + # `org`/environments/`env`/references/`ref``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5038,12 +4828,12 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing Reference. Note that this operation has PUT - # semantics; it will replace the entirety of the existing Reference with - # the resource in the request body. + # Updates an existing Reference. Note that this operation has PUT semantics; it + # will replace the entirety of the existing Reference with the resource in the + # request body. # @param [String] name - # Required. The name of the Reference to update. Must be of the form - # `organizations/`org`/environments/`env`/references/`ref``. + # Required. The name of the Reference to update. Must be of the form ` + # organizations/`org`/environments/`env`/references/`ref``. # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Reference] google_cloud_apigee_v1_reference_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -5074,19 +4864,16 @@ module Google execute_or_queue_command(command, &block) end - # Creates a resource file. - # Specify the `Content-Type` as `application/octet-stream` or - # `multipart/form-data`. - # For more information about resource files, see - # [Resource files](/api-platform/develop/resource-files). + # Creates a resource file. Specify the `Content-Type` as `application/octet- + # stream` or `multipart/form-data`. For more information about resource files, + # see [Resource files](/api-platform/develop/resource-files). # @param [String] parent # Required. Name of the environment in which to create the resource file in the - # following format: - # `organizations/`org`/environments/`env``. + # following format: `organizations/`org`/environments/`env``. # @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object # @param [String] name - # Required. Name of the resource file. Must match the regular expression: - # [a-zA-Z0-9:/\\!@#$%^&``\[\]()+\-=,.~'` ]`1,255` + # Required. Name of the resource file. Must match the regular expression: [a-zA- + # Z0-9:/\\!@#$%^&``\[\]()+\-=,.~'` ]`1,255` # @param [String] type # Required. Resource file type. `` resource_file_type `` # @param [String] fields @@ -5120,17 +4907,16 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a resource file. - # For more information about resource files, see - # [Resource files](/api-platform/develop/resource-files). + # Deletes a resource file. For more information about resource files, see [ + # Resource files](/api-platform/develop/resource-files). # @param [String] parent - # Required. Name of the environment in the following format: - # `organizations/`org`/environments/`env``. + # Required. Name of the environment in the following format: `organizations/`org` + # /environments/`env``. # @param [String] type # Required. Resource file type. `` resource_file_type `` # @param [String] name - # Required. ID of the resource file to delete. Must match the regular - # expression: [a-zA-Z0-9:/\\!@#$%^&``\[\]()+\-=,.~'` ]`1,255` + # Required. ID of the resource file to delete. Must match the regular expression: + # [a-zA-Z0-9:/\\!@#$%^&``\[\]()+\-=,.~'` ]`1,255` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5160,17 +4946,16 @@ module Google execute_or_queue_command(command, &block) end - # Gets the contents of a resource file. - # For more information about resource files, see - # [Resource files](/api-platform/develop/resource-files). + # Gets the contents of a resource file. For more information about resource + # files, see [Resource files](/api-platform/develop/resource-files). # @param [String] parent - # Required. Name of the environment in the following format: - # `organizations/`org`/environments/`env``. + # Required. Name of the environment in the following format: `organizations/`org` + # /environments/`env``. # @param [String] type - # Required. Resource file type. `` resource_file_type `` + # Required. Resource file type. `` resource_file_type `` # @param [String] name - # Required. ID of the resource file. Must match the regular - # expression: [a-zA-Z0-9:/\\!@#$%^&``\[\]()+\-=,.~'` ]`1,255` + # Required. ID of the resource file. Must match the regular expression: [a-zA-Z0- + # 9:/\\!@#$%^&``\[\]()+\-=,.~'` ]`1,255` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5200,17 +4985,13 @@ module Google execute_or_queue_command(command, &block) end - # Lists all resource files. - # For more information about resource files, see - # [Resource files](/api-platform/develop/resource-files). + # Lists all resource files. For more information about resource files, see [ + # Resource files](/api-platform/develop/resource-files). # @param [String] parent # Required. Name of the environment in which to list resource files in the - # following - # format: - # `organizations/`org`/environments/`env``. + # following format: `organizations/`org`/environments/`env``. # @param [String] type - # Optional. Type of resource files to list. - # `` resource_file_type `` + # Optional. Type of resource files to list. `` resource_file_type `` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5239,17 +5020,13 @@ module Google execute_or_queue_command(command, &block) end - # Lists all resource files. - # For more information about resource files, see - # [Resource files](/api-platform/develop/resource-files). + # Lists all resource files. For more information about resource files, see [ + # Resource files](/api-platform/develop/resource-files). # @param [String] parent # Required. Name of the environment in which to list resource files in the - # following - # format: - # `organizations/`org`/environments/`env``. + # following format: `organizations/`org`/environments/`env``. # @param [String] type - # Optional. Type of resource files to list. - # `` resource_file_type `` + # Optional. Type of resource files to list. `` resource_file_type `` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5278,19 +5055,17 @@ module Google execute_or_queue_command(command, &block) end - # Updates a resource file. - # Specify the `Content-Type` as `application/octet-stream` or - # `multipart/form-data`. - # For more information about resource files, see - # [Resource files](/api-platform/develop/resource-files). + # Updates a resource file. Specify the `Content-Type` as `application/octet- + # stream` or `multipart/form-data`. For more information about resource files, + # see [Resource files](/api-platform/develop/resource-files). # @param [String] parent - # Required. Name of the environment in the following format: - # `organizations/`org`/environments/`env``. + # Required. Name of the environment in the following format: `organizations/`org` + # /environments/`env``. # @param [String] type # Required. Resource file type. `` resource_file_type `` # @param [String] name - # Required. ID of the resource file to update. Must match the regular - # expression: [a-zA-Z0-9:/\\!@#$%^&``\[\]()+\-=,.~'` ]`1,255` + # Required. ID of the resource file to update. Must match the regular expression: + # [a-zA-Z0-9:/\\!@#$%^&``\[\]()+\-=,.~'` ]`1,255` # @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -5326,8 +5101,7 @@ module Google # Lists all deployments of a shared flow in an environment. # @param [String] parent # Required. Name representing a shared flow in an environment in the following - # format: - # `organizations/`org`/environments/`env`/sharedflows/`sharedflow`` + # format: `organizations/`org`/environments/`env`/sharedflows/`sharedflow`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5391,9 +5165,8 @@ module Google # runtime pods. # @param [String] name # Required. Name representing a shared flow in an environment in the following - # format: - # `organizations/`org`/environments/`env`/sharedflows/`sharedflow`/revisions/` - # rev`` + # format: `organizations/`org`/environments/`env`/sharedflows/`sharedflow`/ + # revisions/`rev`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5421,62 +5194,58 @@ module Google execute_or_queue_command(command, &block) end - # Retrieve metrics grouped by dimensions. - # The types of metrics you can retrieve include traffic, message counts, - # API call latency, response size, and cache hits and counts. - # Dimensions let you view metrics in meaningful groups. - # The stats api does accept dimensions as path params. The dimensions are - # optional in which case the metrics are computed on the entire data - # for the given timerange. + # Retrieve metrics grouped by dimensions. The types of metrics you can retrieve + # include traffic, message counts, API call latency, response size, and cache + # hits and counts. Dimensions let you view metrics in meaningful groups. The + # stats api does accept dimensions as path params. The dimensions are optional + # in which case the metrics are computed on the entire data for the given + # timerange. # @param [String] name # Required. The resource name for which the interactive query will be executed. - # Must be of the form - # `organizations/`organization_id`/environments/`environment_id/stats/` - # dimensions`` - # Dimensions let you view metrics in meaningful groupings. E.g. apiproxy, - # target_host. The value of dimensions should be comma separated list as - # shown below - # `organizations/`org`/environments/`env`/stats/apiproxy,request_verb` + # Must be of the form `organizations/`organization_id`/environments/` + # environment_id/stats/`dimensions`` Dimensions let you view metrics in + # meaningful groupings. E.g. apiproxy, target_host. The value of dimensions + # should be comma separated list as shown below `organizations/`org`/ + # environments/`env`/stats/apiproxy,request_verb` # @param [String] accuracy - # Legacy field: not used anymore. - # This field is present to support UI calls which still use this parameter. + # Legacy field: not used anymore. This field is present to support UI calls + # which still use this parameter. # @param [String] agg_table - # If customers want to query custom aggregate tables, then this parameter - # can be used to specify the table name. If this parameter is skipped, then - # Edge Query will try to retrieve the data from fact tables which will be - # expensive. + # If customers want to query custom aggregate tables, then this parameter can be + # used to specify the table name. If this parameter is skipped, then Edge Query + # will try to retrieve the data from fact tables which will be expensive. # @param [String] filter # Enables drill-down on specific dimension values # @param [String] limit - # This parameter is used to limit the number of result items. - # Default and the max value is 14400. + # This parameter is used to limit the number of result items. Default and the + # max value is 14400. # @param [String] offset - # Use offset with limit to enable pagination of results. For example, - # to display results 11-20, set limit to '10' and offset to '10'. + # Use offset with limit to enable pagination of results. For example, to display + # results 11-20, set limit to '10' and offset to '10'. # @param [Boolean] realtime # Legacy field: not used anymore. # @param [String] select - # The select parameter contains a comma separated list of metrics. - # E.g. sum(message_count),sum(error_count) + # The select parameter contains a comma separated list of metrics. E.g. sum( + # message_count),sum(error_count) # @param [Boolean] sonar # This parameter routes the query to api monitoring service for last hour. # @param [String] sort - # This parameter specifies if the sort order should be ascending or - # descending Supported values are DESC and ASC. + # This parameter specifies if the sort order should be ascending or descending + # Supported values are DESC and ASC. # @param [String] sortby # Comma separated list of columns to sort the final result. # @param [String] time_range - # Time interval for the interactive query. - # Time range is specified as start~end E.g. 04/15/2017 00:00~05/15/2017 23:59 + # Time interval for the interactive query. Time range is specified as start~end + # E.g. 04/15/2017 00:00~05/15/2017 23:59 # @param [String] time_unit - # A value of second, minute, hour, day, week, month. - # Time Unit specifies the granularity of metrics returned. + # A value of second, minute, hour, day, week, month. Time Unit specifies the + # granularity of metrics returned. # @param [String] topk - # Take 'top k' results from results, for example, to return the top 5 - # results 'topk=5'. + # Take 'top k' results from results, for example, to return the top 5 results ' + # topk=5'. # @param [Boolean] ts_ascending - # Lists timestamps in ascending order if set to true. Recommend setting - # this value to true if you are using sortby with sort=DESC. + # Lists timestamps in ascending order if set to true. Recommend setting this + # value to true if you are using sortby with sort=DESC. # @param [String] tzo # This parameters contains the timezone offset value. # @param [String] fields @@ -5523,12 +5292,12 @@ module Google # Creates a TargetServer in the specified environment. # @param [String] parent - # Required. The parent environment name under which the TargetServer will - # be created. Must be of the form `organizations/`org`/environments/`env``. + # Required. The parent environment name under which the TargetServer will be + # created. Must be of the form `organizations/`org`/environments/`env``. # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] google_cloud_apigee_v1_target_server_object # @param [String] name - # Optional. The ID to give the TargetServer. This will overwrite the - # value in TargetServer. + # Optional. The ID to give the TargetServer. This will overwrite the value in + # TargetServer. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5559,12 +5328,11 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a TargetServer from an environment. Returns the deleted - # TargetServer resource. + # Deletes a TargetServer from an environment. Returns the deleted TargetServer + # resource. # @param [String] name - # Required. The name of the TargetServer to delete. Must be - # of the form - # `organizations/`org`/environments/`env`/targetservers/`target_server_id``. + # Required. The name of the TargetServer to delete. Must be of the form ` + # organizations/`org`/environments/`env`/targetservers/`target_server_id``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5594,8 +5362,8 @@ module Google # Gets a TargetServer resource. # @param [String] name - # Required. The name of the TargetServer to get. Must be of the form - # `organizations/`org`/environments/`env`/targetservers/`target_server_id``. + # Required. The name of the TargetServer to get. Must be of the form ` + # organizations/`org`/environments/`env`/targetservers/`target_server_id``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5623,12 +5391,12 @@ module Google execute_or_queue_command(command, &block) end - # Updates an existing TargetServer. Note that this operation has PUT - # semantics; it will replace the entirety of the existing TargetServer with - # the resource in the request body. + # Updates an existing TargetServer. Note that this operation has PUT semantics; + # it will replace the entirety of the existing TargetServer with the resource in + # the request body. # @param [String] name - # Required. The name of the TargetServer to replace. Must be of the form - # `organizations/`org`/environments/`env`/targetservers/`target_server_id``. + # Required. The name of the TargetServer to replace. Must be of the form ` + # organizations/`org`/environments/`env`/targetservers/`target_server_id``. # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1TargetServer] google_cloud_apigee_v1_target_server_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -5660,12 +5428,11 @@ module Google end # Creates an Apigee runtime instance. The instance is accessible from the - # authorized network configured on the organization. - # **Note:** Not supported for Apigee hybrid. + # authorized network configured on the organization. **Note:** Not supported for + # Apigee hybrid. # @param [String] parent # Required. Name of the organization. Use the following structure in your - # request: - # `organizations/`org``. + # request: `organizations/`org``. # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1Instance] google_cloud_apigee_v1_instance_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -5696,12 +5463,11 @@ module Google execute_or_queue_command(command, &block) end - # Deletes an Apigee runtime instance. The instance stops serving - # requests and the runtime data is deleted. - # **Note:** Not supported for Apigee hybrid. + # Deletes an Apigee runtime instance. The instance stops serving requests and + # the runtime data is deleted. **Note:** Not supported for Apigee hybrid. # @param [String] name - # Required. Name of the instance. Use the following structure in your request: - # `organizations/`org`/instance/`instance``. + # Required. Name of the instance. Use the following structure in your request: ` + # organizations/`org`/instance/`instance``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5729,11 +5495,11 @@ module Google execute_or_queue_command(command, &block) end - # Gets the details for an Apigee runtime instance. - # **Note:** Not supported for Apigee hybrid. + # Gets the details for an Apigee runtime instance. **Note:** Not supported for + # Apigee hybrid. # @param [String] name - # Required. Name of the instance. Use the following structure in your request: - # `organizations/`org`/instances/`instance``. + # Required. Name of the instance. Use the following structure in your request: ` + # organizations/`org`/instances/`instance``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5761,17 +5527,16 @@ module Google execute_or_queue_command(command, &block) end - # Lists all Apigee runtime instances for the organization. - # **Note:** Not supported for Apigee hybrid. + # Lists all Apigee runtime instances for the organization. **Note:** Not + # supported for Apigee hybrid. # @param [String] parent # Required. Name of the organization. Use the following structure in your - # request: - # `organizations/`org``. + # request: `organizations/`org``. # @param [Fixnum] page_size # Maximum number of instances to return. Defaults to 25. # @param [String] page_token - # Page token, returned from a previous ListInstances call, that you can - # use to retrieve the next page of content. + # Page token, returned from a previous ListInstances call, that you can use to + # retrieve the next page of content. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -5803,9 +5568,9 @@ module Google # Reports the latest status for a runtime instance. # @param [String] instance - # The name of the instance reporting this status. For SaaS the request - # will be rejected if no instance exists under this name. - # Format is organizations/`org`/instances/`instance` + # The name of the instance reporting this status. For SaaS the request will be + # rejected if no instance exists under this name. Format is organizations/`org`/ + # instances/`instance` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1ReportInstanceStatusRequest] google_cloud_apigee_v1_report_instance_status_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -5836,11 +5601,11 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new attachment of an environment to an instance. - # **Note:** Not supported for Apigee hybrid. + # Creates a new attachment of an environment to an instance. **Note:** Not + # supported for Apigee hybrid. # @param [String] parent - # Required. Name of the instance. Use the following structure in your request: - # `organizations/`org`/instances/`instance``. + # Required. Name of the instance. Use the following structure in your request: ` + # organizations/`org`/instances/`instance``. # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1InstanceAttachment] google_cloud_apigee_v1_instance_attachment_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -5871,8 +5636,7 @@ module Google execute_or_queue_command(command, &block) end - # Deletes an attachment. - # **Note:** Not supported for Apigee hybrid. + # Deletes an attachment. **Note:** Not supported for Apigee hybrid. # @param [String] name # Required. Name of the attachment. Use the following structure in your request: # `organizations/`org`/instances/`instance`/attachments/`attachment``. @@ -5903,8 +5667,7 @@ module Google execute_or_queue_command(command, &block) end - # Gets an attachment. - # **Note:** Not supported for Apigee hybrid. + # Gets an attachment. **Note:** Not supported for Apigee hybrid. # @param [String] name # Required. Name of the attachment. Use the following structure in your request: # `organizations/`org`/instances/`instance`/attachments/`attachment`` @@ -5935,17 +5698,16 @@ module Google execute_or_queue_command(command, &block) end - # Lists all attachments to an instance. - # **Note:** Not supported for Apigee hybrid. + # Lists all attachments to an instance. **Note:** Not supported for Apigee + # hybrid. # @param [String] parent # Required. Name of the organization. Use the following structure in your - # request: - # `organizations/`org`/instances/`instance`` + # request: `organizations/`org`/instances/`instance`` # @param [Fixnum] page_size # Maximum number of instance attachments to return. Defaults to 25. # @param [String] page_token - # Page token, returned by a previous ListInstanceAttachments call, that you - # can use to retrieve the next page of content. + # Page token, returned by a previous ListInstanceAttachments call, that you can + # use to retrieve the next page of content. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6011,9 +5773,8 @@ module Google # Delete a key value map in an organization. # @param [String] name - # Required. The name of the key value map. - # Must be of the form - # `organizations/`organization`/keyvaluemaps/`keyvaluemap``. + # Required. The name of the key value map. Must be of the form `organizations/` + # organization`/keyvaluemaps/`keyvaluemap``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6041,9 +5802,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 @@ -6073,15 +5833,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 @@ -6120,17 +5879,16 @@ module Google execute_or_queue_command(command, &block) end - # Creates a Custom Report for an Organization. A Custom Report - # provides Apigee Customers to create custom dashboards in addition - # to the standard dashboards which are provided. The Custom Report in its - # simplest form contains specifications about metrics, dimensions and - # filters. It is important to note that the custom report by itself does not - # provide an executable entity. The Edge UI converts the custom report - # definition into an analytics query and displays the result in a chart. + # Creates a Custom Report for an Organization. A Custom Report provides Apigee + # Customers to create custom dashboards in addition to the standard dashboards + # which are provided. The Custom Report in its simplest form contains + # specifications about metrics, dimensions and filters. It is important to note + # that the custom report by itself does not provide an executable entity. The + # Edge UI converts the custom report definition into an analytics query and + # displays the result in a chart. # @param [String] parent - # Required. The parent organization name under which the Custom Report will - # be created. Must be of the form: - # `organizations/`organization_id`/reports` + # Required. The parent organization name under which the Custom Report will be + # created. Must be of the form: `organizations/`organization_id`/reports` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport] google_cloud_apigee_v1_custom_report_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -6163,8 +5921,8 @@ module Google # Deletes an existing custom report definition # @param [String] name - # Required. Custom Report name of the form: - # `organizations/`organization_id`/reports/`report_name`` + # Required. Custom Report name of the form: `organizations/`organization_id`/ + # reports/`report_name`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6194,8 +5952,8 @@ module Google # Retrieve a custom report definition. # @param [String] name - # Required. Custom Report name of the form: - # `organizations/`organization_id`/reports/`report_name`` + # Required. Custom Report name of the form: `organizations/`organization_id`/ + # reports/`report_name`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6225,9 +5983,8 @@ module Google # Return a list of Custom Reports # @param [String] parent - # Required. The parent organization name under which the API product will - # be listed - # `organizations/`organization_id`/reports` + # Required. The parent organization name under which the API product will be + # listed `organizations/`organization_id`/reports` # @param [Boolean] expand # Set to 'true' to get expanded details about each custom report. # @param [String] fields @@ -6260,8 +6017,8 @@ module Google # Update an existing custom report definition # @param [String] name - # Required. Custom Report name of the form: - # `organizations/`organization_id`/reports/`report_name`` + # Required. Custom Report name of the form: `organizations/`organization_id`/ + # reports/`report_name`` # @param [Google::Apis::ApigeeV1::GoogleCloudApigeeV1CustomReport] google_cloud_apigee_v1_custom_report_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -6292,16 +6049,14 @@ module Google execute_or_queue_command(command, &block) end - # Uploads a ZIP-formatted shared flow configuration bundle to an - # organization. If the shared flow already exists, this creates a new - # revision of it. If the shared flow does not exist, this creates it. - # Once imported, the shared flow revision must be deployed before it can be - # accessed at runtime. - # The size limit of a shared flow bundle is 15 MB. + # Uploads a ZIP-formatted shared flow configuration bundle to an organization. + # If the shared flow already exists, this creates a new revision of it. If the + # shared flow does not exist, this creates it. Once imported, the shared flow + # revision must be deployed before it can be accessed at runtime. The size limit + # of a shared flow bundle is 15 MB. # @param [String] parent - # Required. The name of the parent organization under which to create the - # shared flow. Must be of the form: - # `organizations/`organization_id`` + # Required. The name of the parent organization under which to create the shared + # flow. Must be of the form: `organizations/`organization_id`` # @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object # @param [String] action # Required. Must be set to either `import` or `validate`. @@ -6341,8 +6096,8 @@ module Google # Deletes a shared flow and all it's revisions. The shared flow must be # undeployed before you can delete it. # @param [String] name - # Required. shared flow name of the form: - # `organizations/`organization_id`/sharedflows/`shared_flow_id`` + # Required. shared flow name of the form: `organizations/`organization_id`/ + # sharedflows/`shared_flow_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6372,9 +6127,8 @@ module Google # Gets a shared flow by name, including a list of its revisions. # @param [String] name - # Required. The name of the shared flow to get. Must be of the - # form: - # `organizations/`organization_id`/sharedflows/`shared_flow_id`` + # Required. The name of the shared flow to get. Must be of the form: ` + # organizations/`organization_id`/sharedflows/`shared_flow_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6404,9 +6158,8 @@ module Google # Lists all shared flows in the organization. # @param [String] parent - # Required. The name of the parent organization under which to get shared - # flows. Must be of the form: - # `organizations/`organization_id`` + # Required. The name of the parent organization under which to get shared flows. + # Must be of the form: `organizations/`organization_id`` # @param [Boolean] include_meta_data # Indicates whether to include shared flow metadata in the response. # @param [Boolean] include_revisions @@ -6443,9 +6196,7 @@ module Google # Lists all deployments of a shared flow. # @param [String] parent # Required. Name of the shared flow for which to return deployment information - # in the - # following format: - # `organizations/`org`/sharedflows/`sharedflow`` + # in the following format: `organizations/`org`/sharedflows/`sharedflow`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6473,11 +6224,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a shared flow and all associated policies, resources, and - # revisions. You must undeploy the shared flow before deleting it. + # Deletes a shared flow and all associated policies, resources, and revisions. + # You must undeploy the shared flow before deleting it. # @param [String] name - # Required. The name of the shared flow revision to delete. Must be of the - # form: + # Required. The name of the shared flow revision to delete. Must be of the form: # `organizations/`organization_id`/sharedflows/`shared_flow_id`/revisions/` # revision_id`` # @param [String] fields @@ -6507,17 +6257,16 @@ module Google execute_or_queue_command(command, &block) end - # Gets a revision of a shared flow. - # If `format=bundle` is passed, it instead outputs a shared flow revision as - # a ZIP-formatted bundle of code and config files. + # Gets a revision of a shared flow. If `format=bundle` is passed, it instead + # outputs a shared flow revision as a ZIP-formatted bundle of code and config + # files. # @param [String] name - # Required. The name of the shared flow revision to get. Must be of the - # form: - # `organizations/`organization_id`/sharedflows/`shared_flow_id`/revisions/` + # Required. The name of the shared flow revision to get. Must be of the form: ` + # organizations/`organization_id`/sharedflows/`shared_flow_id`/revisions/` # revision_id`` # @param [String] format - # Specify `bundle` to export the contents of the shared flow bundle. - # Otherwise, the bundle metadata is returned. + # Specify `bundle` to export the contents of the shared flow bundle. Otherwise, + # the bundle metadata is returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6547,20 +6296,18 @@ module Google end # Updates a shared flow revision. This operation is only allowed on revisions - # which have never been deployed. After deployment a revision becomes - # immutable, even if it becomes undeployed. - # The payload is a ZIP-formatted shared flow. Content type must be either - # multipart/form-data or application/octet-stream. + # which have never been deployed. After deployment a revision becomes immutable, + # even if it becomes undeployed. The payload is a ZIP-formatted shared flow. + # Content type must be either multipart/form-data or application/octet-stream. # @param [String] name - # Required. The name of the shared flow revision to update. - # Must be of the form: + # Required. The name of the shared flow revision to update. Must be of the form: # `organizations/`organization_id`/sharedflows/`shared_flow_id`/revisions/` # revision_id`` # @param [Google::Apis::ApigeeV1::GoogleApiHttpBody] google_api_http_body_object # @param [Boolean] validate - # Ignored. All uploads are validated regardless of the value of this field. - # It is kept for compatibility with existing APIs. Must be `true` or `false` - # if provided. + # Ignored. All uploads are validated regardless of the value of this field. It + # is kept for compatibility with existing APIs. Must be `true` or `false` if + # provided. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -6594,9 +6341,8 @@ module Google # Lists all deployments of a shared flow revision. # @param [String] parent # Required. Name of the API proxy revision for which to return deployment - # information - # in the following format: - # `organizations/`org`/sharedflows/`sharedflow`/revisions/`rev``. + # information in the following format: `organizations/`org`/sharedflows/` + # sharedflow`/revisions/`rev``. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/chromeuxreport_v1.rb b/generated/google/apis/chromeuxreport_v1.rb index f36794b77..b2e6bea20 100644 --- a/generated/google/apis/chromeuxreport_v1.rb +++ b/generated/google/apis/chromeuxreport_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/web/tools/chrome-user-experience-report/api/reference module ChromeuxreportV1 VERSION = 'V1' - REVISION = '20200720' + REVISION = '20200803' end end end diff --git a/generated/google/apis/chromeuxreport_v1/classes.rb b/generated/google/apis/chromeuxreport_v1/classes.rb index 15a82d65a..8d18dfcac 100644 --- a/generated/google/apis/chromeuxreport_v1/classes.rb +++ b/generated/google/apis/chromeuxreport_v1/classes.rb @@ -22,25 +22,23 @@ module Google module Apis module ChromeuxreportV1 - # A bin is a discrete portion of data spanning from start to end, or if no - # end is given, then from start to +inf. - # A bin's start and end values are given in the value type of the metric it - # represents. For example, "first contentful paint" is measured in - # milliseconds and exposed as ints, therefore its metric bins will use int32s - # for its start and end types. However, "cumulative layout shift" is measured - # in unitless decimals and is exposed as a decimal encoded as a string, - # therefore its metric bins will use strings for its value type. + # A bin is a discrete portion of data spanning from start to end, or if no end + # is given, then from start to +inf. A bin's start and end values are given in + # the value type of the metric it represents. For example, "first contentful + # paint" is measured in milliseconds and exposed as ints, therefore its metric + # bins will use int32s for its start and end types. However, "cumulative layout + # shift" is measured in unitless decimals and is exposed as a decimal encoded as + # a string, therefore its metric bins will use strings for its value type. class Bin include Google::Apis::Core::Hashable - # The proportion of users that experienced this bin's value for the given - # metric. + # The proportion of users that experienced this bin's value for the given metric. # Corresponds to the JSON property `density` # @return [Float] attr_accessor :density - # End is the end of the data bin. If end is not populated, then the bin has - # no end and is valid from start to +inf. + # End is the end of the data bin. If end is not populated, then the bin has no + # end and is valid from start to +inf. # Corresponds to the JSON property `end` # @return [Object] attr_accessor :end @@ -66,34 +64,31 @@ module Google class Key include Google::Apis::Core::Hashable - # The effective connection type is the general connection class that all - # users experienced for this record. This field uses the values ["offline", - # "slow-2G", "2G", "3G", "4G"] as specified in: - # https://wicg.github.io/netinfo/#effective-connection-types - # If the effective connection type is unspecified, then aggregated data - # over all effective connection types will be returned. + # The effective connection type is the general connection class that all users + # experienced for this record. This field uses the values ["offline", "slow-2G", + # "2G", "3G", "4G"] as specified in: https://wicg.github.io/netinfo/#effective- + # connection-types If the effective connection type is unspecified, then + # aggregated data over all effective connection types will be returned. # Corresponds to the JSON property `effectiveConnectionType` # @return [String] attr_accessor :effective_connection_type - # The form factor is the device class that all users used to access the - # site for this record. - # If the form factor is unspecified, then aggregated data over all form - # factors will be returned. + # The form factor is the device class that all users used to access the site for + # this record. If the form factor is unspecified, then aggregated data over all + # form factors will be returned. # Corresponds to the JSON property `formFactor` # @return [String] attr_accessor :form_factor - # Origin specifies the origin that this record is for. - # Note: When specifying an origin, data for loads under this origin over - # all pages are aggregated into origin level user experience data. + # Origin specifies the origin that this record is for. Note: When specifying an + # origin, data for loads under this origin over all pages are aggregated into + # origin level user experience data. # Corresponds to the JSON property `origin` # @return [String] attr_accessor :origin - # Url specifies a specific url that this record is for. - # Note: When specifying a "url" only data for that specific url will be - # aggregated. + # Url specifies a specific url that this record is for. Note: When specifying a " + # url" only data for that specific url will be aggregated. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -112,8 +107,8 @@ module Google end # A `metric` is a set of user experience data for a single web performance - # metric, like "first contentful paint". It contains a summary histogram of - # real world Chrome usage as a series of `bins`. + # metric, like "first contentful paint". It contains a summary histogram of real + # world Chrome usage as a series of `bins`. class Metric include Google::Apis::Core::Hashable @@ -124,8 +119,8 @@ module Google attr_accessor :histogram # Percentiles contains synthetic values of a metric at a given statistical - # percentile. These are used for estimating a metric's value as experienced - # by a percentage of users out of the total number of users. + # percentile. These are used for estimating a metric's value as experienced by a + # percentage of users out of the total number of users. # Corresponds to the JSON property `percentiles` # @return [Google::Apis::ChromeuxreportV1::Percentiles] attr_accessor :percentiles @@ -142,8 +137,8 @@ module Google end # Percentiles contains synthetic values of a metric at a given statistical - # percentile. These are used for estimating a metric's value as experienced - # by a percentage of users out of the total number of users. + # percentile. These are used for estimating a metric's value as experienced by a + # percentage of users out of the total number of users. class Percentiles include Google::Apis::Core::Hashable @@ -162,49 +157,44 @@ module Google end end - # Request payload sent by a physical web client. - # This request includes all necessary context to load a particular - # user experience record. + # Request payload sent by a physical web client. This request includes all + # necessary context to load a particular user experience record. class QueryRequest include Google::Apis::Core::Hashable # The effective connection type is a query dimension that specifies the # effective network class that the record's data should belong to. This field # uses the values ["offline", "slow-2G", "2G", "3G", "4G"] as specified in: - # https://wicg.github.io/netinfo/#effective-connection-types - # Note: If no effective connection type is specified, then a special record - # with aggregated data over all effective connection types will be returned. + # https://wicg.github.io/netinfo/#effective-connection-types Note: If no + # effective connection type is specified, then a special record with aggregated + # data over all effective connection types will be returned. # Corresponds to the JSON property `effectiveConnectionType` # @return [String] attr_accessor :effective_connection_type - # The form factor is a query dimension that specifies the device class that - # the record's data should belong to. - # Note: If no form factor is specified, then a special record with - # aggregated data over all form factors will be returned. + # The form factor is a query dimension that specifies the device class that the + # record's data should belong to. Note: If no form factor is specified, then a + # special record with aggregated data over all form factors will be returned. # Corresponds to the JSON property `formFactor` # @return [String] attr_accessor :form_factor - # The metrics that should be included in the response. - # If none are specified then any metrics found will be returned. - # Allowed values: ["first_contentful_paint", - # "first_input_delay", "largest_contentful_paint", - # "cumulative_layout_shift"] + # The metrics that should be included in the response. If none are specified + # then any metrics found will be returned. Allowed values: [" + # first_contentful_paint", "first_input_delay", "largest_contentful_paint", " + # cumulative_layout_shift"] # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics - # The url pattern "origin" refers to a url pattern that is the origin of - # a website. - # Examples: "https://example.com", "https://cloud.google.com" + # The url pattern "origin" refers to a url pattern that is the origin of a + # website. Examples: "https://example.com", "https://cloud.google.com" # Corresponds to the JSON property `origin` # @return [String] attr_accessor :origin # The url pattern "url" refers to a url pattern that is any arbitrary url. - # Examples: "https://example.com/", - # "https://cloud.google.com/why-google-cloud/" + # Examples: "https://example.com/", "https://cloud.google.com/why-google-cloud/" # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -223,11 +213,11 @@ module Google end end - # Response payload sent back to a physical web client. - # This response contains the record found based on the identiers present in a - # `QueryRequest`. The returned response will have a record, and sometimes - # details on normalization actions taken on the request that were necessary to - # make the request successful. + # Response payload sent back to a physical web client. This response contains + # the record found based on the identiers present in a `QueryRequest`. The + # returned response will have a record, and sometimes details on normalization + # actions taken on the request that were necessary to make the request + # successful. class QueryResponse include Google::Apis::Core::Hashable @@ -266,11 +256,10 @@ module Google # @return [Google::Apis::ChromeuxreportV1::Key] attr_accessor :key - # Metrics is the map of user experience data available for the record defined - # in the key field. Metrics are keyed on the metric name. - # Allowed key values: ["first_contentful_paint", - # "first_input_delay", "largest_contentful_paint", - # "cumulative_layout_shift"] + # Metrics is the map of user experience data available for the record defined in + # the key field. Metrics are keyed on the metric name. Allowed key values: [" + # first_contentful_paint", "first_input_delay", "largest_contentful_paint", " + # cumulative_layout_shift"] # Corresponds to the JSON property `metrics` # @return [Hash] attr_accessor :metrics @@ -293,8 +282,8 @@ module Google class UrlNormalization include Google::Apis::Core::Hashable - # The URL after any normalization actions. This is a valid user experience - # URL that could reasonably be looked up. + # The URL after any normalization actions. This is a valid user experience URL + # that could reasonably be looked up. # Corresponds to the JSON property `normalizedUrl` # @return [String] attr_accessor :normalized_url diff --git a/generated/google/apis/classroom_v1.rb b/generated/google/apis/classroom_v1.rb index a6ddf3062..8196123d2 100644 --- a/generated/google/apis/classroom_v1.rb +++ b/generated/google/apis/classroom_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/classroom/ module ClassroomV1 VERSION = 'V1' - REVISION = '20200714' + REVISION = '20200801' # View and manage announcements in Google Classroom AUTH_CLASSROOM_ANNOUNCEMENTS = 'https://www.googleapis.com/auth/classroom.announcements' diff --git a/generated/google/apis/classroom_v1/classes.rb b/generated/google/apis/classroom_v1/classes.rb index 26a559afd..b7e381f0e 100644 --- a/generated/google/apis/classroom_v1/classes.rb +++ b/generated/google/apis/classroom_v1/classes.rb @@ -26,51 +26,46 @@ module Google class Announcement include Google::Apis::Core::Hashable - # Absolute link to this announcement in the Classroom web UI. - # This is only populated if `state` is `PUBLISHED`. - # Read-only. + # Absolute link to this announcement in the Classroom web UI. This is only + # populated if `state` is `PUBLISHED`. Read-only. # Corresponds to the JSON property `alternateLink` # @return [String] attr_accessor :alternate_link - # Assignee mode of the announcement. - # If unspecified, the default value is `ALL_STUDENTS`. + # Assignee mode of the announcement. If unspecified, the default value is ` + # ALL_STUDENTS`. # Corresponds to the JSON property `assigneeMode` # @return [String] attr_accessor :assignee_mode - # Identifier of the course. - # Read-only. + # Identifier of the course. Read-only. # Corresponds to the JSON property `courseId` # @return [String] attr_accessor :course_id - # Timestamp when this announcement was created. - # Read-only. + # Timestamp when this announcement was created. Read-only. # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time - # Identifier for the user that created the announcement. - # Read-only. + # Identifier for the user that created the announcement. Read-only. # Corresponds to the JSON property `creatorUserId` # @return [String] attr_accessor :creator_user_id - # Classroom-assigned identifier of this announcement, unique per course. - # Read-only. + # Classroom-assigned identifier of this announcement, unique per course. Read- + # only. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Assignee details about a coursework/announcement. - # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. + # Assignee details about a coursework/announcement. This field is set if and + # only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Corresponds to the JSON property `individualStudentsOptions` # @return [Google::Apis::ClassroomV1::IndividualStudentsOptions] attr_accessor :individual_students_options - # Additional materials. - # Announcements must have no more than 20 material items. + # Additional materials. Announcements must have no more than 20 material items. # Corresponds to the JSON property `materials` # @return [Array] attr_accessor :materials @@ -80,21 +75,18 @@ module Google # @return [String] attr_accessor :scheduled_time - # Status of this announcement. - # If unspecified, the default state is `DRAFT`. + # Status of this announcement. If unspecified, the default state is `DRAFT`. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state - # Description of this announcement. - # The text must be a valid UTF-8 string containing no more - # than 30,000 characters. + # Description of this announcement. The text must be a valid UTF-8 string + # containing no more than 30,000 characters. # Corresponds to the JSON property `text` # @return [String] attr_accessor :text - # Timestamp of the most recent change to this announcement. - # Read-only. + # Timestamp of the most recent change to this announcement. Read-only. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -143,13 +135,12 @@ module Google class AssignmentSubmission include Google::Apis::Core::Hashable - # Attachments added by the student. - # Drive files that correspond to materials with a share mode of - # STUDENT_COPY may not exist yet if the student has not accessed the - # assignment in Classroom. - # Some attachment metadata is only populated if the requesting user has - # permission to access it. Identifier and alternate_link fields are always - # available, but others (for example, title) may not be. + # Attachments added by the student. Drive files that correspond to materials + # with a share mode of STUDENT_COPY may not exist yet if the student has not + # accessed the assignment in Classroom. Some attachment metadata is only + # populated if the requesting user has permission to access it. Identifier and + # alternate_link fields are always available, but others (for example, title) + # may not be. # Corresponds to the JSON property `attachments` # @return [Array] attr_accessor :attachments @@ -164,8 +155,8 @@ module Google end end - # Attachment added to student assignment work. - # When creating attachments, setting the `form` field is not supported. + # Attachment added to student assignment work. When creating attachments, + # setting the `form` field is not supported. class Attachment include Google::Apis::Core::Hashable @@ -202,16 +193,14 @@ module Google end end - # A reference to a Cloud Pub/Sub topic. - # To register for notifications, the owner of the topic must grant - # `classroom-notifications@system.gserviceaccount.com` the - # `projects.topics.publish` permission. + # A reference to a Cloud Pub/Sub topic. To register for notifications, the owner + # of the topic must grant `classroom-notifications@system.gserviceaccount.com` + # the `projects.topics.publish` permission. class CloudPubsubTopic include Google::Apis::Core::Hashable - # The `name` field of a Cloud Pub/Sub - # [Topic](https://cloud.google.com/pubsub/docs/reference/rest/v1/projects.topics# - # Topic). + # The `name` field of a Cloud Pub/Sub [Topic](https://cloud.google.com/pubsub/ + # docs/reference/rest/v1/projects.topics#Topic). # Corresponds to the JSON property `topicName` # @return [String] attr_accessor :topic_name @@ -230,124 +219,100 @@ module Google class Course include Google::Apis::Core::Hashable - # Absolute link to this course in the Classroom web UI. - # Read-only. + # Absolute link to this course in the Classroom web UI. Read-only. # Corresponds to the JSON property `alternateLink` # @return [String] attr_accessor :alternate_link # The Calendar ID for a calendar that all course members can see, to which - # Classroom adds events for course work and announcements in the course. - # Read-only. + # Classroom adds events for course work and announcements in the course. Read- + # only. # Corresponds to the JSON property `calendarId` # @return [String] attr_accessor :calendar_id - # The email address of a Google group containing all members of the course. - # This group does not accept email and can only be used for permissions. - # Read-only. + # The email address of a Google group containing all members of the course. This + # group does not accept email and can only be used for permissions. Read-only. # Corresponds to the JSON property `courseGroupEmail` # @return [String] attr_accessor :course_group_email - # Sets of materials that appear on the "about" page of this course. - # Read-only. + # Sets of materials that appear on the "about" page of this course. Read-only. # Corresponds to the JSON property `courseMaterialSets` # @return [Array] attr_accessor :course_material_sets - # State of the course. - # If unspecified, the default state is `PROVISIONED`. + # State of the course. If unspecified, the default state is `PROVISIONED`. # Corresponds to the JSON property `courseState` # @return [String] attr_accessor :course_state - # Creation time of the course. - # Specifying this field in a course update mask results in an error. - # Read-only. + # Creation time of the course. Specifying this field in a course update mask + # results in an error. Read-only. # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time - # Optional description. - # For example, "We'll be learning about the structure of living - # creatures from a combination of textbooks, guest lectures, and lab work. - # Expect to be excited!" - # If set, this field must be a valid UTF-8 string and no longer than 30,000 - # characters. + # Optional description. For example, "We'll be learning about the structure of + # living creatures from a combination of textbooks, guest lectures, and lab work. + # Expect to be excited!" If set, this field must be a valid UTF-8 string and no + # longer than 30,000 characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional heading for the description. - # For example, "Welcome to 10th Grade Biology." - # If set, this field must be a valid UTF-8 string and no longer than 3600 - # characters. + # Optional heading for the description. For example, "Welcome to 10th Grade + # Biology." If set, this field must be a valid UTF-8 string and no longer than + # 3600 characters. # Corresponds to the JSON property `descriptionHeading` # @return [String] attr_accessor :description_heading - # Enrollment code to use when joining this course. - # Specifying this field in a course update mask results in an error. - # Read-only. + # Enrollment code to use when joining this course. Specifying this field in a + # course update mask results in an error. Read-only. # Corresponds to the JSON property `enrollmentCode` # @return [String] attr_accessor :enrollment_code - # Whether or not guardian notifications are enabled for this course. - # Read-only. + # Whether or not guardian notifications are enabled for this course. Read-only. # Corresponds to the JSON property `guardiansEnabled` # @return [Boolean] attr_accessor :guardians_enabled alias_method :guardians_enabled?, :guardians_enabled - # Identifier for this course assigned by Classroom. - # When - # creating a course, - # you may optionally set this identifier to an - # alias string in the - # request to create a corresponding alias. The `id` is still assigned by - # Classroom and cannot be updated after the course is created. - # Specifying this field in a course update mask results in an error. + # Identifier for this course assigned by Classroom. When creating a course, you + # may optionally set this identifier to an alias string in the request to create + # a corresponding alias. The `id` is still assigned by Classroom and cannot be + # updated after the course is created. Specifying this field in a course update + # mask results in an error. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Name of the course. - # For example, "10th Grade Biology". - # The name is required. It must be between 1 and 750 characters and a valid - # UTF-8 string. + # Name of the course. For example, "10th Grade Biology". The name is required. + # It must be between 1 and 750 characters and a valid UTF-8 string. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The identifier of the owner of a course. - # When specified as a parameter of a - # create course request, this - # field is required. - # The identifier can be one of the following: - # * the numeric identifier for the user - # * the email address of the user - # * the string literal `"me"`, indicating the requesting user - # This must be set in a create request. Admins can also specify this field - # in a patch course request to - # transfer ownership. In other contexts, it is read-only. + # The identifier of the owner of a course. When specified as a parameter of a + # create course request, this field is required. The identifier can be one of + # the following: * the numeric identifier for the user * the email address of + # the user * the string literal `"me"`, indicating the requesting user This must + # be set in a create request. Admins can also specify this field in a patch + # course request to transfer ownership. In other contexts, it is read-only. # Corresponds to the JSON property `ownerId` # @return [String] attr_accessor :owner_id - # Optional room location. - # For example, "301". - # If set, this field must be a valid UTF-8 string and no longer than 650 - # characters. + # Optional room location. For example, "301". If set, this field must be a valid + # UTF-8 string and no longer than 650 characters. # Corresponds to the JSON property `room` # @return [String] attr_accessor :room - # Section of the course. - # For example, "Period 2". - # If set, this field must be a valid UTF-8 string and no longer than 2800 - # characters. + # Section of the course. For example, "Period 2". If set, this field must be a + # valid UTF-8 string and no longer than 2800 characters. # Corresponds to the JSON property `section` # @return [String] attr_accessor :section @@ -358,15 +323,14 @@ module Google attr_accessor :teacher_folder # The email address of a Google group containing all teachers of the course. - # This group does not accept email and can only be used for permissions. - # Read-only. + # This group does not accept email and can only be used for permissions. Read- + # only. # Corresponds to the JSON property `teacherGroupEmail` # @return [String] attr_accessor :teacher_group_email - # Time of the most recent update to this course. - # Specifying this field in a course update mask results in an error. - # Read-only. + # Time of the most recent update to this course. Specifying this field in a + # course update mask results in an error. Read-only. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -398,27 +362,24 @@ module Google end end - # Alternative identifier for a course. - # An alias uniquely identifies a course. It must be unique within one of the - # following scopes: - # * domain: A domain-scoped alias is visible to all users within the alias - # creator's domain and can be created only by a domain admin. A domain-scoped - # alias is often used when a course has an identifier external to Classroom. - # * project: A project-scoped alias is visible to any request from an - # application using the Developer Console project ID that created the alias - # and can be created by any project. A project-scoped alias is often used when - # an application has alternative identifiers. A random value can also be used - # to avoid duplicate courses in the event of transmission failures, as retrying - # a request will return `ALREADY_EXISTS` if a previous one has succeeded. + # Alternative identifier for a course. An alias uniquely identifies a course. It + # must be unique within one of the following scopes: * domain: A domain-scoped + # alias is visible to all users within the alias creator's domain and can be + # created only by a domain admin. A domain-scoped alias is often used when a + # course has an identifier external to Classroom. * project: A project-scoped + # alias is visible to any request from an application using the Developer + # Console project ID that created the alias and can be created by any project. A + # project-scoped alias is often used when an application has alternative + # identifiers. A random value can also be used to avoid duplicate courses in the + # event of transmission failures, as retrying a request will return ` + # ALREADY_EXISTS` if a previous one has succeeded. class CourseAlias include Google::Apis::Core::Hashable - # Alias string. The format of the string indicates the desired alias scoping. - # * `d:` indicates a domain-scoped alias. - # Example: `d:math_101` - # * `p:` indicates a project-scoped alias. - # Example: `p:abc123` - # This field has a maximum length of 256 characters. + # Alias string. The format of the string indicates the desired alias scoping. * ` + # d:` indicates a domain-scoped alias. Example: `d:math_101` * `p:` indicates a + # project-scoped alias. Example: `p:abc123` This field has a maximum length of + # 256 characters. # Corresponds to the JSON property `alias` # @return [String] attr_accessor :alias @@ -470,9 +431,9 @@ module Google end end - # A set of materials that appears on the "About" page of the course. - # These materials might include a syllabus, schedule, or other background - # information relating to the course as a whole. + # A set of materials that appears on the "About" page of the course. These + # materials might include a syllabus, schedule, or other background information + # relating to the course as a whole. class CourseMaterialSet include Google::Apis::Core::Hashable @@ -520,15 +481,14 @@ module Google class CourseWork include Google::Apis::Core::Hashable - # Absolute link to this course work in the Classroom web UI. - # This is only populated if `state` is `PUBLISHED`. - # Read-only. + # Absolute link to this course work in the Classroom web UI. This is only + # populated if `state` is `PUBLISHED`. Read-only. # Corresponds to the JSON property `alternateLink` # @return [String] attr_accessor :alternate_link - # Assignee mode of the coursework. - # If unspecified, the default value is `ALL_STUDENTS`. + # Assignee mode of the coursework. If unspecified, the default value is ` + # ALL_STUDENTS`. # Corresponds to the JSON property `assigneeMode` # @return [String] attr_accessor :assignee_mode @@ -538,81 +498,72 @@ module Google # @return [Google::Apis::ClassroomV1::Assignment] attr_accessor :assignment - # Whether this course work item is associated with the Developer Console - # project making the request. - # See CreateCourseWork for more - # details. - # Read-only. + # Whether this course work item is associated with the Developer Console project + # making the request. See CreateCourseWork for more details. Read-only. # Corresponds to the JSON property `associatedWithDeveloper` # @return [Boolean] attr_accessor :associated_with_developer alias_method :associated_with_developer?, :associated_with_developer - # Identifier of the course. - # Read-only. + # Identifier of the course. Read-only. # Corresponds to the JSON property `courseId` # @return [String] attr_accessor :course_id - # Timestamp when this course work was created. - # Read-only. + # Timestamp when this course work was created. Read-only. # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time - # Identifier for the user that created the coursework. - # Read-only. + # Identifier for the user that created the coursework. Read-only. # Corresponds to the JSON property `creatorUserId` # @return [String] attr_accessor :creator_user_id - # Optional description of this course work. - # If set, the description must be a valid UTF-8 string containing no more - # than 30,000 characters. + # Optional description of this course work. If set, the description must be a + # valid UTF-8 string containing no more than 30,000 characters. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # 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 `dueDate` # @return [Google::Apis::ClassroomV1::Date] attr_accessor :due_date - # 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 `dueTime` # @return [Google::Apis::ClassroomV1::TimeOfDay] attr_accessor :due_time - # Classroom-assigned identifier of this course work, unique per course. - # Read-only. + # Classroom-assigned identifier of this course work, unique per course. Read- + # only. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Assignee details about a coursework/announcement. - # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. + # Assignee details about a coursework/announcement. This field is set if and + # only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. # Corresponds to the JSON property `individualStudentsOptions` # @return [Google::Apis::ClassroomV1::IndividualStudentsOptions] attr_accessor :individual_students_options - # Additional materials. - # CourseWork must have no more than 20 material items. + # Additional materials. CourseWork must have no more than 20 material items. # Corresponds to the JSON property `materials` # @return [Array] attr_accessor :materials - # Maximum grade for this course work. - # If zero or unspecified, this assignment is considered ungraded. - # This must be a non-negative integer value. + # Maximum grade for this course work. If zero or unspecified, this assignment is + # considered ungraded. This must be a non-negative integer value. # Corresponds to the JSON property `maxPoints` # @return [Float] attr_accessor :max_points @@ -627,39 +578,36 @@ module Google # @return [String] attr_accessor :scheduled_time - # Status of this course work. - # If unspecified, the default state is `DRAFT`. + # Status of this course work. If unspecified, the default state is `DRAFT`. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state - # Setting to determine when students are allowed to modify submissions. - # If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. + # Setting to determine when students are allowed to modify submissions. If + # unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`. # Corresponds to the JSON property `submissionModificationMode` # @return [String] attr_accessor :submission_modification_mode - # Title of this course work. - # The title must be a valid UTF-8 string containing between 1 and 3000 - # characters. + # Title of this course work. The title must be a valid UTF-8 string containing + # between 1 and 3000 characters. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title - # Identifier for the topic that this coursework is associated with. - # Must match an existing topic in the course. + # Identifier for the topic that this coursework is associated with. Must match + # an existing topic in the course. # Corresponds to the JSON property `topicId` # @return [String] attr_accessor :topic_id - # Timestamp of the most recent change to this course work. - # Read-only. + # Timestamp of the most recent change to this course work. Read-only. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time - # Type of this course work. - # The type is set when the course work is created and cannot be changed. + # Type of this course work. The type is set when the course work is created and + # cannot be changed. # Corresponds to the JSON property `workType` # @return [String] attr_accessor :work_type @@ -716,30 +664,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 @@ -760,8 +707,7 @@ module Google class DriveFile include Google::Apis::Core::Hashable - # URL that can be used to access the Drive item. - # Read-only. + # URL that can be used to access the Drive item. Read-only. # Corresponds to the JSON property `alternateLink` # @return [String] attr_accessor :alternate_link @@ -771,14 +717,12 @@ module Google # @return [String] attr_accessor :id - # URL of a thumbnail image of the Drive item. - # Read-only. + # URL of a thumbnail image of the Drive item. Read-only. # Corresponds to the JSON property `thumbnailUrl` # @return [String] attr_accessor :thumbnail_url - # Title of the Drive item. - # Read-only. + # Title of the Drive item. Read-only. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -800,8 +744,7 @@ module Google class DriveFolder include Google::Apis::Core::Hashable - # URL that can be used to access the Drive folder. - # Read-only. + # URL that can be used to access the Drive folder. Read-only. # Corresponds to the JSON property `alternateLink` # @return [String] attr_accessor :alternate_link @@ -811,8 +754,7 @@ module Google # @return [String] attr_accessor :id - # Title of the Drive folder. - # Read-only. + # Title of the Drive folder. Read-only. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -829,13 +771,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 @@ -848,8 +788,8 @@ module Google end end - # A class of notifications that an application can register to receive. - # For example: "all roster changes for a domain". + # A class of notifications that an application can register to receive. For + # example: "all roster changes for a domain". class Feed include Google::Apis::Core::Hashable @@ -889,22 +829,18 @@ module Google # @return [String] attr_accessor :form_url - # URL of the form responses document. - # Only set if respsonses have been recorded and only when the - # requesting user is an editor of the form. - # Read-only. + # URL of the form responses document. Only set if respsonses have been recorded + # and only when the requesting user is an editor of the form. Read-only. # Corresponds to the JSON property `responseUrl` # @return [String] attr_accessor :response_url - # URL of a thumbnail image of the Form. - # Read-only. + # URL of a thumbnail image of the Form. Read-only. # Corresponds to the JSON property `thumbnailUrl` # @return [String] attr_accessor :thumbnail_url - # Title of the Form. - # Read-only. + # Title of the Form. Read-only. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -960,8 +896,7 @@ module Google # @return [String] attr_accessor :grade_timestamp - # The denominator of the grade at this time in the submission grade - # history. + # The denominator of the grade at this time in the submission grade history. # Corresponds to the JSON property `maxPoints` # @return [Float] attr_accessor :max_points @@ -985,8 +920,8 @@ module Google end end - # Association between a student and a guardian of that student. The guardian - # may receive information about the student's course work. + # Association between a student and a guardian of that student. The guardian may + # receive information about the student's course work. class Guardian include Google::Apis::Core::Hashable @@ -1000,8 +935,8 @@ module Google # @return [Google::Apis::ClassroomV1::UserProfile] attr_accessor :guardian_profile - # The email address to which the initial guardian invitation was sent. - # This field is only visible to domain administrators. + # The email address to which the initial guardian invitation was sent. This + # field is only visible to domain administrators. # Corresponds to the JSON property `invitedEmailAddress` # @return [String] attr_accessor :invited_email_address @@ -1029,20 +964,18 @@ module Google class GuardianInvitation include Google::Apis::Core::Hashable - # The time that this invitation was created. - # Read-only. + # The time that this invitation was created. Read-only. # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time - # Unique identifier for this invitation. - # Read-only. + # Unique identifier for this invitation. Read-only. # Corresponds to the JSON property `invitationId` # @return [String] attr_accessor :invitation_id - # Email address that the invitation was sent to. - # This field is only visible to domain administrators. + # Email address that the invitation was sent to. This field is only visible to + # domain administrators. # Corresponds to the JSON property `invitedEmailAddress` # @return [String] attr_accessor :invited_email_address @@ -1071,13 +1004,12 @@ module Google end end - # Assignee details about a coursework/announcement. - # This field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. + # Assignee details about a coursework/announcement. This field is set if and + # only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. class IndividualStudentsOptions include Google::Apis::Core::Hashable - # Identifiers for the students that have access to the - # coursework/announcement. + # Identifiers for the students that have access to the coursework/announcement. # Corresponds to the JSON property `studentIds` # @return [Array] attr_accessor :student_ids @@ -1101,24 +1033,20 @@ module Google # @return [String] attr_accessor :course_id - # Identifier assigned by Classroom. - # Read-only. + # Identifier assigned by Classroom. Read-only. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Role to invite the user to have. - # Must not be `COURSE_ROLE_UNSPECIFIED`. + # Role to invite the user to have. Must not be `COURSE_ROLE_UNSPECIFIED`. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role - # Identifier of the invited user. - # When specified as a parameter of a request, this identifier can be set to - # one of the following: - # * the numeric identifier for the user - # * the email address of the user - # * the string literal `"me"`, indicating the requesting user + # Identifier of the invited user. When specified as a parameter of a request, + # this identifier can be set to one of the following: * the numeric identifier + # for the user * the email address of the user * the string literal `"me"`, + # indicating the requesting user # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id @@ -1140,20 +1068,18 @@ module Google class Link include Google::Apis::Core::Hashable - # URL of a thumbnail image of the target URL. - # Read-only. + # URL of a thumbnail image of the target URL. Read-only. # Corresponds to the JSON property `thumbnailUrl` # @return [String] attr_accessor :thumbnail_url - # Title of the target of the URL. - # Read-only. + # Title of the target of the URL. Read-only. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title - # URL to link to. - # This must be a valid UTF-8 string containing between 1 and 2024 characters. + # URL to link to. This must be a valid UTF-8 string containing between 1 and + # 2024 characters. # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -1304,8 +1230,8 @@ module Google class ListGuardiansResponse include Google::Apis::Core::Hashable - # Guardians on this page of results that met the criteria specified in - # the request. + # Guardians on this page of results that met the criteria specified in the + # request. # Corresponds to the JSON property `guardians` # @return [Array] attr_accessor :guardians @@ -1457,8 +1383,8 @@ module Google end end - # Material attached to course work. - # When creating attachments, setting the `form` field is not supported. + # Material attached to course work. When creating attachments, setting the `form` + # field is not supported. class Material include Google::Apis::Core::Hashable @@ -1499,8 +1425,8 @@ module Google class ModifyAnnouncementAssigneesRequest include Google::Apis::Core::Hashable - # Mode of the announcement describing whether it is accessible by all - # students or specified individual students. + # Mode of the announcement describing whether it is accessible by all students + # or specified individual students. # Corresponds to the JSON property `assigneeMode` # @return [String] attr_accessor :assignee_mode @@ -1526,8 +1452,7 @@ module Google class ModifyAttachmentsRequest include Google::Apis::Core::Hashable - # Attachments to add. - # A student submission may not have more than 20 attachments. + # Attachments to add. A student submission may not have more than 20 attachments. # Form attachments are not supported. # Corresponds to the JSON property `addAttachments` # @return [Array] @@ -1547,8 +1472,8 @@ module Google class ModifyCourseWorkAssigneesRequest include Google::Apis::Core::Hashable - # Mode of the coursework describing whether it will be assigned to all - # students or specified individual students. + # Mode of the coursework describing whether it will be assigned to all students + # or specified individual students. # Corresponds to the JSON property `assigneeMode` # @return [String] attr_accessor :assignee_mode @@ -1575,14 +1500,13 @@ module Google class ModifyIndividualStudentsOptions include Google::Apis::Core::Hashable - # IDs of students to be added as having access to this - # coursework/announcement. + # IDs of students to be added as having access to this coursework/announcement. # Corresponds to the JSON property `addStudentIds` # @return [Array] attr_accessor :add_student_ids - # IDs of students to be removed from having access to this - # coursework/announcement. + # IDs of students to be removed from having access to this coursework/ + # announcement. # Corresponds to the JSON property `removeStudentIds` # @return [Array] attr_accessor :remove_student_ids @@ -1640,21 +1564,18 @@ module Google class Name include Google::Apis::Core::Hashable - # The user's last name. - # Read-only. + # The user's last name. Read-only. # Corresponds to the JSON property `familyName` # @return [String] attr_accessor :family_name - # The user's full name formed by concatenating the first and last name - # values. + # The user's full name formed by concatenating the first and last name values. # Read-only. # Corresponds to the JSON property `fullName` # @return [String] attr_accessor :full_name - # The user's first name. - # Read-only. + # The user's first name. Read-only. # Corresponds to the JSON property `givenName` # @return [String] attr_accessor :given_name @@ -1689,28 +1610,26 @@ module Google class Registration include Google::Apis::Core::Hashable - # A reference to a Cloud Pub/Sub topic. - # To register for notifications, the owner of the topic must grant - # `classroom-notifications@system.gserviceaccount.com` the - # `projects.topics.publish` permission. + # A reference to a Cloud Pub/Sub topic. To register for notifications, the owner + # of the topic must grant `classroom-notifications@system.gserviceaccount.com` + # the `projects.topics.publish` permission. # Corresponds to the JSON property `cloudPubsubTopic` # @return [Google::Apis::ClassroomV1::CloudPubsubTopic] attr_accessor :cloud_pubsub_topic - # The time until which the `Registration` is effective. - # This is a read-only field assigned by the server. + # The time until which the `Registration` is effective. This is a read-only + # field assigned by the server. # Corresponds to the JSON property `expiryTime` # @return [String] attr_accessor :expiry_time - # A class of notifications that an application can register to receive. - # For example: "all roster changes for a domain". + # A class of notifications that an application can register to receive. For + # example: "all roster changes for a domain". # Corresponds to the JSON property `feed` # @return [Google::Apis::ClassroomV1::Feed] attr_accessor :feed - # A server-generated unique identifier for this `Registration`. - # Read-only. + # A server-generated unique identifier for this `Registration`. Read-only. # Corresponds to the JSON property `registrationId` # @return [String] attr_accessor :registration_id @@ -1820,8 +1739,7 @@ module Google class Student include Google::Apis::Core::Hashable - # Identifier of the course. - # Read-only. + # Identifier of the course. Read-only. # Corresponds to the JSON property `courseId` # @return [String] attr_accessor :course_id @@ -1836,12 +1754,10 @@ module Google # @return [Google::Apis::ClassroomV1::DriveFolder] attr_accessor :student_work_folder - # Identifier of the user. - # When specified as a parameter of a request, this identifier can be one of - # the following: - # * the numeric identifier for the user - # * the email address of the user - # * the string literal `"me"`, indicating the requesting user + # Identifier of the user. When specified as a parameter of a request, this + # identifier can be one of the following: * the numeric identifier for the user * + # the email address of the user * the string literal `"me"`, indicating the + # requesting user # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id @@ -1859,23 +1775,20 @@ module Google end end - # Student submission for course work. - # StudentSubmission items are generated when a CourseWork item is created. - # StudentSubmissions that have never been accessed (i.e. with `state` = NEW) - # may not have a creation time or update time. + # Student submission for course work. StudentSubmission items are generated when + # a CourseWork item is created. StudentSubmissions that have never been accessed + # (i.e. with `state` = NEW) may not have a creation time or update time. class StudentSubmission include Google::Apis::Core::Hashable - # Absolute link to the submission in the Classroom web UI. - # Read-only. + # Absolute link to the submission in the Classroom web UI. Read-only. # Corresponds to the JSON property `alternateLink` # @return [String] attr_accessor :alternate_link - # Optional grade. If unset, no grade was set. - # This value must be non-negative. Decimal (that is, non-integer) values are - # allowed, but are rounded to two decimal places. - # This may be modified only by course teachers. + # Optional grade. If unset, no grade was set. This value must be non-negative. + # Decimal (that is, non-integer) values are allowed, but are rounded to two + # decimal places. This may be modified only by course teachers. # Corresponds to the JSON property `assignedGrade` # @return [Float] attr_accessor :assigned_grade @@ -1886,57 +1799,48 @@ module Google attr_accessor :assignment_submission # Whether this student submission is associated with the Developer Console - # project making the request. - # See CreateCourseWork for more - # details. - # Read-only. + # project making the request. See CreateCourseWork for more details. Read-only. # Corresponds to the JSON property `associatedWithDeveloper` # @return [Boolean] attr_accessor :associated_with_developer alias_method :associated_with_developer?, :associated_with_developer - # Identifier of the course. - # Read-only. + # Identifier of the course. Read-only. # Corresponds to the JSON property `courseId` # @return [String] attr_accessor :course_id - # Identifier for the course work this corresponds to. - # Read-only. + # Identifier for the course work this corresponds to. Read-only. # Corresponds to the JSON property `courseWorkId` # @return [String] attr_accessor :course_work_id - # Type of course work this submission is for. - # Read-only. + # Type of course work this submission is for. Read-only. # Corresponds to the JSON property `courseWorkType` # @return [String] attr_accessor :course_work_type - # Creation time of this submission. - # This may be unset if the student has not accessed this item. - # Read-only. + # Creation time of this submission. This may be unset if the student has not + # accessed this item. Read-only. # Corresponds to the JSON property `creationTime` # @return [String] attr_accessor :creation_time - # Optional pending grade. If unset, no grade was set. - # This value must be non-negative. Decimal (that is, non-integer) values are - # allowed, but are rounded to two decimal places. - # This is only visible to and modifiable by course teachers. + # Optional pending grade. If unset, no grade was set. This value must be non- + # negative. Decimal (that is, non-integer) values are allowed, but are rounded + # to two decimal places. This is only visible to and modifiable by course + # teachers. # Corresponds to the JSON property `draftGrade` # @return [Float] attr_accessor :draft_grade - # Classroom-assigned Identifier for the student submission. - # This is unique among submissions for the relevant course work. - # Read-only. + # Classroom-assigned Identifier for the student submission. This is unique among + # submissions for the relevant course work. Read-only. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id - # Whether this submission is late. - # Read-only. + # Whether this submission is late. Read-only. # Corresponds to the JSON property `late` # @return [Boolean] attr_accessor :late @@ -1952,27 +1856,23 @@ module Google # @return [Google::Apis::ClassroomV1::ShortAnswerSubmission] attr_accessor :short_answer_submission - # State of this submission. - # Read-only. + # State of this submission. Read-only. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state - # The history of the submission (includes state and grade histories). - # Read-only. + # The history of the submission (includes state and grade histories). Read-only. # Corresponds to the JSON property `submissionHistory` # @return [Array] attr_accessor :submission_history - # Last update time of this submission. - # This may be unset if the student has not accessed this item. - # Read-only. + # Last update time of this submission. This may be unset if the student has not + # accessed this item. Read-only. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time - # Identifier for the student that owns this submission. - # Read-only. + # Identifier for the student that owns this submission. Read-only. # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id @@ -2033,8 +1933,7 @@ module Google class Teacher include Google::Apis::Core::Hashable - # Identifier of the course. - # Read-only. + # Identifier of the course. Read-only. # Corresponds to the JSON property `courseId` # @return [String] attr_accessor :course_id @@ -2044,12 +1943,10 @@ module Google # @return [Google::Apis::ClassroomV1::UserProfile] attr_accessor :profile - # Identifier of the user. - # When specified as a parameter of a request, this identifier can be one of - # the following: - # * the numeric identifier for the user - # * the email address of the user - # * the string literal `"me"`, indicating the requesting user + # Identifier of the user. When specified as a parameter of a request, this + # identifier can be one of the following: * the numeric identifier for the user * + # the email address of the user * the string literal `"me"`, indicating the + # requesting user # Corresponds to the JSON property `userId` # @return [String] attr_accessor :user_id @@ -2066,14 +1963,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 @@ -2111,29 +2008,25 @@ module Google class Topic include Google::Apis::Core::Hashable - # Identifier of the course. - # Read-only. + # Identifier of the course. Read-only. # Corresponds to the JSON property `courseId` # @return [String] attr_accessor :course_id - # The name of the topic, generated by the user. - # Leading and trailing whitespaces, if any, are trimmed. Also, multiple - # consecutive whitespaces are collapsed into one inside the name. The - # result must be a non-empty string. Topic names are case sensitive, and must - # be no longer than 100 characters. + # The name of the topic, generated by the user. Leading and trailing whitespaces, + # if any, are trimmed. Also, multiple consecutive whitespaces are collapsed + # into one inside the name. The result must be a non-empty string. Topic names + # are case sensitive, and must be no longer than 100 characters. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Unique identifier for the topic. - # Read-only. + # Unique identifier for the topic. Read-only. # Corresponds to the JSON property `topicId` # @return [String] attr_accessor :topic_id - # The time the topic was last updated by the system. - # Read-only. + # The time the topic was last updated by the system. Read-only. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -2168,14 +2061,12 @@ module Google class UserProfile include Google::Apis::Core::Hashable - # Email address of the user. - # Read-only. + # Email address of the user. Read-only. # Corresponds to the JSON property `emailAddress` # @return [String] attr_accessor :email_address - # Identifier of the user. - # Read-only. + # Identifier of the user. Read-only. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -2185,22 +2076,19 @@ module Google # @return [Google::Apis::ClassroomV1::Name] attr_accessor :name - # Global permissions of the user. - # Read-only. + # Global permissions of the user. Read-only. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions - # URL of user's profile photo. - # Read-only. + # URL of user's profile photo. Read-only. # Corresponds to the JSON property `photoUrl` # @return [String] attr_accessor :photo_url # Represents whether a G Suite for Education user's domain administrator has - # explicitly verified them as being a teacher. If the user is not a member of - # a G Suite for Education domain, than this field is always false. - # Read-only + # explicitly verified them as being a teacher. If the user is not a member of a + # G Suite for Education domain, than this field is always false. Read-only # Corresponds to the JSON property `verifiedTeacher` # @return [Boolean] attr_accessor :verified_teacher @@ -2225,8 +2113,7 @@ module Google class YouTubeVideo include Google::Apis::Core::Hashable - # URL that can be used to view the YouTube video. - # Read-only. + # URL that can be used to view the YouTube video. Read-only. # Corresponds to the JSON property `alternateLink` # @return [String] attr_accessor :alternate_link @@ -2236,14 +2123,12 @@ module Google # @return [String] attr_accessor :id - # URL of a thumbnail image of the YouTube video. - # Read-only. + # URL of a thumbnail image of the YouTube video. Read-only. # Corresponds to the JSON property `thumbnailUrl` # @return [String] attr_accessor :thumbnail_url - # Title of the YouTube video. - # Read-only. + # Title of the YouTube video. Read-only. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title diff --git a/generated/google/apis/classroom_v1/service.rb b/generated/google/apis/classroom_v1/service.rb index 70959553e..10e6ee067 100644 --- a/generated/google/apis/classroom_v1/service.rb +++ b/generated/google/apis/classroom_v1/service.rb @@ -47,18 +47,13 @@ module Google @batch_path = 'batch' end - # Creates a course. - # The user specified in `ownerId` is the owner of the created course - # and added as a teacher. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to create - # courses or for access errors. - # * `NOT_FOUND` if the primary teacher is not a valid user. - # * `FAILED_PRECONDITION` if the course owner's account is disabled or for - # the following request errors: - # * UserGroupsMembershipLimitReached - # * `ALREADY_EXISTS` if an alias was specified in the `id` and - # already exists. + # Creates a course. The user specified in `ownerId` is the owner of the created + # course and added as a teacher. This method returns the following error codes: * + # `PERMISSION_DENIED` if the requesting user is not permitted to create courses + # or for access errors. * `NOT_FOUND` if the primary teacher is not a valid user. + # * `FAILED_PRECONDITION` if the course owner's account is disabled or for the + # following request errors: * UserGroupsMembershipLimitReached * `ALREADY_EXISTS` + # if an alias was specified in the `id` and already exists. # @param [Google::Apis::ClassroomV1::Course] course_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -88,15 +83,13 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a course. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to delete the - # requested course or for access errors. - # * `NOT_FOUND` if no course exists with the requested ID. + # Deletes a course. This method returns the following error codes: * ` + # PERMISSION_DENIED` if the requesting user is not permitted to delete the + # requested course or for access errors. * `NOT_FOUND` if no course exists with + # the requested ID. # @param [String] id - # Identifier of the course to delete. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course to delete. This identifier can be either the + # Classroom-assigned identifier or an alias. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -124,15 +117,13 @@ module Google execute_or_queue_command(command, &block) end - # Returns a course. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access the - # requested course or for access errors. - # * `NOT_FOUND` if no course exists with the requested ID. + # Returns a course. This method returns the following error codes: * ` + # PERMISSION_DENIED` if the requesting user is not permitted to access the + # requested course or for access errors. * `NOT_FOUND` if no course exists with + # the requested ID. # @param [String] id - # Identifier of the course to return. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course to return. This identifier can be either the + # Classroom-assigned identifier or an alias. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -162,37 +153,31 @@ module Google # Returns a list of courses that the requesting user is permitted to view, # restricted to those that match the request. Returned courses are ordered by - # creation time, with the most recently created coming first. - # This method returns the following error codes: - # * `PERMISSION_DENIED` for access errors. - # * `INVALID_ARGUMENT` if the query argument is malformed. - # * `NOT_FOUND` if any users specified in the query arguments do not exist. + # creation time, with the most recently created coming first. This method + # returns the following error codes: * `PERMISSION_DENIED` for access errors. * ` + # INVALID_ARGUMENT` if the query argument is malformed. * `NOT_FOUND` if any + # users specified in the query arguments do not exist. # @param [Array, String] course_states - # Restricts returned courses to those in one of the specified states - # The default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. + # Restricts returned courses to those in one of the specified states The default + # value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED. # @param [Fixnum] page_size # Maximum number of items to return. Zero or unspecified indicates that the - # server may assign a maximum. - # The server may return fewer than the specified number of results. + # server may assign a maximum. The server may return fewer than the specified + # number of results. # @param [String] page_token - # nextPageToken - # value returned from a previous - # list call, - # indicating that the subsequent page of results should be returned. - # The list request must be + # nextPageToken value returned from a previous list call, indicating that the + # subsequent page of results should be returned. The list request must be # otherwise identical to the one that resulted in this token. # @param [String] student_id # Restricts returned courses to those having a student with the specified - # identifier. The identifier can be one of the following: - # * the numeric identifier for the user - # * the email address of the user - # * the string literal `"me"`, indicating the requesting user + # identifier. The identifier can be one of the following: * the numeric + # identifier for the user * the email address of the user * the string literal `" + # me"`, indicating the requesting user # @param [String] teacher_id # Restricts returned courses to those having a teacher with the specified - # identifier. The identifier can be one of the following: - # * the numeric identifier for the user - # * the email address of the user - # * the string literal `"me"`, indicating the requesting user + # identifier. The identifier can be one of the following: * the numeric + # identifier for the user * the email address of the user * the string literal `" + # me"`, indicating the requesting user # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -224,36 +209,24 @@ module Google execute_or_queue_command(command, &block) end - # Updates one or more fields in a course. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to modify the - # requested course or for access errors. - # * `NOT_FOUND` if no course exists with the requested ID. - # * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or - # if no update mask is supplied. - # * `FAILED_PRECONDITION` for the following request errors: - # * CourseNotModifiable + # Updates one or more fields in a course. This method returns the following + # error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to + # modify the requested course or for access errors. * `NOT_FOUND` if no course + # exists with the requested ID. * `INVALID_ARGUMENT` if invalid fields are + # specified in the update mask or if no update mask is supplied. * ` + # FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable # @param [String] id - # Identifier of the course to update. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course to update. This identifier can be either the + # Classroom-assigned identifier or an alias. # @param [Google::Apis::ClassroomV1::Course] course_object # @param [String] update_mask - # Mask that identifies which fields on the course to update. - # This field is required to do an update. The update will fail if invalid - # fields are specified. The following fields are valid: - # * `name` - # * `section` - # * `descriptionHeading` - # * `description` - # * `room` - # * `courseState` - # * `ownerId` - # Note: patches to ownerId are treated as being effective immediately, but in - # practice it may take some time for the ownership transfer of all affected - # resources to complete. - # When set in a query parameter, this field should be specified as - # `updateMask=,,...` + # Mask that identifies which fields on the course to update. This field is + # required to do an update. The update will fail if invalid fields are specified. + # The following fields are valid: * `name` * `section` * `descriptionHeading` * + # `description` * `room` * `courseState` * `ownerId` Note: patches to ownerId + # are treated as being effective immediately, but in practice it may take some + # time for the ownership transfer of all affected resources to complete. When + # set in a query parameter, this field should be specified as `updateMask=,,...` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -284,17 +257,14 @@ module Google execute_or_queue_command(command, &block) end - # Updates a course. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to modify the - # requested course or for access errors. - # * `NOT_FOUND` if no course exists with the requested ID. - # * `FAILED_PRECONDITION` for the following request errors: - # * CourseNotModifiable + # Updates a course. This method returns the following error codes: * ` + # PERMISSION_DENIED` if the requesting user is not permitted to modify the + # requested course or for access errors. * `NOT_FOUND` if no course exists with + # the requested ID. * `FAILED_PRECONDITION` for the following request errors: * + # CourseNotModifiable # @param [String] id - # Identifier of the course to update. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course to update. This identifier can be either the + # Classroom-assigned identifier or an alias. # @param [Google::Apis::ClassroomV1::Course] course_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -325,19 +295,15 @@ module Google execute_or_queue_command(command, &block) end - # Creates an alias for a course. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to create the - # alias or for access errors. - # * `NOT_FOUND` if the course does not exist. - # * `ALREADY_EXISTS` if the alias already exists. - # * `FAILED_PRECONDITION` if the alias requested does not make sense for the - # requesting user or course (for example, if a user not in a domain - # attempts to access a domain-scoped alias). + # Creates an alias for a course. This method returns the following error codes: * + # `PERMISSION_DENIED` if the requesting user is not permitted to create the + # alias or for access errors. * `NOT_FOUND` if the course does not exist. * ` + # ALREADY_EXISTS` if the alias already exists. * `FAILED_PRECONDITION` if the + # alias requested does not make sense for the requesting user or course (for + # example, if a user not in a domain attempts to access a domain-scoped alias). # @param [String] course_id - # Identifier of the course to alias. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course to alias. This identifier can be either the Classroom- + # assigned identifier or an alias. # @param [Google::Apis::ClassroomV1::CourseAlias] course_alias_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -368,21 +334,17 @@ module Google execute_or_queue_command(command, &block) end - # Deletes an alias of a course. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to remove the - # alias or for access errors. - # * `NOT_FOUND` if the alias does not exist. - # * `FAILED_PRECONDITION` if the alias requested does not make sense for the - # requesting user or course (for example, if a user not in a domain - # attempts to delete a domain-scoped alias). + # Deletes an alias of a course. This method returns the following error codes: * + # `PERMISSION_DENIED` if the requesting user is not permitted to remove the + # alias or for access errors. * `NOT_FOUND` if the alias does not exist. * ` + # FAILED_PRECONDITION` if the alias requested does not make sense for the + # requesting user or course (for example, if a user not in a domain attempts to + # delete a domain-scoped alias). # @param [String] course_id - # Identifier of the course whose alias should be deleted. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course whose alias should be deleted. This identifier can be + # either the Classroom-assigned identifier or an alias. # @param [String] alias_ - # Alias to delete. - # This may not be the Classroom-assigned identifier. + # Alias to delete. This may not be the Classroom-assigned identifier. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -411,26 +373,21 @@ module Google execute_or_queue_command(command, &block) end - # Returns a list of aliases for a course. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access the - # course or for access errors. - # * `NOT_FOUND` if the course does not exist. + # Returns a list of aliases for a course. This method returns the following + # error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to + # access the course or for access errors. * `NOT_FOUND` if the course does not + # exist. # @param [String] course_id - # The identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # The identifier of the course. This identifier can be either the Classroom- + # assigned identifier or an alias. # @param [Fixnum] page_size # Maximum number of items to return. Zero or unspecified indicates that the - # server may assign a maximum. - # The server may return fewer than the specified number of results. + # server may assign a maximum. The server may return fewer than the specified + # number of results. # @param [String] page_token - # nextPageToken - # value returned from a previous - # list call, - # indicating that the subsequent page of results should be returned. - # The list request - # must be otherwise identical to the one that resulted in this token. + # nextPageToken value returned from a previous list call, indicating that the + # subsequent page of results should be returned. The list request must be + # otherwise identical to the one that resulted in this token. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -460,19 +417,15 @@ module Google execute_or_queue_command(command, &block) end - # Creates an announcement. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access the - # requested course, create announcements in the requested course, share a - # Drive attachment, or for access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course does not exist. - # * `FAILED_PRECONDITION` for the following request error: - # * AttachmentNotVisible + # Creates an announcement. This method returns the following error codes: * ` + # PERMISSION_DENIED` if the requesting user is not permitted to access the + # requested course, create announcements in the requested course, share a Drive + # attachment, or for access errors. * `INVALID_ARGUMENT` if the request is + # malformed. * `NOT_FOUND` if the requested course does not exist. * ` + # FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [Google::Apis::ClassroomV1::Announcement] announcement_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -503,24 +456,20 @@ module Google execute_or_queue_command(command, &block) end - # Deletes an announcement. - # This request must be made by the Developer Console project of the - # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to - # create the corresponding announcement item. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting developer project did not create - # the corresponding announcement, if the requesting user is not permitted - # to delete the requested course or for access errors. - # * `FAILED_PRECONDITION` if the requested announcement has already been - # deleted. - # * `NOT_FOUND` if no course exists with the requested ID. + # Deletes an announcement. This request must be made by the Developer Console + # project of the [OAuth client ID](https://support.google.com/cloud/answer/ + # 6158849) used to create the corresponding announcement item. This method + # returns the following error codes: * `PERMISSION_DENIED` if the requesting + # developer project did not create the corresponding announcement, if the + # requesting user is not permitted to delete the requested course or for access + # errors. * `FAILED_PRECONDITION` if the requested announcement has already been + # deleted. * `NOT_FOUND` if no course exists with the requested ID. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] id - # Identifier of the announcement to delete. - # This identifier is a Classroom-assigned identifier. + # Identifier of the announcement to delete. This identifier is a Classroom- + # assigned identifier. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -549,16 +498,14 @@ module Google execute_or_queue_command(command, &block) end - # Returns an announcement. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access the - # requested course or announcement, or for access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course or announcement does not exist. + # Returns an announcement. This method returns the following error codes: * ` + # PERMISSION_DENIED` if the requesting user is not permitted to access the + # requested course or announcement, or for access errors. * `INVALID_ARGUMENT` + # if the request is malformed. * `NOT_FOUND` if the requested course or + # announcement does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] id # Identifier of the announcement. # @param [String] fields @@ -590,37 +537,31 @@ module Google end # Returns a list of announcements that the requester is permitted to view. - # Course students may only view `PUBLISHED` announcements. Course teachers - # and domain administrators may view all announcements. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access - # the requested course or for access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course does not exist. + # Course students may only view `PUBLISHED` announcements. Course teachers and + # domain administrators may view all announcements. This method returns the + # following error codes: * `PERMISSION_DENIED` if the requesting user is not + # permitted to access the requested course or for access errors. * ` + # INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested + # course does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [Array, String] announcement_states - # Restriction on the `state` of announcements returned. - # If this argument is left unspecified, the default value is `PUBLISHED`. + # Restriction on the `state` of announcements returned. If this argument is left + # unspecified, the default value is `PUBLISHED`. # @param [String] order_by - # Optional sort ordering for results. A comma-separated list of fields with - # an optional sort direction keyword. Supported field is `updateTime`. - # Supported direction keywords are `asc` and `desc`. - # If not specified, `updateTime desc` is the default behavior. - # Examples: `updateTime asc`, `updateTime` + # Optional sort ordering for results. A comma-separated list of fields with an + # optional sort direction keyword. Supported field is `updateTime`. Supported + # direction keywords are `asc` and `desc`. If not specified, `updateTime desc` + # is the default behavior. Examples: `updateTime asc`, `updateTime` # @param [Fixnum] page_size # Maximum number of items to return. Zero or unspecified indicates that the - # server may assign a maximum. - # The server may return fewer than the specified number of results. + # server may assign a maximum. The server may return fewer than the specified + # number of results. # @param [String] page_token - # nextPageToken - # value returned from a previous - # list call, - # indicating that the subsequent page of results should be returned. - # The list request - # must be otherwise identical to the one that resulted in this token. + # nextPageToken value returned from a previous list call, indicating that the + # subsequent page of results should be returned. The list request must be + # otherwise identical to the one that resulted in this token. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -652,18 +593,15 @@ module Google execute_or_queue_command(command, &block) end - # Modifies assignee mode and options of an announcement. - # Only a teacher of the course that contains the announcement may - # call this method. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access the - # requested course or course work or for access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course or course work does not exist. + # Modifies assignee mode and options of an announcement. Only a teacher of the + # course that contains the announcement may call this method. This method + # returns the following error codes: * `PERMISSION_DENIED` if the requesting + # user is not permitted to access the requested course or course work or for + # access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` + # if the requested course or course work does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] id # Identifier of the announcement. # @param [Google::Apis::ClassroomV1::ModifyAnnouncementAssigneesRequest] modify_announcement_assignees_request_object @@ -697,33 +635,26 @@ module Google execute_or_queue_command(command, &block) end - # Updates one or more fields of an announcement. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting developer project did not create - # the corresponding announcement or for access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `FAILED_PRECONDITION` if the requested announcement has already been - # deleted. - # * `NOT_FOUND` if the requested course or announcement does not exist + # Updates one or more fields of an announcement. This method returns the + # following error codes: * `PERMISSION_DENIED` if the requesting developer + # project did not create the corresponding announcement or for access errors. * ` + # INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the + # requested announcement has already been deleted. * `NOT_FOUND` if the + # requested course or announcement does not exist # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] id # Identifier of the announcement. # @param [Google::Apis::ClassroomV1::Announcement] announcement_object # @param [String] update_mask - # Mask that identifies which fields on the announcement to update. - # This field is required to do an update. The update fails if invalid - # fields are specified. If a field supports empty values, it can be cleared - # by specifying it in the update mask and not in the Announcement object. If - # a field that does not support empty values is included in the update mask - # and not set in the Announcement object, an `INVALID_ARGUMENT` error is - # returned. - # The following fields may be specified by teachers: - # * `text` - # * `state` - # * `scheduled_time` + # Mask that identifies which fields on the announcement to update. This field is + # required to do an update. The update fails if invalid fields are specified. If + # a field supports empty values, it can be cleared by specifying it in the + # update mask and not in the Announcement object. If a field that does not + # support empty values is included in the update mask and not set in the + # Announcement object, an `INVALID_ARGUMENT` error is returned. The following + # fields may be specified by teachers: * `text` * `state` * `scheduled_time` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -755,25 +686,20 @@ module Google execute_or_queue_command(command, &block) end - # Creates course work. - # The resulting course work (and corresponding student submissions) are - # associated with the Developer Console project of the - # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to - # make the request. Classroom API requests to modify course work and student - # submissions must be made with an OAuth client ID from the associated - # Developer Console project. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access the - # requested course, create course work in the requested course, share a - # Drive attachment, or for access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course does not exist. - # * `FAILED_PRECONDITION` for the following request error: - # * AttachmentNotVisible + # Creates course work. The resulting course work (and corresponding student + # submissions) are associated with the Developer Console project of the [OAuth + # client ID](https://support.google.com/cloud/answer/6158849) used to make the + # request. Classroom API requests to modify course work and student submissions + # must be made with an OAuth client ID from the associated Developer Console + # project. This method returns the following error codes: * `PERMISSION_DENIED` + # if the requesting user is not permitted to access the requested course, create + # course work in the requested course, share a Drive attachment, or for access + # errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the + # requested course does not exist. * `FAILED_PRECONDITION` for the following + # request error: * AttachmentNotVisible # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [Google::Apis::ClassroomV1::CourseWork] course_work_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -804,24 +730,20 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a course work. - # This request must be made by the Developer Console project of the - # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to - # create the corresponding course work item. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting developer project did not create - # the corresponding course work, if the requesting user is not permitted - # to delete the requested course or for access errors. - # * `FAILED_PRECONDITION` if the requested course work has already been - # deleted. - # * `NOT_FOUND` if no course exists with the requested ID. + # Deletes a course work. This request must be made by the Developer Console + # project of the [OAuth client ID](https://support.google.com/cloud/answer/ + # 6158849) used to create the corresponding course work item. This method + # returns the following error codes: * `PERMISSION_DENIED` if the requesting + # developer project did not create the corresponding course work, if the + # requesting user is not permitted to delete the requested course or for access + # errors. * `FAILED_PRECONDITION` if the requested course work has already been + # deleted. * `NOT_FOUND` if no course exists with the requested ID. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] id - # Identifier of the course work to delete. - # This identifier is a Classroom-assigned identifier. + # Identifier of the course work to delete. This identifier is a Classroom- + # assigned identifier. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -850,16 +772,14 @@ module Google execute_or_queue_command(command, &block) end - # Returns course work. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access the - # requested course or course work, or for access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course or course work does not exist. + # Returns course work. This method returns the following error codes: * ` + # PERMISSION_DENIED` if the requesting user is not permitted to access the + # requested course or course work, or for access errors. * `INVALID_ARGUMENT` if + # the request is malformed. * `NOT_FOUND` if the requested course or course work + # does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] id # Identifier of the course work. # @param [String] fields @@ -890,39 +810,32 @@ module Google execute_or_queue_command(command, &block) end - # Returns a list of course work that the requester is permitted to view. - # Course students may only view `PUBLISHED` course work. Course teachers - # and domain administrators may view all course work. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access - # the requested course or for access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course does not exist. + # Returns a list of course work that the requester is permitted to view. Course + # students may only view `PUBLISHED` course work. Course teachers and domain + # administrators may view all course work. This method returns the following + # error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to + # access the requested course or for access errors. * `INVALID_ARGUMENT` if the + # request is malformed. * `NOT_FOUND` if the requested course does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [Array, String] course_work_states - # Restriction on the work status to return. Only courseWork that matches - # is returned. If unspecified, items with a work status of `PUBLISHED` - # is returned. + # Restriction on the work status to return. Only courseWork that matches is + # returned. If unspecified, items with a work status of `PUBLISHED` is returned. # @param [String] order_by - # Optional sort ordering for results. A comma-separated list of fields with - # an optional sort direction keyword. Supported fields are `updateTime` - # and `dueDate`. Supported direction keywords are `asc` and `desc`. - # If not specified, `updateTime desc` is the default behavior. - # Examples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc` + # Optional sort ordering for results. A comma-separated list of fields with an + # optional sort direction keyword. Supported fields are `updateTime` and ` + # dueDate`. Supported direction keywords are `asc` and `desc`. If not specified, + # `updateTime desc` is the default behavior. Examples: `dueDate asc,updateTime + # desc`, `updateTime,dueDate desc` # @param [Fixnum] page_size # Maximum number of items to return. Zero or unspecified indicates that the - # server may assign a maximum. - # The server may return fewer than the specified number of results. + # server may assign a maximum. The server may return fewer than the specified + # number of results. # @param [String] page_token - # nextPageToken - # value returned from a previous - # list call, - # indicating that the subsequent page of results should be returned. - # The list request - # must be otherwise identical to the one that resulted in this token. + # nextPageToken value returned from a previous list call, indicating that the + # subsequent page of results should be returned. The list request must be + # otherwise identical to the one that resulted in this token. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -954,18 +867,15 @@ module Google execute_or_queue_command(command, &block) end - # Modifies assignee mode and options of a coursework. - # Only a teacher of the course that contains the coursework may - # call this method. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access the - # requested course or course work or for access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course or course work does not exist. + # Modifies assignee mode and options of a coursework. Only a teacher of the + # course that contains the coursework may call this method. This method returns + # the following error codes: * `PERMISSION_DENIED` if the requesting user is not + # permitted to access the requested course or course work or for access errors. * + # `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the + # requested course or course work does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] id # Identifier of the coursework. # @param [Google::Apis::ClassroomV1::ModifyCourseWorkAssigneesRequest] modify_course_work_assignees_request_object @@ -999,47 +909,33 @@ module Google execute_or_queue_command(command, &block) end - # Updates one or more fields of a course work. - # See google.classroom.v1.CourseWork for details - # of which fields may be updated and who may change them. - # This request must be made by the Developer Console project of the - # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to - # create the corresponding course work item. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting developer project did not create - # the corresponding course work, if the user is not permitted to make the - # requested modification to the student submission, or for - # access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `FAILED_PRECONDITION` if the requested course work has already been - # deleted. - # * `NOT_FOUND` if the requested course, course work, or student submission - # does not exist. + # Updates one or more fields of a course work. See google.classroom.v1. + # CourseWork for details of which fields may be updated and who may change them. + # This request must be made by the Developer Console project of the [OAuth + # client ID](https://support.google.com/cloud/answer/6158849) used to create the + # corresponding course work item. This method returns the following error codes: + # * `PERMISSION_DENIED` if the requesting developer project did not create the + # corresponding course work, if the user is not permitted to make the requested + # modification to the student submission, or for access errors. * ` + # INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the + # requested course work has already been deleted. * `NOT_FOUND` if the requested + # course, course work, or student submission does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] id # Identifier of the course work. # @param [Google::Apis::ClassroomV1::CourseWork] course_work_object # @param [String] update_mask - # Mask that identifies which fields on the course work to update. - # This field is required to do an update. The update fails if invalid - # fields are specified. If a field supports empty values, it can be cleared - # by specifying it in the update mask and not in the CourseWork object. If a - # field that does not support empty values is included in the update mask and - # not set in the CourseWork object, an `INVALID_ARGUMENT` error is - # returned. - # The following fields may be specified by teachers: - # * `title` - # * `description` - # * `state` - # * `due_date` - # * `due_time` - # * `max_points` - # * `scheduled_time` - # * `submission_modification_mode` - # * `topic_id` + # Mask that identifies which fields on the course work to update. This field is + # required to do an update. The update fails if invalid fields are specified. If + # a field supports empty values, it can be cleared by specifying it in the + # update mask and not in the CourseWork object. If a field that does not support + # empty values is included in the update mask and not set in the CourseWork + # object, an `INVALID_ARGUMENT` error is returned. The following fields may be + # specified by teachers: * `title` * `description` * `state` * `due_date` * ` + # due_time` * `max_points` * `scheduled_time` * `submission_modification_mode` * + # `topic_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1071,17 +967,14 @@ module Google execute_or_queue_command(command, &block) end - # Returns a student submission. - # * `PERMISSION_DENIED` if the requesting user is not permitted to access the - # requested course, course work, or student submission or for - # access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course, course work, or student submission - # does not exist. + # Returns a student submission. * `PERMISSION_DENIED` if the requesting user is + # not permitted to access the requested course, course work, or student + # submission or for access errors. * `INVALID_ARGUMENT` if the request is + # malformed. * `NOT_FOUND` if the requested course, course work, or student + # submission does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] course_work_id # Identifier of the course work. # @param [String] id @@ -1115,50 +1008,42 @@ module Google execute_or_queue_command(command, &block) end - # Returns a list of student submissions that the requester is permitted to - # view, factoring in the OAuth scopes of the request. - # `-` may be specified as the `course_work_id` to include student - # submissions for multiple course work items. - # Course students may only view their own work. Course teachers - # and domain administrators may view all student submissions. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access the - # requested course or course work, or for access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course does not exist. + # Returns a list of student submissions that the requester is permitted to view, + # factoring in the OAuth scopes of the request. `-` may be specified as the ` + # course_work_id` to include student submissions for multiple course work items. + # Course students may only view their own work. Course teachers and domain + # administrators may view all student submissions. This method returns the + # following error codes: * `PERMISSION_DENIED` if the requesting user is not + # permitted to access the requested course or course work, or for access errors. + # * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the + # requested course does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] course_work_id - # Identifier of the student work to request. - # This may be set to the string literal `"-"` to request student work for - # all course work in the specified course. + # Identifier of the student work to request. This may be set to the string + # literal `"-"` to request student work for all course work in the specified + # course. # @param [String] late # Requested lateness value. If specified, returned student submissions are - # restricted by the requested value. - # If unspecified, submissions are returned regardless of `late` value. + # restricted by the requested value. If unspecified, submissions are returned + # regardless of `late` value. # @param [Fixnum] page_size # Maximum number of items to return. Zero or unspecified indicates that the - # server may assign a maximum. - # The server may return fewer than the specified number of results. + # server may assign a maximum. The server may return fewer than the specified + # number of results. # @param [String] page_token - # nextPageToken - # value returned from a previous - # list call, - # indicating that the subsequent page of results should be returned. - # The list request - # must be otherwise identical to the one that resulted in this token. + # nextPageToken value returned from a previous list call, indicating that the + # subsequent page of results should be returned. The list request must be + # otherwise identical to the one that resulted in this token. # @param [Array, String] states - # Requested submission states. If specified, returned student submissions - # match one of the specified submission states. + # Requested submission states. If specified, returned student submissions match + # one of the specified submission states. # @param [String] user_id # Optional argument to restrict returned student work to those owned by the # student with the specified identifier. The identifier can be one of the - # following: - # * the numeric identifier for the user - # * the email address of the user - # * the string literal `"me"`, indicating the requesting user + # following: * the numeric identifier for the user * the email address of the + # user * the string literal `"me"`, indicating the requesting user # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1192,24 +1077,19 @@ module Google execute_or_queue_command(command, &block) end - # Modifies attachments of student submission. - # Attachments may only be added to student submissions belonging to course - # work objects with a `workType` of `ASSIGNMENT`. - # This request must be made by the Developer Console project of the + # Modifies attachments of student submission. Attachments may only be added to + # student submissions belonging to course work objects with a `workType` of ` + # ASSIGNMENT`. This request must be made by the Developer Console project of the # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to - # create the corresponding course work item. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access the - # requested course or course work, if the user is not permitted to modify - # attachments on the requested student submission, or for - # access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course, course work, or student submission - # does not exist. + # create the corresponding course work item. This method returns the following + # error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to + # access the requested course or course work, if the user is not permitted to + # modify attachments on the requested student submission, or for access errors. * + # `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the + # requested course, course work, or student submission does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] course_work_id # Identifier of the course work. # @param [String] id @@ -1246,36 +1126,29 @@ module Google execute_or_queue_command(command, &block) end - # Updates one or more fields of a student submission. - # See google.classroom.v1.StudentSubmission for details - # of which fields may be updated and who may change them. - # This request must be made by the Developer Console project of the + # Updates one or more fields of a student submission. See google.classroom.v1. + # StudentSubmission for details of which fields may be updated and who may + # change them. This request must be made by the Developer Console project of the # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to - # create the corresponding course work item. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting developer project did not create - # the corresponding course work, if the user is not permitted to make the - # requested modification to the student submission, or for - # access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course, course work, or student submission - # does not exist. + # create the corresponding course work item. This method returns the following + # error codes: * `PERMISSION_DENIED` if the requesting developer project did not + # create the corresponding course work, if the user is not permitted to make the + # requested modification to the student submission, or for access errors. * ` + # INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested + # course, course work, or student submission does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] course_work_id # Identifier of the course work. # @param [String] id # Identifier of the student submission. # @param [Google::Apis::ClassroomV1::StudentSubmission] student_submission_object # @param [String] update_mask - # Mask that identifies which fields on the student submission to update. - # This field is required to do an update. The update fails if invalid - # fields are specified. - # The following fields may be specified by teachers: - # * `draft_grade` - # * `assigned_grade` + # Mask that identifies which fields on the student submission to update. This + # field is required to do an update. The update fails if invalid fields are + # specified. The following fields may be specified by teachers: * `draft_grade` * + # `assigned_grade` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1309,25 +1182,21 @@ module Google end # Reclaims a student submission on behalf of the student that owns it. - # Reclaiming a student submission transfers ownership of attached Drive - # files to the student and updates the submission state. - # Only the student that owns the requested student submission may call this - # method, and only for a student submission that has been turned in. - # This request must be made by the Developer Console project of the - # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to - # create the corresponding course work item. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access the - # requested course or course work, unsubmit the requested student submission, - # or for access errors. - # * `FAILED_PRECONDITION` if the student submission has not been turned in. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course, course work, or student submission - # does not exist. + # Reclaiming a student submission transfers ownership of attached Drive files to + # the student and updates the submission state. Only the student that owns the + # requested student submission may call this method, and only for a student + # submission that has been turned in. This request must be made by the Developer + # Console project of the [OAuth client ID](https://support.google.com/cloud/ + # answer/6158849) used to create the corresponding course work item. This method + # returns the following error codes: * `PERMISSION_DENIED` if the requesting + # user is not permitted to access the requested course or course work, unsubmit + # the requested student submission, or for access errors. * `FAILED_PRECONDITION` + # if the student submission has not been turned in. * `INVALID_ARGUMENT` if the + # request is malformed. * `NOT_FOUND` if the requested course, course work, or + # student submission does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] course_work_id # Identifier of the course work. # @param [String] id @@ -1364,27 +1233,22 @@ module Google execute_or_queue_command(command, &block) end - # Returns a student submission. - # Returning a student submission transfers ownership of attached Drive - # files to the student and may also update the submission state. - # Unlike the Classroom application, returning a student submission does not - # set assignedGrade to the draftGrade value. - # Only a teacher of the course that contains the requested student submission - # may call this method. - # This request must be made by the Developer Console project of the - # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to - # create the corresponding course work item. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access the - # requested course or course work, return the requested student submission, - # or for access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course, course work, or student submission - # does not exist. + # Returns a student submission. Returning a student submission transfers + # ownership of attached Drive files to the student and may also update the + # submission state. Unlike the Classroom application, returning a student + # submission does not set assignedGrade to the draftGrade value. Only a teacher + # of the course that contains the requested student submission may call this + # method. This request must be made by the Developer Console project of the [ + # OAuth client ID](https://support.google.com/cloud/answer/6158849) used to + # create the corresponding course work item. This method returns the following + # error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to + # access the requested course or course work, return the requested student + # submission, or for access errors. * `INVALID_ARGUMENT` if the request is + # malformed. * `NOT_FOUND` if the requested course, course work, or student + # submission does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] course_work_id # Identifier of the course work. # @param [String] id @@ -1421,25 +1285,20 @@ module Google execute_or_queue_command(command, &block) end - # Turns in a student submission. - # Turning in a student submission transfers ownership of attached Drive - # files to the teacher and may also update the submission state. - # This may only be called by the student that owns the specified student - # submission. - # This request must be made by the Developer Console project of the - # [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to - # create the corresponding course work item. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access the - # requested course or course work, turn in the requested student submission, - # or for access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course, course work, or student submission - # does not exist. + # Turns in a student submission. Turning in a student submission transfers + # ownership of attached Drive files to the teacher and may also update the + # submission state. This may only be called by the student that owns the + # specified student submission. This request must be made by the Developer + # Console project of the [OAuth client ID](https://support.google.com/cloud/ + # answer/6158849) used to create the corresponding course work item. This method + # returns the following error codes: * `PERMISSION_DENIED` if the requesting + # user is not permitted to access the requested course or course work, turn in + # the requested student submission, or for access errors. * `INVALID_ARGUMENT` + # if the request is malformed. * `NOT_FOUND` if the requested course, course + # work, or student submission does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] course_work_id # Identifier of the course work. # @param [String] id @@ -1476,28 +1335,22 @@ module Google execute_or_queue_command(command, &block) end - # Adds a user as a student of a course. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to create - # students in this course or for access errors. - # * `NOT_FOUND` if the requested course ID does not exist. - # * `FAILED_PRECONDITION` if the requested user's account is disabled, - # for the following request errors: - # * CourseMemberLimitReached - # * CourseNotModifiable - # * UserGroupsMembershipLimitReached - # * `ALREADY_EXISTS` if the user is already a student or teacher in the - # course. + # Adds a user as a student of a course. This method returns the following error + # codes: * `PERMISSION_DENIED` if the requesting user is not permitted to create + # students in this course or for access errors. * `NOT_FOUND` if the requested + # course ID does not exist. * `FAILED_PRECONDITION` if the requested user's + # account is disabled, for the following request errors: * + # CourseMemberLimitReached * CourseNotModifiable * + # UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a + # student or teacher in the course. # @param [String] course_id - # Identifier of the course to create the student in. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course to create the student in. This identifier can be + # either the Classroom-assigned identifier or an alias. # @param [Google::Apis::ClassroomV1::Student] student_object # @param [String] enrollment_code - # Enrollment code of the course to create the student in. - # This code is required if userId - # corresponds to the requesting user; it may be omitted if the requesting - # user has administrative permissions to create students for any user. + # Enrollment code of the course to create the student in. This code is required + # if userId corresponds to the requesting user; it may be omitted if the + # requesting user has administrative permissions to create students for any user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1528,22 +1381,17 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a student of a course. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to delete - # students of this course or for access errors. - # * `NOT_FOUND` if no student of this course has the requested ID or if the - # course does not exist. + # Deletes a student of a course. This method returns the following error codes: * + # `PERMISSION_DENIED` if the requesting user is not permitted to delete + # students of this course or for access errors. * `NOT_FOUND` if no student of + # this course has the requested ID or if the course does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] user_id # Identifier of the student to delete. The identifier can be one of the - # following: - # * the numeric identifier for the user - # * the email address of the user - # * the string literal `"me"`, indicating the requesting user + # following: * the numeric identifier for the user * the email address of the + # user * the string literal `"me"`, indicating the requesting user # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1572,22 +1420,17 @@ module Google execute_or_queue_command(command, &block) end - # Returns a student of a course. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to view - # students of this course or for access errors. - # * `NOT_FOUND` if no student of this course has the requested ID or if the - # course does not exist. + # Returns a student of a course. This method returns the following error codes: * + # `PERMISSION_DENIED` if the requesting user is not permitted to view students + # of this course or for access errors. * `NOT_FOUND` if no student of this + # course has the requested ID or if the course does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] user_id # Identifier of the student to return. The identifier can be one of the - # following: - # * the numeric identifier for the user - # * the email address of the user - # * the string literal `"me"`, indicating the requesting user + # following: * the numeric identifier for the user * the email address of the + # user * the string literal `"me"`, indicating the requesting user # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1616,24 +1459,18 @@ module Google execute_or_queue_command(command, &block) end - # Returns a list of students of this course that the requester - # is permitted to view. - # This method returns the following error codes: - # * `NOT_FOUND` if the course does not exist. - # * `PERMISSION_DENIED` for access errors. + # Returns a list of students of this course that the requester is permitted to + # view. This method returns the following error codes: * `NOT_FOUND` if the + # course does not exist. * `PERMISSION_DENIED` for access errors. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [Fixnum] page_size # Maximum number of items to return. The default is 30 if unspecified or `0`. # The server may return fewer than the specified number of results. # @param [String] page_token - # nextPageToken - # value returned from a previous - # list call, indicating that - # the subsequent page of results should be returned. - # The list request must be + # nextPageToken value returned from a previous list call, indicating that the + # subsequent page of results should be returned. The list request must be # otherwise identical to the one that resulted in this token. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1664,23 +1501,17 @@ module Google execute_or_queue_command(command, &block) end - # Creates a teacher of a course. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to create - # teachers in this course or for access errors. - # * `NOT_FOUND` if the requested course ID does not exist. - # * `FAILED_PRECONDITION` if the requested user's account is disabled, - # for the following request errors: - # * CourseMemberLimitReached - # * CourseNotModifiable - # * CourseTeacherLimitReached - # * UserGroupsMembershipLimitReached - # * `ALREADY_EXISTS` if the user is already a teacher or student in the - # course. + # Creates a teacher of a course. This method returns the following error codes: * + # `PERMISSION_DENIED` if the requesting user is not permitted to create + # teachers in this course or for access errors. * `NOT_FOUND` if the requested + # course ID does not exist. * `FAILED_PRECONDITION` if the requested user's + # account is disabled, for the following request errors: * + # CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * + # UserGroupsMembershipLimitReached * `ALREADY_EXISTS` if the user is already a + # teacher or student in the course. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [Google::Apis::ClassroomV1::Teacher] teacher_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1711,24 +1542,19 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a teacher of a course. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to delete - # teachers of this course or for access errors. - # * `NOT_FOUND` if no teacher of this course has the requested ID or if the - # course does not exist. - # * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher - # of this course. + # Deletes a teacher of a course. This method returns the following error codes: * + # `PERMISSION_DENIED` if the requesting user is not permitted to delete + # teachers of this course or for access errors. * `NOT_FOUND` if no teacher of + # this course has the requested ID or if the course does not exist. * ` + # FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of + # this course. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] user_id # Identifier of the teacher to delete. The identifier can be one of the - # following: - # * the numeric identifier for the user - # * the email address of the user - # * the string literal `"me"`, indicating the requesting user + # following: * the numeric identifier for the user * the email address of the + # user * the string literal `"me"`, indicating the requesting user # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1757,22 +1583,17 @@ module Google execute_or_queue_command(command, &block) end - # Returns a teacher of a course. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to view - # teachers of this course or for access errors. - # * `NOT_FOUND` if no teacher of this course has the requested ID or if the - # course does not exist. + # Returns a teacher of a course. This method returns the following error codes: * + # `PERMISSION_DENIED` if the requesting user is not permitted to view teachers + # of this course or for access errors. * `NOT_FOUND` if no teacher of this + # course has the requested ID or if the course does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] user_id # Identifier of the teacher to return. The identifier can be one of the - # following: - # * the numeric identifier for the user - # * the email address of the user - # * the string literal `"me"`, indicating the requesting user + # following: * the numeric identifier for the user * the email address of the + # user * the string literal `"me"`, indicating the requesting user # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1801,24 +1622,18 @@ module Google execute_or_queue_command(command, &block) end - # Returns a list of teachers of this course that the requester - # is permitted to view. - # This method returns the following error codes: - # * `NOT_FOUND` if the course does not exist. - # * `PERMISSION_DENIED` for access errors. + # Returns a list of teachers of this course that the requester is permitted to + # view. This method returns the following error codes: * `NOT_FOUND` if the + # course does not exist. * `PERMISSION_DENIED` for access errors. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [Fixnum] page_size # Maximum number of items to return. The default is 30 if unspecified or `0`. # The server may return fewer than the specified number of results. # @param [String] page_token - # nextPageToken - # value returned from a previous - # list call, indicating that - # the subsequent page of results should be returned. - # The list request must be + # nextPageToken value returned from a previous list call, indicating that the + # subsequent page of results should be returned. The list request must be # otherwise identical to the one that resulted in this token. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1849,17 +1664,14 @@ module Google execute_or_queue_command(command, &block) end - # Creates a topic. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access the - # requested course, create a topic in the requested course, - # or for access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course does not exist. + # Creates a topic. This method returns the following error codes: * ` + # PERMISSION_DENIED` if the requesting user is not permitted to access the + # requested course, create a topic in the requested course, or for access errors. + # * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the + # requested course does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [Google::Apis::ClassroomV1::Topic] topic_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1890,17 +1702,14 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a topic. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not allowed to delete the - # requested topic or for access errors. - # * `FAILED_PRECONDITION` if the requested topic has already been - # deleted. - # * `NOT_FOUND` if no course or topic exists with the requested ID. + # Deletes a topic. This method returns the following error codes: * ` + # PERMISSION_DENIED` if the requesting user is not allowed to delete the + # requested topic or for access errors. * `FAILED_PRECONDITION` if the requested + # topic has already been deleted. * `NOT_FOUND` if no course or topic exists + # with the requested ID. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] id # Identifier of the topic to delete. # @param [String] fields @@ -1931,12 +1740,11 @@ module Google execute_or_queue_command(command, &block) end - # Returns a topic. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access the - # requested course or topic, or for access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course or topic does not exist. + # Returns a topic. This method returns the following error codes: * ` + # PERMISSION_DENIED` if the requesting user is not permitted to access the + # requested course or topic, or for access errors. * `INVALID_ARGUMENT` if the + # request is malformed. * `NOT_FOUND` if the requested course or topic does not + # exist. # @param [String] course_id # Identifier of the course. # @param [String] id @@ -1969,27 +1777,22 @@ module Google execute_or_queue_command(command, &block) end - # Returns the list of topics that the requester is permitted to view. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access - # the requested course or for access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course does not exist. + # Returns the list of topics that the requester is permitted to view. This + # method returns the following error codes: * `PERMISSION_DENIED` if the + # requesting user is not permitted to access the requested course or for access + # errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the + # requested course does not exist. # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [Fixnum] page_size # Maximum number of items to return. Zero or unspecified indicates that the - # server may assign a maximum. - # The server may return fewer than the specified number of results. + # server may assign a maximum. The server may return fewer than the specified + # number of results. # @param [String] page_token - # nextPageToken - # value returned from a previous - # list call, - # indicating that the subsequent page of results should be returned. - # The list request - # must be otherwise identical to the one that resulted in this token. + # nextPageToken value returned from a previous list call, indicating that the + # subsequent page of results should be returned. The list request must be + # otherwise identical to the one that resulted in this token. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2019,28 +1822,24 @@ module Google execute_or_queue_command(command, &block) end - # Updates one or more fields of a topic. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting developer project did not create - # the corresponding topic or for access errors. - # * `INVALID_ARGUMENT` if the request is malformed. - # * `NOT_FOUND` if the requested course or topic does not exist + # Updates one or more fields of a topic. This method returns the following error + # codes: * `PERMISSION_DENIED` if the requesting developer project did not + # create the corresponding topic or for access errors. * `INVALID_ARGUMENT` if + # the request is malformed. * `NOT_FOUND` if the requested course or topic does + # not exist # @param [String] course_id - # Identifier of the course. - # This identifier can be either the Classroom-assigned identifier or an - # alias. + # Identifier of the course. This identifier can be either the Classroom-assigned + # identifier or an alias. # @param [String] id # Identifier of the topic. # @param [Google::Apis::ClassroomV1::Topic] topic_object # @param [String] update_mask - # Mask that identifies which fields on the topic to update. - # This field is required to do an update. The update fails if invalid - # fields are specified. If a field supports empty values, it can be cleared - # by specifying it in the update mask and not in the Topic object. If a - # field that does not support empty values is included in the update mask and - # not set in the Topic object, an `INVALID_ARGUMENT` error is - # returned. - # The following fields may be specified: + # Mask that identifies which fields on the topic to update. This field is + # required to do an update. The update fails if invalid fields are specified. If + # a field supports empty values, it can be cleared by specifying it in the + # update mask and not in the Topic object. If a field that does not support + # empty values is included in the update mask and not set in the Topic object, + # an `INVALID_ARGUMENT` error is returned. The following fields may be specified: # * `name` # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2073,18 +1872,14 @@ module Google execute_or_queue_command(command, &block) end - # Accepts an invitation, removing it and adding the invited user to the - # teachers or students (as appropriate) of the specified course. Only the - # invited user may accept an invitation. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to accept the - # requested invitation or for access errors. - # * `FAILED_PRECONDITION` for the following request errors: - # * CourseMemberLimitReached - # * CourseNotModifiable - # * CourseTeacherLimitReached - # * UserGroupsMembershipLimitReached - # * `NOT_FOUND` if no invitation exists with the requested ID. + # Accepts an invitation, removing it and adding the invited user to the teachers + # or students (as appropriate) of the specified course. Only the invited user + # may accept an invitation. This method returns the following error codes: * ` + # PERMISSION_DENIED` if the requesting user is not permitted to accept the + # requested invitation or for access errors. * `FAILED_PRECONDITION` for the + # following request errors: * CourseMemberLimitReached * CourseNotModifiable * + # CourseTeacherLimitReached * UserGroupsMembershipLimitReached * `NOT_FOUND` if + # no invitation exists with the requested ID. # @param [String] id # Identifier of the invitation to accept. # @param [String] fields @@ -2114,16 +1909,15 @@ module Google execute_or_queue_command(command, &block) end - # Creates an invitation. Only one invitation for a user and course may exist - # at a time. Delete and re-create an invitation to make changes. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to create - # invitations for this course or for access errors. - # * `NOT_FOUND` if the course or the user does not exist. - # * `FAILED_PRECONDITION` if the requested user's account is disabled or if - # the user already has this role or a role with greater permissions. - # * `ALREADY_EXISTS` if an invitation for the specified user and course - # already exists. + # Creates an invitation. Only one invitation for a user and course may exist at + # a time. Delete and re-create an invitation to make changes. This method + # returns the following error codes: * `PERMISSION_DENIED` if the requesting + # user is not permitted to create invitations for this course or for access + # errors. * `NOT_FOUND` if the course or the user does not exist. * ` + # FAILED_PRECONDITION` if the requested user's account is disabled or if the + # user already has this role or a role with greater permissions. * ` + # ALREADY_EXISTS` if an invitation for the specified user and course already + # exists. # @param [Google::Apis::ClassroomV1::Invitation] invitation_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2153,11 +1947,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes an invitation. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to delete the - # requested invitation or for access errors. - # * `NOT_FOUND` if no invitation exists with the requested ID. + # Deletes an invitation. This method returns the following error codes: * ` + # PERMISSION_DENIED` if the requesting user is not permitted to delete the + # requested invitation or for access errors. * `NOT_FOUND` if no invitation + # exists with the requested ID. # @param [String] id # Identifier of the invitation to delete. # @param [String] fields @@ -2187,11 +1980,10 @@ module Google execute_or_queue_command(command, &block) end - # Returns an invitation. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to view the - # requested invitation or for access errors. - # * `NOT_FOUND` if no invitation exists with the requested ID. + # Returns an invitation. This method returns the following error codes: * ` + # PERMISSION_DENIED` if the requesting user is not permitted to view the + # requested invitation or for access errors. * `NOT_FOUND` if no invitation + # exists with the requested ID. # @param [String] id # Identifier of the invitation to return. # @param [String] fields @@ -2221,32 +2013,26 @@ module Google execute_or_queue_command(command, &block) end - # Returns a list of invitations that the requesting user is permitted to - # view, restricted to those that match the list request. - # *Note:* At least one of `user_id` or `course_id` must be supplied. Both - # fields can be supplied. - # This method returns the following error codes: - # * `PERMISSION_DENIED` for access errors. + # Returns a list of invitations that the requesting user is permitted to view, + # restricted to those that match the list request. *Note:* At least one of ` + # user_id` or `course_id` must be supplied. Both fields can be supplied. This + # method returns the following error codes: * `PERMISSION_DENIED` for access + # errors. # @param [String] course_id # Restricts returned invitations to those for a course with the specified # identifier. # @param [Fixnum] page_size - # Maximum number of items to return. The default is 500 if unspecified or - # `0`. + # Maximum number of items to return. The default is 500 if unspecified or `0`. # The server may return fewer than the specified number of results. # @param [String] page_token - # nextPageToken - # value returned from a previous - # list call, indicating - # that the subsequent page of results should be returned. - # The list request must be + # nextPageToken value returned from a previous list call, indicating that the + # subsequent page of results should be returned. The list request must be # otherwise identical to the one that resulted in this token. # @param [String] user_id # Restricts returned invitations to those for a specific user. The identifier - # can be one of the following: - # * the numeric identifier for the user - # * the email address of the user - # * the string literal `"me"`, indicating the requesting user + # can be one of the following: * the numeric identifier for the user * the email + # address of the user * the string literal `"me"`, indicating the requesting + # user # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2279,33 +2065,25 @@ module Google # Creates a `Registration`, causing Classroom to start sending notifications # from the provided `feed` to the destination provided in `cloudPubSubTopic`. - # Returns the created `Registration`. Currently, this will be the same as - # the argument, but with server-assigned fields such as `expiry_time` and - # `id` filled in. - # Note that any value specified for the `expiry_time` or `id` fields will be - # ignored. - # While Classroom may validate the `cloudPubSubTopic` and return errors on a - # best effort basis, it is the caller's responsibility to ensure that it - # exists and that Classroom has permission to publish to it. - # This method may return the following error codes: - # * `PERMISSION_DENIED` if: - # * the authenticated user does not have permission to receive - # notifications from the requested field; or - # * the current user has not granted access to the current Cloud project - # with the appropriate scope for the requested feed. Note that - # domain-wide delegation of authority is not currently supported for - # this purpose. If the request has the appropriate scope, but no grant - # exists, a Request Errors is returned. - # * another access error is encountered. - # * `INVALID_ARGUMENT` if: - # * no `cloudPubsubTopic` is specified, or the specified - # `cloudPubsubTopic` is not valid; or - # * no `feed` is specified, or the specified `feed` is not valid. - # * `NOT_FOUND` if: - # * the specified `feed` cannot be located, or the requesting user does - # not have permission to determine whether or not it exists; or - # * the specified `cloudPubsubTopic` cannot be located, or Classroom has - # not been granted permission to publish to it. + # Returns the created `Registration`. Currently, this will be the same as the + # argument, but with server-assigned fields such as `expiry_time` and `id` + # filled in. Note that any value specified for the `expiry_time` or `id` fields + # will be ignored. While Classroom may validate the `cloudPubSubTopic` and + # return errors on a best effort basis, it is the caller's responsibility to + # ensure that it exists and that Classroom has permission to publish to it. This + # method may return the following error codes: * `PERMISSION_DENIED` if: * the + # authenticated user does not have permission to receive notifications from the + # requested field; or * the current user has not granted access to the current + # Cloud project with the appropriate scope for the requested feed. Note that + # domain-wide delegation of authority is not currently supported for this + # purpose. If the request has the appropriate scope, but no grant exists, a + # Request Errors is returned. * another access error is encountered. * ` + # INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified ` + # cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified ` + # feed` is not valid. * `NOT_FOUND` if: * the specified `feed` cannot be located, + # or the requesting user does not have permission to determine whether or not + # it exists; or * the specified `cloudPubsubTopic` cannot be located, or + # Classroom has not been granted permission to publish to it. # @param [Google::Apis::ClassroomV1::Registration] registration_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2335,8 +2113,8 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a `Registration`, causing Classroom to stop sending notifications - # for that `Registration`. + # Deletes a `Registration`, causing Classroom to stop sending notifications for + # that `Registration`. # @param [String] registration_id # The `registration_id` of the `Registration` to be deleted. # @param [String] fields @@ -2366,17 +2144,13 @@ module Google execute_or_queue_command(command, &block) end - # Returns a user profile. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to access - # this user profile, if no profile exists with the requested ID, or for - # access errors. + # Returns a user profile. This method returns the following error codes: * ` + # PERMISSION_DENIED` if the requesting user is not permitted to access this user + # profile, if no profile exists with the requested ID, or for access errors. # @param [String] user_id # Identifier of the profile to return. The identifier can be one of the - # following: - # * the numeric identifier for the user - # * the email address of the user - # * the string literal `"me"`, indicating the requesting user + # following: * the numeric identifier for the user * the email address of the + # user * the string literal `"me"`, indicating the requesting user # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2404,32 +2178,28 @@ module Google execute_or_queue_command(command, &block) end - # Creates a guardian invitation, and sends an email to the guardian asking - # them to confirm that they are the student's guardian. - # Once the guardian accepts the invitation, their `state` will change to - # `COMPLETED` and they will start receiving guardian notifications. A - # `Guardian` resource will also be created to represent the active guardian. - # The request object must have the `student_id` and - # `invited_email_address` fields set. Failing to set these fields, or - # setting any other fields in the request, will result in an error. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the current user does not have permission to - # manage guardians, if the guardian in question has already rejected - # too many requests for that student, if guardians are not enabled for the - # domain in question, or for other access errors. - # * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian - # link limit. - # * `INVALID_ARGUMENT` if the guardian email address is not valid (for + # Creates a guardian invitation, and sends an email to the guardian asking them + # to confirm that they are the student's guardian. Once the guardian accepts the + # invitation, their `state` will change to `COMPLETED` and they will start + # receiving guardian notifications. A `Guardian` resource will also be created + # to represent the active guardian. The request object must have the `student_id` + # and `invited_email_address` fields set. Failing to set these fields, or + # setting any other fields in the request, will result in an error. This method + # returns the following error codes: * `PERMISSION_DENIED` if the current user + # does not have permission to manage guardians, if the guardian in question has + # already rejected too many requests for that student, if guardians are not + # enabled for the domain in question, or for other access errors. * ` + # RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link + # limit. * `INVALID_ARGUMENT` if the guardian email address is not valid (for # example, if it is too long), or if the format of the student ID provided - # cannot be recognized (it is not an email address, nor a `user_id` from - # this API). This error will also be returned if read-only fields are set, - # or if the `state` field is set to to a value other than `PENDING`. - # * `NOT_FOUND` if the student ID provided is a valid student ID, but - # Classroom has no record of that student. - # * `ALREADY_EXISTS` if there is already a pending guardian invitation for - # the student and `invited_email_address` provided, or if the provided - # `invited_email_address` matches the Google account of an existing - # `Guardian` for this user. + # cannot be recognized (it is not an email address, nor a `user_id` from this + # API). This error will also be returned if read-only fields are set, or if the ` + # state` field is set to to a value other than `PENDING`. * `NOT_FOUND` if the + # student ID provided is a valid student ID, but Classroom has no record of that + # student. * `ALREADY_EXISTS` if there is already a pending guardian invitation + # for the student and `invited_email_address` provided, or if the provided ` + # invited_email_address` matches the Google account of an existing `Guardian` + # for this user. # @param [String] student_id # ID of the student (in standard format) # @param [Google::Apis::ClassroomV1::GuardianInvitation] guardian_invitation_object @@ -2462,18 +2232,16 @@ module Google execute_or_queue_command(command, &block) end - # Returns a specific guardian invitation. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the requesting user is not permitted to view - # guardian invitations for the student identified by the `student_id`, if - # guardians are not enabled for the domain in question, or for other - # access errors. - # * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot - # be recognized (it is not an email address, nor a `student_id` from the - # API, nor the literal string `me`). - # * `NOT_FOUND` if Classroom cannot find any record of the given student or - # `invitation_id`. May also be returned if the student exists, but the - # requesting user does not have access to see that student. + # Returns a specific guardian invitation. This method returns the following + # error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to + # view guardian invitations for the student identified by the `student_id`, if + # guardians are not enabled for the domain in question, or for other access + # errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format + # cannot be recognized (it is not an email address, nor a `student_id` from the + # API, nor the literal string `me`). * `NOT_FOUND` if Classroom cannot find any + # record of the given student or `invitation_id`. May also be returned if the + # student exists, but the requesting user does not have access to see that + # student. # @param [String] student_id # The ID of the student whose guardian invitation is being requested. # @param [String] invitation_id @@ -2506,46 +2274,39 @@ module Google execute_or_queue_command(command, &block) end - # Returns a list of guardian invitations that the requesting user is - # permitted to view, filtered by the parameters provided. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting - # user is not permitted to view guardian invitations for that student, if - # `"-"` is specified as the `student_id` and the user is not a domain - # administrator, if guardians are not enabled for the domain in question, - # or for other access errors. - # * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot - # be recognized (it is not an email address, nor a `student_id` from the - # API, nor the literal string `me`). May also be returned if an invalid - # `page_token` or `state` is provided. - # * `NOT_FOUND` if a `student_id` is specified, and its format can be - # recognized, but Classroom has no record of that student. + # Returns a list of guardian invitations that the requesting user is permitted + # to view, filtered by the parameters provided. This method returns the + # following error codes: * `PERMISSION_DENIED` if a `student_id` is specified, + # and the requesting user is not permitted to view guardian invitations for that + # student, if `"-"` is specified as the `student_id` and the user is not a + # domain administrator, if guardians are not enabled for the domain in question, + # or for other access errors. * `INVALID_ARGUMENT` if a `student_id` is + # specified, but its format cannot be recognized (it is not an email address, + # nor a `student_id` from the API, nor the literal string `me`). May also be + # returned if an invalid `page_token` or `state` is provided. * `NOT_FOUND` if a + # `student_id` is specified, and its format can be recognized, but Classroom has + # no record of that student. # @param [String] student_id - # The ID of the student whose guardian invitations are to be returned. - # The identifier can be one of the following: - # * the numeric identifier for the user - # * the email address of the user - # * the string literal `"me"`, indicating the requesting user - # * the string literal `"-"`, indicating that results should be returned for - # all students that the requesting user is permitted to view guardian - # invitations. + # The ID of the student whose guardian invitations are to be returned. The + # identifier can be one of the following: * the numeric identifier for the user * + # the email address of the user * the string literal `"me"`, indicating the + # requesting user * the string literal `"-"`, indicating that results should be + # returned for all students that the requesting user is permitted to view + # guardian invitations. # @param [String] invited_email_address - # If specified, only results with the specified `invited_email_address` - # are returned. + # If specified, only results with the specified `invited_email_address` are + # returned. # @param [Fixnum] page_size # Maximum number of items to return. Zero or unspecified indicates that the - # server may assign a maximum. - # The server may return fewer than the specified number of results. + # server may assign a maximum. The server may return fewer than the specified + # number of results. # @param [String] page_token - # nextPageToken - # value returned from a previous - # list - # call, indicating that the subsequent page of results should be returned. - # The list - # request must be otherwise identical to the one that resulted in this token. + # nextPageToken value returned from a previous list call, indicating that the + # subsequent page of results should be returned. The list request must be + # otherwise identical to the one that resulted in this token. # @param [Array, String] states - # If specified, only results with the specified `state` values are - # returned. Otherwise, results with a `state` of `PENDING` are returned. + # If specified, only results with the specified `state` values are returned. + # Otherwise, results with a `state` of `PENDING` are returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2577,33 +2338,29 @@ module Google execute_or_queue_command(command, &block) end - # Modifies a guardian invitation. - # Currently, the only valid modification is to change the `state` from - # `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if the current user does not have permission to - # manage guardians, if guardians are not enabled for the domain in question - # or for other access errors. - # * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. - # * `INVALID_ARGUMENT` if the format of the student ID provided - # cannot be recognized (it is not an email address, nor a `user_id` from - # this API), or if the passed `GuardianInvitation` has a `state` other than - # `COMPLETE`, or if it modifies fields other than `state`. - # * `NOT_FOUND` if the student ID provided is a valid student ID, but - # Classroom has no record of that student, or if the `id` field does not - # refer to a guardian invitation known to Classroom. + # Modifies a guardian invitation. Currently, the only valid modification is to + # change the `state` from `PENDING` to `COMPLETE`. This has the effect of + # withdrawing the invitation. This method returns the following error codes: * ` + # PERMISSION_DENIED` if the current user does not have permission to manage + # guardians, if guardians are not enabled for the domain in question or for + # other access errors. * `FAILED_PRECONDITION` if the guardian link is not in + # the `PENDING` state. * `INVALID_ARGUMENT` if the format of the student ID + # provided cannot be recognized (it is not an email address, nor a `user_id` + # from this API), or if the passed `GuardianInvitation` has a `state` other than + # `COMPLETE`, or if it modifies fields other than `state`. * `NOT_FOUND` if the + # student ID provided is a valid student ID, but Classroom has no record of that + # student, or if the `id` field does not refer to a guardian invitation known to + # Classroom. # @param [String] student_id # The ID of the student whose guardian invitation is to be modified. # @param [String] invitation_id # The `id` field of the `GuardianInvitation` to be modified. # @param [Google::Apis::ClassroomV1::GuardianInvitation] guardian_invitation_object # @param [String] update_mask - # Mask that identifies which fields on the course to update. - # This field is required to do an update. The update fails if invalid - # fields are specified. The following fields are valid: - # * `state` - # When set in a query parameter, this field should be specified as - # `updateMask=,,...` + # Mask that identifies which fields on the course to update. This field is + # required to do an update. The update fails if invalid fields are specified. + # The following fields are valid: * `state` When set in a query parameter, this + # field should be specified as `updateMask=,,...` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2635,26 +2392,21 @@ module Google execute_or_queue_command(command, &block) end - # Deletes a guardian. - # The guardian will no longer receive guardian notifications and the guardian - # will no longer be accessible via the API. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if no user that matches the provided `student_id` - # is visible to the requesting user, if the requesting user is not - # permitted to manage guardians for the student identified by the - # `student_id`, if guardians are not enabled for the domain in question, - # or for other access errors. - # * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot - # be recognized (it is not an email address, nor a `student_id` from the - # API). - # * `NOT_FOUND` if the requesting user is permitted to modify guardians for - # the requested `student_id`, but no `Guardian` record exists for that - # student with the provided `guardian_id`. + # Deletes a guardian. The guardian will no longer receive guardian notifications + # and the guardian will no longer be accessible via the API. This method returns + # the following error codes: * `PERMISSION_DENIED` if no user that matches the + # provided `student_id` is visible to the requesting user, if the requesting + # user is not permitted to manage guardians for the student identified by the ` + # student_id`, if guardians are not enabled for the domain in question, or for + # other access errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but + # its format cannot be recognized (it is not an email address, nor a `student_id` + # from the API). * `NOT_FOUND` if the requesting user is permitted to modify + # guardians for the requested `student_id`, but no `Guardian` record exists for + # that student with the provided `guardian_id`. # @param [String] student_id - # The student whose guardian is to be deleted. One of the following: - # * the numeric identifier for the user - # * the email address of the user - # * the string literal `"me"`, indicating the requesting user + # The student whose guardian is to be deleted. One of the following: * the + # numeric identifier for the user * the email address of the user * the string + # literal `"me"`, indicating the requesting user # @param [String] guardian_id # The `id` field from a `Guardian`. # @param [String] fields @@ -2685,24 +2437,20 @@ module Google execute_or_queue_command(command, &block) end - # Returns a specific guardian. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if no user that matches the provided `student_id` - # is visible to the requesting user, if the requesting user is not - # permitted to view guardian information for the student identified by the - # `student_id`, if guardians are not enabled for the domain in question, - # or for other access errors. - # * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot - # be recognized (it is not an email address, nor a `student_id` from the - # API, nor the literal string `me`). - # * `NOT_FOUND` if the requesting user is permitted to view guardians for - # the requested `student_id`, but no `Guardian` record exists for that - # student that matches the provided `guardian_id`. + # Returns a specific guardian. This method returns the following error codes: * ` + # PERMISSION_DENIED` if no user that matches the provided `student_id` is + # visible to the requesting user, if the requesting user is not permitted to + # view guardian information for the student identified by the `student_id`, if + # guardians are not enabled for the domain in question, or for other access + # errors. * `INVALID_ARGUMENT` if a `student_id` is specified, but its format + # cannot be recognized (it is not an email address, nor a `student_id` from the + # API, nor the literal string `me`). * `NOT_FOUND` if the requesting user is + # permitted to view guardians for the requested `student_id`, but no `Guardian` + # record exists for that student that matches the provided `guardian_id`. # @param [String] student_id - # The student whose guardian is being requested. One of the following: - # * the numeric identifier for the user - # * the email address of the user - # * the string literal `"me"`, indicating the requesting user + # The student whose guardian is being requested. One of the following: * the + # numeric identifier for the user * the email address of the user * the string + # literal `"me"`, indicating the requesting user # @param [String] guardian_id # The `id` field from a `Guardian`. # @param [String] fields @@ -2733,46 +2481,39 @@ module Google execute_or_queue_command(command, &block) end - # Returns a list of guardians that the requesting user is permitted to - # view, restricted to those that match the request. - # To list guardians for any student that the requesting user may view - # guardians for, use the literal character `-` for the student ID. - # This method returns the following error codes: - # * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting - # user is not permitted to view guardian information for that student, if - # `"-"` is specified as the `student_id` and the user is not a domain - # administrator, if guardians are not enabled for the domain in question, - # if the `invited_email_address` filter is set by a user who is not a - # domain administrator, or for other access errors. - # * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot - # be recognized (it is not an email address, nor a `student_id` from the - # API, nor the literal string `me`). May also be returned if an invalid - # `page_token` is provided. - # * `NOT_FOUND` if a `student_id` is specified, and its format can be - # recognized, but Classroom has no record of that student. + # Returns a list of guardians that the requesting user is permitted to view, + # restricted to those that match the request. To list guardians for any student + # that the requesting user may view guardians for, use the literal character `-` + # for the student ID. This method returns the following error codes: * ` + # PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is + # not permitted to view guardian information for that student, if `"-"` is + # specified as the `student_id` and the user is not a domain administrator, if + # guardians are not enabled for the domain in question, if the ` + # invited_email_address` filter is set by a user who is not a domain + # administrator, or for other access errors. * `INVALID_ARGUMENT` if a ` + # student_id` is specified, but its format cannot be recognized (it is not an + # email address, nor a `student_id` from the API, nor the literal string `me`). + # May also be returned if an invalid `page_token` is provided. * `NOT_FOUND` if + # a `student_id` is specified, and its format can be recognized, but Classroom + # has no record of that student. # @param [String] student_id - # Filter results by the student who the guardian is linked to. - # The identifier can be one of the following: - # * the numeric identifier for the user - # * the email address of the user - # * the string literal `"me"`, indicating the requesting user - # * the string literal `"-"`, indicating that results should be returned for - # all students that the requesting user has access to view. + # Filter results by the student who the guardian is linked to. The identifier + # can be one of the following: * the numeric identifier for the user * the email + # address of the user * the string literal `"me"`, indicating the requesting + # user * the string literal `"-"`, indicating that results should be returned + # for all students that the requesting user has access to view. # @param [String] invited_email_address - # Filter results by the email address that the original invitation was sent - # to, resulting in this guardian link. - # This filter can only be used by domain administrators. + # Filter results by the email address that the original invitation was sent to, + # resulting in this guardian link. This filter can only be used by domain + # administrators. # @param [Fixnum] page_size # Maximum number of items to return. Zero or unspecified indicates that the - # server may assign a maximum. - # The server may return fewer than the specified number of results. + # server may assign a maximum. The server may return fewer than the specified + # number of results. # @param [String] page_token - # nextPageToken - # value returned from a previous - # list call, - # indicating that the subsequent page of results should be returned. - # The list request - # must be otherwise identical to the one that resulted in this token. + # nextPageToken value returned from a previous list call, indicating that the + # subsequent page of results should be returned. The list request must be + # otherwise identical to the one that resulted in this token. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/cloudasset_v1.rb b/generated/google/apis/cloudasset_v1.rb index 590b834e5..7bafdc7be 100644 --- a/generated/google/apis/cloudasset_v1.rb +++ b/generated/google/apis/cloudasset_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/asset-inventory/docs/quickstart module CloudassetV1 VERSION = 'V1' - REVISION = '20200724' + 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/cloudasset_v1/classes.rb b/generated/google/apis/cloudasset_v1/classes.rb index 2d3f46c2c..15ef6b504 100644 --- a/generated/google/apis/cloudasset_v1/classes.rb +++ b/generated/google/apis/cloudasset_v1/classes.rb @@ -1626,7 +1626,9 @@ module Google include Google::Apis::Core::Hashable # The list of APIs usable within the Service Perimeter. Must be empty - # unless 'enable_restriction' is True. + # unless 'enable_restriction' is True. You can specify a list of individual + # services, as well as include the 'RESTRICTED-SERVICES' value, which + # automatically includes all of the services protected by the perimeter. # Corresponds to the JSON property `allowedServices` # @return [Array] attr_accessor :allowed_services diff --git a/generated/google/apis/cloudasset_v1beta1.rb b/generated/google/apis/cloudasset_v1beta1.rb index ce41dcc49..e3bf070a1 100644 --- a/generated/google/apis/cloudasset_v1beta1.rb +++ b/generated/google/apis/cloudasset_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/asset-inventory/docs/quickstart module CloudassetV1beta1 VERSION = 'V1beta1' - REVISION = '20200613' + 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/cloudasset_v1beta1/classes.rb b/generated/google/apis/cloudasset_v1beta1/classes.rb index ff49b8856..cf04eaf47 100644 --- a/generated/google/apis/cloudasset_v1beta1/classes.rb +++ b/generated/google/apis/cloudasset_v1beta1/classes.rb @@ -1370,7 +1370,9 @@ module Google include Google::Apis::Core::Hashable # The list of APIs usable within the Service Perimeter. Must be empty - # unless 'enable_restriction' is True. + # unless 'enable_restriction' is True. You can specify a list of individual + # services, as well as include the 'RESTRICTED-SERVICES' value, which + # automatically includes all of the services protected by the perimeter. # Corresponds to the JSON property `allowedServices` # @return [Array] attr_accessor :allowed_services diff --git a/generated/google/apis/cloudasset_v1p4beta1.rb b/generated/google/apis/cloudasset_v1p4beta1.rb index 45597ac21..f297a5e92 100644 --- a/generated/google/apis/cloudasset_v1p4beta1.rb +++ b/generated/google/apis/cloudasset_v1p4beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/asset-inventory/docs/quickstart module CloudassetV1p4beta1 VERSION = 'V1p4beta1' - REVISION = '20200724' + 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/cloudasset_v1p5beta1.rb b/generated/google/apis/cloudasset_v1p5beta1.rb index b9d915709..e088c6803 100644 --- a/generated/google/apis/cloudasset_v1p5beta1.rb +++ b/generated/google/apis/cloudasset_v1p5beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/asset-inventory/docs/quickstart module CloudassetV1p5beta1 VERSION = 'V1p5beta1' - REVISION = '20200717' + 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/cloudasset_v1p5beta1/classes.rb b/generated/google/apis/cloudasset_v1p5beta1/classes.rb index f0f366397..398adff9f 100644 --- a/generated/google/apis/cloudasset_v1p5beta1/classes.rb +++ b/generated/google/apis/cloudasset_v1p5beta1/classes.rb @@ -1281,7 +1281,9 @@ module Google include Google::Apis::Core::Hashable # The list of APIs usable within the Service Perimeter. Must be empty - # unless 'enable_restriction' is True. + # unless 'enable_restriction' is True. You can specify a list of individual + # services, as well as include the 'RESTRICTED-SERVICES' value, which + # automatically includes all of the services protected by the perimeter. # Corresponds to the JSON property `allowedServices` # @return [Array] attr_accessor :allowed_services diff --git a/generated/google/apis/dialogflow_v2.rb b/generated/google/apis/dialogflow_v2.rb index 6bdcde1c7..c95a3dea8 100644 --- a/generated/google/apis/dialogflow_v2.rb +++ b/generated/google/apis/dialogflow_v2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/dialogflow/ module DialogflowV2 VERSION = 'V2' - REVISION = '20200719' + 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/dialogflow_v2/classes.rb b/generated/google/apis/dialogflow_v2/classes.rb index 39c3fe547..1f5f19b97 100644 --- a/generated/google/apis/dialogflow_v2/classes.rb +++ b/generated/google/apis/dialogflow_v2/classes.rb @@ -32,8 +32,8 @@ module Google # @return [String] attr_accessor :agent_content - # The URI to a file containing the exported agent. This field is populated - # only if `agent_uri` is specified in ExportAgentRequest. + # The URI to a file containing the exported agent. This field is populated only + # if `agent_uri` is specified in ExportAgentRequest. # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri @@ -53,10 +53,9 @@ module Google class GoogleCloudDialogflowCxV3beta1PageInfo include Google::Apis::Core::Hashable - # Always present for WebhookRequest. Ignored for WebhookResponse. - # The unique identifier of the current page. - # Format: `projects//locations//agents//flows//pages/`. + # Always present for WebhookRequest. Ignored for WebhookResponse. The unique + # identifier of the current page. Format: `projects//locations//agents//flows// + # pages/`. # Corresponds to the JSON property `currentPage` # @return [String] attr_accessor :current_page @@ -81,9 +80,8 @@ module Google class GoogleCloudDialogflowCxV3beta1PageInfoFormInfo include Google::Apis::Core::Hashable - # Optional for both WebhookRequest and WebhookResponse. - # The parameters contained in the form. Note that the webhook cannot add - # or remove any form parameter. + # Optional for both WebhookRequest and WebhookResponse. The parameters contained + # in the form. Note that the webhook cannot add or remove any form parameter. # Corresponds to the JSON property `parameterInfo` # @return [Array] attr_accessor :parameter_info @@ -102,43 +100,38 @@ module Google class GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo include Google::Apis::Core::Hashable - # Always present for WebhookRequest. Required for - # WebhookResponse. - # The human-readable name of the parameter, unique within the form. This - # field cannot be modified by the webhook. + # Always present for WebhookRequest. Required for WebhookResponse. The human- + # readable name of the parameter, unique within the form. This field cannot be + # modified by the webhook. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Optional for WebhookRequest. Ignored for WebhookResponse. - # Indicates if the parameter value was just collected on the last - # conversation turn. + # Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the + # parameter value was just collected on the last conversation turn. # Corresponds to the JSON property `justCollected` # @return [Boolean] attr_accessor :just_collected alias_method :just_collected?, :just_collected - # Optional for both WebhookRequest and WebhookResponse. - # Indicates whether the parameter is required. Optional parameters will - # not trigger prompts; however, they are filled if the user specifies - # them. Required parameters must be filled before form filling concludes. + # Optional for both WebhookRequest and WebhookResponse. Indicates whether the + # parameter is required. Optional parameters will not trigger prompts; however, + # they are filled if the user specifies them. Required parameters must be filled + # before form filling concludes. # Corresponds to the JSON property `required` # @return [Boolean] attr_accessor :required alias_method :required?, :required - # Always present for WebhookRequest. Required for - # WebhookResponse. The state of the parameter. This field can be set - # to INVALID by - # the webhook to invalidate the parameter; other values set by the - # webhook will be ignored. + # Always present for WebhookRequest. Required for WebhookResponse. The state of + # the parameter. This field can be set to INVALID by the webhook to invalidate + # the parameter; other values set by the webhook will be ignored. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state - # Optional for both WebhookRequest and WebhookResponse. - # The value of the parameter. This field can be set by the webhook to - # change the parameter value. + # Optional for both WebhookRequest and WebhookResponse. The value of the + # parameter. This field can be set by the webhook to change the parameter value. # Corresponds to the JSON property `value` # @return [Object] attr_accessor :value @@ -158,80 +151,65 @@ module Google end # Represents a response message that can be returned by a conversational agent. - # Response messages are also used for output audio synthesis. The approach is - # as follows: - # * If at least one OutputAudioText response is present, then all + # Response messages are also used for output audio synthesis. The approach is as + # follows: * If at least one OutputAudioText response is present, then all # OutputAudioText responses are linearly concatenated, and the result is used - # for output audio synthesis. - # * If the OutputAudioText responses are a mixture of text and SSML, then the - # concatenated result is treated as SSML; otherwise, the result is treated as - # either text or SSML as appropriate. The agent designer should ideally use - # either text or SSML consistently throughout the bot design. - # * Otherwise, all Text responses are linearly concatenated, and the result is - # used for output audio synthesis. - # This approach allows for more sophisticated user experience scenarios, where - # the text displayed to the user may differ from what is heard. + # for output audio synthesis. * If the OutputAudioText responses are a mixture + # of text and SSML, then the concatenated result is treated as SSML; otherwise, + # the result is treated as either text or SSML as appropriate. The agent + # designer should ideally use either text or SSML consistently throughout the + # bot design. * Otherwise, all Text responses are linearly concatenated, and the + # result is used for output audio synthesis. This approach allows for more + # sophisticated user experience scenarios, where the text displayed to the user + # may differ from what is heard. class GoogleCloudDialogflowCxV3beta1ResponseMessage include Google::Apis::Core::Hashable # Indicates that the conversation succeeded, i.e., the bot handled the issue - # that the customer talked to it about. - # Dialogflow only uses this to determine which conversations should be - # counted as successful and doesn't process the metadata in this message in - # any way. Note that Dialogflow also considers conversations that get to the - # conversation end page as successful even if they don't return - # ConversationSuccess. - # You may set this, for example: - # * In the entry_fulfillment of a Page if - # entering the page indicates that the conversation succeeded. - # * In a webhook response when you determine that you handled the customer - # issue. + # that the customer talked to it about. Dialogflow only uses this to determine + # which conversations should be counted as successful and doesn't process the + # metadata in this message in any way. Note that Dialogflow also considers + # conversations that get to the conversation end page as successful even if they + # don't return ConversationSuccess. You may set this, for example: * In the + # entry_fulfillment of a Page if entering the page indicates that the + # conversation succeeded. * In a webhook response when you determine that you + # handled the customer issue. # Corresponds to the JSON property `conversationSuccess` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess] attr_accessor :conversation_success - # Indicates that interaction with the Dialogflow agent has ended. - # This message is generated by Dialogflow only and not supposed to be - # defined by the user. + # Indicates that interaction with the Dialogflow agent has ended. This message + # is generated by Dialogflow only and not supposed to be defined by the user. # Corresponds to the JSON property `endInteraction` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction] attr_accessor :end_interaction # Indicates that the conversation should be handed off to a human agent. - # Dialogflow only uses this to determine which conversations were handed off - # to a human agent for measurement purposes. What else to do with this signal - # is up to you and your handoff procedures. - # You may set this, for example: - # * In the entry_fulfillment of a Page if - # entering the page indicates something went extremely wrong in the - # conversation. - # * In a webhook response when you determine that the customer issue can only - # be handled by a human. + # Dialogflow only uses this to determine which conversations were handed off to + # a human agent for measurement purposes. What else to do with this signal is up + # to you and your handoff procedures. You may set this, for example: * In the + # entry_fulfillment of a Page if entering the page indicates something went + # extremely wrong in the conversation. * In a webhook response when you + # determine that the customer issue can only be handled by a human. # Corresponds to the JSON property `humanAgentHandoff` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff] attr_accessor :human_agent_handoff # Indicates that the conversation should be handed off to a live agent. - # Dialogflow only uses this to determine which conversations were handed off - # to a human agent for measurement purposes. What else to do with this signal - # is up to you and your handoff procedures. - # You may set this, for example: - # * In the entry_fulfillment of a Page if - # entering the page indicates something went extremely wrong in the - # conversation. - # * In a webhook response when you determine that the customer issue can only - # be handled by a human. + # Dialogflow only uses this to determine which conversations were handed off to + # a human agent for measurement purposes. What else to do with this signal is up + # to you and your handoff procedures. You may set this, for example: * In the + # entry_fulfillment of a Page if entering the page indicates something went + # extremely wrong in the conversation. * In a webhook response when you + # determine that the customer issue can only be handled by a human. # Corresponds to the JSON property `liveAgentHandoff` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff] attr_accessor :live_agent_handoff - # Represents an audio message that is composed of both segments - # synthesized from the Dialogflow agent prompts and ones hosted externally - # at the specified URIs. - # The external URIs are specified via - # play_audio. - # This message is generated by Dialogflow only and not supposed to be - # defined by the user. + # Represents an audio message that is composed of both segments synthesized from + # the Dialogflow agent prompts and ones hosted externally at the specified URIs. + # The external URIs are specified via play_audio. This message is generated by + # Dialogflow only and not supposed to be defined by the user. # Corresponds to the JSON property `mixedAudio` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio] attr_accessor :mixed_audio @@ -276,17 +254,14 @@ module Google end # Indicates that the conversation succeeded, i.e., the bot handled the issue - # that the customer talked to it about. - # Dialogflow only uses this to determine which conversations should be - # counted as successful and doesn't process the metadata in this message in - # any way. Note that Dialogflow also considers conversations that get to the - # conversation end page as successful even if they don't return - # ConversationSuccess. - # You may set this, for example: - # * In the entry_fulfillment of a Page if - # entering the page indicates that the conversation succeeded. - # * In a webhook response when you determine that you handled the customer - # issue. + # that the customer talked to it about. Dialogflow only uses this to determine + # which conversations should be counted as successful and doesn't process the + # metadata in this message in any way. Note that Dialogflow also considers + # conversations that get to the conversation end page as successful even if they + # don't return ConversationSuccess. You may set this, for example: * In the + # entry_fulfillment of a Page if entering the page indicates that the + # conversation succeeded. * In a webhook response when you determine that you + # handled the customer issue. class GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess include Google::Apis::Core::Hashable @@ -305,9 +280,8 @@ module Google end end - # Indicates that interaction with the Dialogflow agent has ended. - # This message is generated by Dialogflow only and not supposed to be - # defined by the user. + # Indicates that interaction with the Dialogflow agent has ended. This message + # is generated by Dialogflow only and not supposed to be defined by the user. class GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction include Google::Apis::Core::Hashable @@ -321,20 +295,17 @@ module Google end # Indicates that the conversation should be handed off to a human agent. - # Dialogflow only uses this to determine which conversations were handed off - # to a human agent for measurement purposes. What else to do with this signal - # is up to you and your handoff procedures. - # You may set this, for example: - # * In the entry_fulfillment of a Page if - # entering the page indicates something went extremely wrong in the - # conversation. - # * In a webhook response when you determine that the customer issue can only - # be handled by a human. + # Dialogflow only uses this to determine which conversations were handed off to + # a human agent for measurement purposes. What else to do with this signal is up + # to you and your handoff procedures. You may set this, for example: * In the + # entry_fulfillment of a Page if entering the page indicates something went + # extremely wrong in the conversation. * In a webhook response when you + # determine that the customer issue can only be handled by a human. class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff include Google::Apis::Core::Hashable - # Custom metadata for your handoff procedure. Dialogflow doesn't impose - # any structure on this. + # Custom metadata for your handoff procedure. Dialogflow doesn't impose any + # structure on this. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata @@ -350,20 +321,17 @@ module Google end # Indicates that the conversation should be handed off to a live agent. - # Dialogflow only uses this to determine which conversations were handed off - # to a human agent for measurement purposes. What else to do with this signal - # is up to you and your handoff procedures. - # You may set this, for example: - # * In the entry_fulfillment of a Page if - # entering the page indicates something went extremely wrong in the - # conversation. - # * In a webhook response when you determine that the customer issue can only - # be handled by a human. + # Dialogflow only uses this to determine which conversations were handed off to + # a human agent for measurement purposes. What else to do with this signal is up + # to you and your handoff procedures. You may set this, for example: * In the + # entry_fulfillment of a Page if entering the page indicates something went + # extremely wrong in the conversation. * In a webhook response when you + # determine that the customer issue can only be handled by a human. class GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff include Google::Apis::Core::Hashable - # Custom metadata for your handoff procedure. Dialogflow doesn't impose - # any structure on this. + # Custom metadata for your handoff procedure. Dialogflow doesn't impose any + # structure on this. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata @@ -378,13 +346,10 @@ module Google end end - # Represents an audio message that is composed of both segments - # synthesized from the Dialogflow agent prompts and ones hosted externally - # at the specified URIs. - # The external URIs are specified via - # play_audio. - # This message is generated by Dialogflow only and not supposed to be - # defined by the user. + # Represents an audio message that is composed of both segments synthesized from + # the Dialogflow agent prompts and ones hosted externally at the specified URIs. + # The external URIs are specified via play_audio. This message is generated by + # Dialogflow only and not supposed to be defined by the user. class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio include Google::Apis::Core::Hashable @@ -407,23 +372,22 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment include Google::Apis::Core::Hashable - # Whether the playback of this segment can be interrupted by the end - # user's speech and the client should then start the next Dialogflow - # request. + # Whether the playback of this segment can be interrupted by the end user's + # speech and the client should then start the next Dialogflow request. # Corresponds to the JSON property `allowPlaybackInterruption` # @return [Boolean] attr_accessor :allow_playback_interruption alias_method :allow_playback_interruption?, :allow_playback_interruption - # Raw audio synthesized from the Dialogflow agent's response using - # the output config specified in the request. + # Raw audio synthesized from the Dialogflow agent's response using the output + # config specified in the request. # Corresponds to the JSON property `audio` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :audio - # Client-specific URI that points to an audio clip accessible to the - # client. Dialogflow does not impose any validation on it. + # Client-specific URI that points to an audio clip accessible to the client. + # Dialogflow does not impose any validation on it. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -445,8 +409,8 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText include Google::Apis::Core::Hashable - # The SSML text to be synthesized. For more information, see - # [SSML](/speech/text-to-speech/docs/ssml). + # The SSML text to be synthesized. For more information, see [SSML](/speech/text- + # to-speech/docs/ssml). # Corresponds to the JSON property `ssml` # @return [String] attr_accessor :ssml @@ -471,17 +435,15 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio include Google::Apis::Core::Hashable - # Whether the playback of this message can be interrupted by the end - # user's speech and the client can then starts the next Dialogflow - # request. + # Whether the playback of this message can be interrupted by the end user's + # speech and the client can then starts the next Dialogflow request. # Corresponds to the JSON property `allowPlaybackInterruption` # @return [Boolean] attr_accessor :allow_playback_interruption alias_method :allow_playback_interruption?, :allow_playback_interruption # Required. URI of the audio clip. Dialogflow does not impose any validation on - # this - # value. It is specific to the client that reads it. + # this value. It is specific to the client that reads it. # Corresponds to the JSON property `audioUri` # @return [String] attr_accessor :audio_uri @@ -501,9 +463,8 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessageText include Google::Apis::Core::Hashable - # Whether the playback of this message can be interrupted by the end - # user's speech and the client can then starts the next Dialogflow - # request. + # Whether the playback of this message can be interrupted by the end user's + # speech and the client can then starts the next Dialogflow request. # Corresponds to the JSON property `allowPlaybackInterruption` # @return [Boolean] attr_accessor :allow_playback_interruption @@ -529,21 +490,18 @@ module Google class GoogleCloudDialogflowCxV3beta1SessionInfo include Google::Apis::Core::Hashable - # Optional for WebhookRequest. Optional for WebhookResponse. - # All parameters collected from forms and intents during the session. - # Parameters can be created, updated, or removed by the webhook. To remove a - # parameter from the session, the webhook should explicitly set the parameter - # value to null in WebhookResponse. The map is keyed by parameters' - # display names. + # Optional for WebhookRequest. Optional for WebhookResponse. All parameters + # collected from forms and intents during the session. Parameters can be created, + # updated, or removed by the webhook. To remove a parameter from the session, + # the webhook should explicitly set the parameter value to null in + # WebhookResponse. The map is keyed by parameters' display names. # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters - # Always present for WebhookRequest. Ignored for WebhookResponse. - # The unique identifier of the session. This - # field can be used by the webhook to identify a user. - # Format: `projects//locations//agents//sessions/`. + # Always present for WebhookRequest. Ignored for WebhookResponse. The unique + # identifier of the session. This field can be used by the webhook to identify a + # user. Format: `projects//locations//agents//sessions/`. # Corresponds to the JSON property `session` # @return [String] attr_accessor :session @@ -563,8 +521,8 @@ module Google class GoogleCloudDialogflowCxV3beta1WebhookRequest include Google::Apis::Core::Hashable - # Always present. The unique identifier of the DetectIntentResponse that - # will be returned to the API caller. + # Always present. The unique identifier of the DetectIntentResponse that will be + # returned to the API caller. # Corresponds to the JSON property `detectIntentResponseId` # @return [String] attr_accessor :detect_intent_response_id @@ -579,9 +537,8 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo] attr_accessor :intent_info - # The list of rich message responses to present to the user. Webhook can - # choose to append or replace this list in - # WebhookResponse.fulfillment_response; + # The list of rich message responses to present to the user. Webhook can choose + # to append or replace this list in WebhookResponse.fulfillment_response; # Corresponds to the JSON property `messages` # @return [Array] attr_accessor :messages @@ -621,8 +578,7 @@ module Google class GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo include Google::Apis::Core::Hashable - # Always present. The tag used to identify which fulfillment is being - # called. + # Always present. The tag used to identify which fulfillment is being called. # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag @@ -641,17 +597,16 @@ module Google class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo include Google::Apis::Core::Hashable - # Always present. The unique identifier of the last matched - # intent. Format: `projects//locations//agents//intents/`. + # Always present. The unique identifier of the last matched intent. Format: ` + # projects//locations//agents//intents/`. # Corresponds to the JSON property `lastMatchedIntent` # @return [String] attr_accessor :last_matched_intent - # Parameters identified as a result of intent matching. This is a map of - # the name of the identified parameter to the value of the parameter - # identified from the user's utterance. All parameters defined in the - # matched intent that are identified will be surfaced here. + # Parameters identified as a result of intent matching. This is a map of the + # name of the identified parameter to the value of the parameter identified from + # the user's utterance. All parameters defined in the matched intent that are + # identified will be surfaced here. # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -717,16 +672,14 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowCxV3beta1SessionInfo] attr_accessor :session_info - # The target flow to transition to. - # Format: `projects//locations//agents//flows/`. + # The target flow to transition to. Format: `projects//locations//agents//flows/` + # . # Corresponds to the JSON property `targetFlow` # @return [String] attr_accessor :target_flow - # The target page to transition to. - # Format: `projects//locations//agents//flows//pages/`. + # The target page to transition to. Format: `projects//locations//agents//flows// + # pages/`. # Corresponds to the JSON property `targetPage` # @return [String] attr_accessor :target_page @@ -771,30 +724,27 @@ module Google end end - # A Dialogflow agent is a virtual agent that handles conversations with your - # end-users. It is a natural language understanding module that understands the - # nuances of human language. Dialogflow translates end-user text or audio - # during a conversation to structured data that your apps and services can - # understand. You design and build a Dialogflow agent to handle the types of - # conversations required for your system. - # For more information about agents, see the - # [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview). + # A Dialogflow agent is a virtual agent that handles conversations with your end- + # users. It is a natural language understanding module that understands the + # nuances of human language. Dialogflow translates end-user text or audio during + # a conversation to structured data that your apps and services can understand. + # You design and build a Dialogflow agent to handle the types of conversations + # required for your system. For more information about agents, see the [Agent + # guide](https://cloud.google.com/dialogflow/docs/agents-overview). class GoogleCloudDialogflowV2Agent include Google::Apis::Core::Hashable - # Optional. API version displayed in Dialogflow console. If not specified, - # V2 API is assumed. Clients are free to query different service endpoints - # for different API versions. However, bots connectors and webhook calls will - # follow the specified API version. + # Optional. API version displayed in Dialogflow console. If not specified, V2 + # API is assumed. Clients are free to query different service endpoints for + # different API versions. However, bots connectors and webhook calls will follow + # the specified API version. # Corresponds to the JSON property `apiVersion` # @return [String] attr_accessor :api_version - # Optional. The URI of the agent's avatar. - # Avatars are used throughout the Dialogflow console and in the self-hosted - # [Web - # Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) - # integration. + # Optional. The URI of the agent's avatar. Avatars are used throughout the + # Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/ + # dialogflow/docs/integrations/web-demo) integration. # Corresponds to the JSON property `avatarUri` # @return [String] attr_accessor :avatar_uri @@ -802,25 +752,24 @@ module Google # Optional. To filter out false positive results and still get variety in # matched natural language inputs for your agent, you can tune the machine # learning classification threshold. If the returned score value is less than - # the threshold value, then a fallback intent will be triggered or, if there - # are no fallback intents defined, no intent will be triggered. The score - # values range from 0.0 (completely uncertain) to 1.0 (completely certain). - # If set to 0.0, the default of 0.3 is used. + # the threshold value, then a fallback intent will be triggered or, if there are + # no fallback intents defined, no intent will be triggered. The score values + # range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0. + # 0, the default of 0.3 is used. # Corresponds to the JSON property `classificationThreshold` # @return [Float] attr_accessor :classification_threshold - # Required. The default language of the agent as a language tag. See - # [Language - # Support](https://cloud.google.com/dialogflow/docs/reference/language) - # for a list of the currently supported language codes. This field cannot be - # set by the `Update` method. + # Required. The default language of the agent as a language tag. See [Language + # Support](https://cloud.google.com/dialogflow/docs/reference/language) for a + # list of the currently supported language codes. This field cannot be set by + # the `Update` method. # Corresponds to the JSON property `defaultLanguageCode` # @return [String] attr_accessor :default_language_code - # Optional. The description of this agent. - # The maximum length is 500 characters. If exceeded, the request is rejected. + # Optional. The description of this agent. The maximum length is 500 characters. + # If exceeded, the request is rejected. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -841,14 +790,13 @@ module Google # @return [String] attr_accessor :match_mode - # Required. The project of this agent. - # Format: `projects/`. + # Required. The project of this agent. Format: `projects/`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # Optional. The list of all languages supported by this agent (except for the - # `default_language_code`). + # Optional. The list of all languages supported by this agent (except for the ` + # default_language_code`). # Corresponds to the JSON property `supportedLanguageCodes` # @return [Array] attr_accessor :supported_language_codes @@ -858,9 +806,8 @@ module Google # @return [String] attr_accessor :tier - # Required. The time zone of this agent from the - # [time zone database](https://www.iana.org/time-zones), e.g., - # America/New_York, Europe/Paris. + # Required. The time zone of this agent from the [time zone database](https:// + # www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. # Corresponds to the JSON property `timeZone` # @return [String] attr_accessor :time_zone @@ -886,30 +833,23 @@ module Google end end - # Represents a part of a message possibly annotated with an entity. The part - # can be an entity or purely a part of the message between two entities or - # message start/end. + # Represents a part of a message possibly annotated with an entity. The part can + # be an entity or purely a part of the message between two entities or message + # start/end. class GoogleCloudDialogflowV2AnnotatedMessagePart include Google::Apis::Core::Hashable - # The [Dialogflow system entity - # type](https://cloud.google.com/dialogflow/docs/reference/system-entities) - # of this message part. If this is empty, Dialogflow could not annotate the - # phrase part with a system entity. + # The [Dialogflow system entity type](https://cloud.google.com/dialogflow/docs/ + # reference/system-entities) of this message part. If this is empty, Dialogflow + # could not annotate the phrase part with a system entity. # Corresponds to the JSON property `entityType` # @return [String] attr_accessor :entity_type - # The [Dialogflow system entity formatted value - # ](https://cloud.google.com/dialogflow/docs/reference/system-entities) of - # this message part. For example for a system entity of type - # `@sys.unit-currency`, this may contain: - # 
-        # `
-        # "amount": 5,
-        # "currency": "USD"
-        # `
-        #
+ # The [Dialogflow system entity formatted value ](https://cloud.google.com/ + # dialogflow/docs/reference/system-entities) of this message part. For example + # for a system entity of type `@sys.unit-currency`, this may contain: ` "amount": + # 5, "currency": "USD" ` # Corresponds to the JSON property `formattedValue` # @return [Object] attr_accessor :formatted_value @@ -940,12 +880,10 @@ module Google # @return [Array] attr_accessor :entities - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -965,19 +903,16 @@ module Google class GoogleCloudDialogflowV2BatchDeleteEntitiesRequest include Google::Apis::Core::Hashable - # Required. The reference `values` of the entities to delete. Note that - # these are not fully-qualified names, i.e. they don't start with - # `projects/`. + # Required. The reference `values` of the entities to delete. Note that these + # are not fully-qualified names, i.e. they don't start with `projects/`. # Corresponds to the JSON property `entityValues` # @return [Array] attr_accessor :entity_values - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -997,8 +932,8 @@ module Google class GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest include Google::Apis::Core::Hashable - # Required. The names entity types to delete. All names must point to the - # same agent as `parent`. + # Required. The names entity types to delete. All names must point to the same + # agent as `parent`. # Corresponds to the JSON property `entityTypeNames` # @return [Array] attr_accessor :entity_type_names @@ -1042,12 +977,10 @@ module Google # @return [Array] attr_accessor :entities - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -1078,20 +1011,17 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityTypeBatch] attr_accessor :entity_type_batch_inline - # The URI to a Google Cloud Storage file containing entity types to update - # or create. The file format can either be a serialized proto (of - # EntityBatch type) or a JSON object. Note: The URI must start with - # "gs://". + # The URI to a Google Cloud Storage file containing entity types to update or + # create. The file format can either be a serialized proto (of EntityBatch type) + # or a JSON object. Note: The URI must start with "gs://". # Corresponds to the JSON property `entityTypeBatchUri` # @return [String] attr_accessor :entity_type_batch_uri - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -1142,9 +1072,9 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentBatch] attr_accessor :intent_batch_inline - # The URI to a Google Cloud Storage file containing intents to update or - # create. The file format can either be a serialized proto (of IntentBatch - # type) or JSON object. Note: The URI must start with "gs://". + # The URI to a Google Cloud Storage file containing intents to update or create. + # The file format can either be a serialized proto (of IntentBatch type) or JSON + # object. Note: The URI must start with "gs://". # Corresponds to the JSON property `intentBatchUri` # @return [String] attr_accessor :intent_batch_uri @@ -1154,12 +1084,10 @@ module Google # @return [String] attr_accessor :intent_view - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -1205,57 +1133,47 @@ module Google # Dialogflow contexts are similar to natural language context. If a person says # to you "they are orange", you need context in order to understand what "they" # is referring to. Similarly, for Dialogflow to handle an end-user expression - # like that, it needs to be provided with context in order to correctly match - # an intent. - # Using contexts, you can control the flow of a conversation. You can configure - # contexts for an intent by setting input and output contexts, which are - # identified by string names. When an intent is matched, any configured output - # contexts for that intent become active. While any contexts are active, + # like that, it needs to be provided with context in order to correctly match an + # intent. Using contexts, you can control the flow of a conversation. You can + # configure contexts for an intent by setting input and output contexts, which + # are identified by string names. When an intent is matched, any configured + # output contexts for that intent become active. While any contexts are active, # Dialogflow is more likely to match intents that are configured with input - # contexts that correspond to the currently active contexts. - # For more information about context, see the - # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview). + # contexts that correspond to the currently active contexts. For more + # information about context, see the [Contexts guide](https://cloud.google.com/ + # dialogflow/docs/contexts-overview). class GoogleCloudDialogflowV2Context include Google::Apis::Core::Hashable - # Optional. The number of conversational query requests after which the - # context expires. The default is `0`. If set to `0`, the context expires - # immediately. Contexts expire automatically after 20 minutes if there - # are no matching queries. + # Optional. The number of conversational query requests after which the context + # expires. The default is `0`. If set to `0`, the context expires immediately. + # Contexts expire automatically after 20 minutes if there are no matching + # queries. # Corresponds to the JSON property `lifespanCount` # @return [Fixnum] attr_accessor :lifespan_count - # Required. The unique identifier of the context. Format: - # `projects//agent/sessions//contexts/`, - # or `projects//agent/environments//users//sessions//contexts/`. - # The `Context ID` is always converted to lowercase, may only contain - # characters in a-zA-Z0-9_-% and may be at most 250 bytes long. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # The following context names are reserved for internal use by Dialogflow. - # You should not use these contexts or create contexts with these names: - # * `__system_counters__` - # * `*_id_dialog_context` - # * `*_dialog_params_size` + # Required. The unique identifier of the context. Format: `projects//agent/ + # sessions//contexts/`, or `projects//agent/environments//users//sessions// + # contexts/`. The `Context ID` is always converted to lowercase, may only + # contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. The following context + # names are reserved for internal use by Dialogflow. You should not use these + # contexts or create contexts with these names: * `__system_counters__` * `* + # _id_dialog_context` * `*_dialog_params_size` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Optional. The collection of parameters associated with this context. - # Depending on your protocol or client library language, this is a - # map, associative array, symbol table, dictionary, or JSON object - # composed of a collection of (MapKey, MapValue) pairs: - # - MapKey type: string - # - MapKey value: parameter name - # - MapValue type: - # - If parameter's entity type is a composite entity: map - # - Else: string or number, depending on parameter value type - # - MapValue value: - # - If parameter's entity type is a composite entity: - # map from composite entity property names to property values - # - Else: parameter value + # Optional. The collection of parameters associated with this context. Depending + # on your protocol or client library language, this is a map, associative array, + # symbol table, dictionary, or JSON object composed of a collection of (MapKey, + # MapValue) pairs: - MapKey type: string - MapKey value: parameter name - + # MapValue type: - If parameter's entity type is a composite entity: map - Else: + # string or number, depending on parameter value type - MapValue value: - If + # parameter's entity type is a composite entity: map from composite entity + # property names to property values - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -1277,19 +1195,18 @@ module Google class GoogleCloudDialogflowV2ConversationEvent include Google::Apis::Core::Hashable - # The unique identifier of the conversation this notification - # refers to. - # Format: `projects//conversations/`. + # The unique identifier of the conversation this notification refers to. Format: + # `projects//conversations/`. # Corresponds to the JSON property `conversation` # @return [String] attr_accessor :conversation - # 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 `errorStatus` # @return [Google::Apis::DialogflowV2::GoogleRpcStatus] attr_accessor :error_status @@ -1321,35 +1238,33 @@ module Google class GoogleCloudDialogflowV2DetectIntentRequest include Google::Apis::Core::Hashable - # The natural language speech audio to be processed. This field - # should be populated iff `query_input` is set to an input audio config. - # A single request can contain up to 1 minute of speech audio data. + # The natural language speech audio to be processed. This field should be + # populated iff `query_input` is set to an input audio config. A single request + # can contain up to 1 minute of speech audio data. # Corresponds to the JSON property `inputAudio` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :input_audio # Instructs the speech synthesizer on how to generate the output audio content. - # If this audio config is supplied in a request, it overrides all existing - # text-to-speech settings applied to the agent. + # If this audio config is supplied in a request, it overrides all existing text- + # to-speech settings applied to the agent. # Corresponds to the JSON property `outputAudioConfig` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2OutputAudioConfig] attr_accessor :output_audio_config - # Mask for output_audio_config indicating which settings in this - # request-level config should override speech synthesizer settings defined at - # agent-level. - # If unspecified or empty, output_audio_config replaces the agent-level - # config in its entirety. + # Mask for output_audio_config indicating which settings in this request-level + # config should override speech synthesizer settings defined at agent-level. If + # unspecified or empty, output_audio_config replaces the agent-level config in + # its entirety. # Corresponds to the JSON property `outputAudioConfigMask` # @return [String] attr_accessor :output_audio_config_mask - # Represents the query input. It can contain either: - # 1. An audio config which - # instructs the speech recognizer how to process the speech audio. - # 2. A conversational query in the form of text,. - # 3. An event that specifies which intent to trigger. + # Represents the query input. It can contain either: 1. An audio config which + # instructs the speech recognizer how to process the speech audio. 2. A + # conversational query in the form of text,. 3. An event that specifies which + # intent to trigger. # Corresponds to the JSON property `queryInput` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2QueryInput] attr_accessor :query_input @@ -1377,23 +1292,22 @@ module Google class GoogleCloudDialogflowV2DetectIntentResponse include Google::Apis::Core::Hashable - # The audio data bytes encoded as specified in the request. - # Note: The output audio is generated based on the values of default platform - # text responses found in the `query_result.fulfillment_messages` field. If - # multiple default text responses exist, they will be concatenated when - # generating audio. If no default platform text responses exist, the - # generated audio content will be empty. - # In some scenarios, multiple output audio fields may be present in the - # response structure. In these cases, only the top-most-level audio output - # has content. + # The audio data bytes encoded as specified in the request. Note: The output + # audio is generated based on the values of default platform text responses + # found in the `query_result.fulfillment_messages` field. If multiple default + # text responses exist, they will be concatenated when generating audio. If no + # default platform text responses exist, the generated audio content will be + # empty. In some scenarios, multiple output audio fields may be present in the + # response structure. In these cases, only the top-most-level audio output has + # content. # Corresponds to the JSON property `outputAudio` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :output_audio # Instructs the speech synthesizer on how to generate the output audio content. - # If this audio config is supplied in a request, it overrides all existing - # text-to-speech settings applied to the agent. + # If this audio config is supplied in a request, it overrides all existing text- + # to-speech settings applied to the agent. # Corresponds to the JSON property `outputAudioConfig` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2OutputAudioConfig] attr_accessor :output_audio_config @@ -1403,18 +1317,18 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2QueryResult] attr_accessor :query_result - # The unique identifier of the response. It can be used to - # locate a response in the training example set or for reporting issues. + # The unique identifier of the response. It can be used to locate a response in + # the training example set or for reporting issues. # Corresponds to the JSON property `responseId` # @return [String] attr_accessor :response_id - # 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 `webhookStatus` # @return [Google::Apis::DialogflowV2::GoogleRpcStatus] attr_accessor :webhook_status @@ -1434,20 +1348,18 @@ module Google end # Each intent parameter has a type, called the entity type, which dictates - # exactly how data from an end-user expression is extracted. - # Dialogflow provides predefined system entities that can match many common - # types of data. For example, there are system entities for matching dates, - # times, colors, email addresses, and so on. You can also create your own - # custom entities for matching custom data. For example, you could define a - # vegetable entity that can match the types of vegetables available for - # purchase with a grocery store agent. - # For more information, see the - # [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview). + # exactly how data from an end-user expression is extracted. Dialogflow provides + # predefined system entities that can match many common types of data. For + # example, there are system entities for matching dates, times, colors, email + # addresses, and so on. You can also create your own custom entities for + # matching custom data. For example, you could define a vegetable entity that + # can match the types of vegetables available for purchase with a grocery store + # agent. For more information, see the [Entity guide](https://cloud.google.com/ + # dialogflow/docs/entities-overview). class GoogleCloudDialogflowV2EntityType include Google::Apis::Core::Hashable - # Optional. Indicates whether the entity type can be automatically - # expanded. + # Optional. Indicates whether the entity type can be automatically expanded. # Corresponds to the JSON property `autoExpansionMode` # @return [String] attr_accessor :auto_expansion_mode @@ -1473,10 +1385,9 @@ module Google # @return [String] attr_accessor :kind - # The unique identifier of the entity type. - # Required for EntityTypes.UpdateEntityType and - # EntityTypes.BatchUpdateEntityTypes methods. - # Format: `projects//agent/entityTypes/`. + # The unique identifier of the entity type. Required for EntityTypes. + # UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: ` + # projects//agent/entityTypes/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1519,23 +1430,19 @@ module Google class GoogleCloudDialogflowV2EntityTypeEntity include Google::Apis::Core::Hashable - # Required. A collection of value synonyms. For example, if the entity type - # is *vegetable*, and `value` is *scallions*, a synonym could be *green - # onions*. - # For `KIND_LIST` entity types: - # * This collection must contain exactly one synonym equal to `value`. + # Required. A collection of value synonyms. For example, if the entity type is * + # vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For + # `KIND_LIST` entity types: * This collection must contain exactly one synonym + # equal to `value`. # Corresponds to the JSON property `synonyms` # @return [Array] attr_accessor :synonyms - # Required. The primary value associated with this entity entry. - # For example, if the entity type is *vegetable*, the value could be - # *scallions*. - # For `KIND_MAP` entity types: - # * A reference value to be used in place of synonyms. - # For `KIND_LIST` entity types: - # * A string that can contain references to other entity types (with or - # without aliases). + # Required. The primary value associated with this entity entry. For example, if + # the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` + # entity types: * A reference value to be used in place of synonyms. For ` + # KIND_LIST` entity types: * A string that can contain references to other + # entity types (with or without aliases). # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -1552,51 +1459,44 @@ module Google end # You can create multiple versions of your agent and publish them to separate - # environments. - # When you edit an agent, you are editing the draft agent. At any point, you - # can save the draft agent as an agent version, which is an immutable snapshot - # of your agent. - # When you save the draft agent, it is published to the default environment. - # When you create agent versions, you can publish them to custom environments. - # You can create a variety of custom environments for: - # - testing - # - development - # - production - # - etc. - # For more information, see the [versions and environments - # guide](https://cloud.google.com/dialogflow/docs/agents-versions). + # environments. When you edit an agent, you are editing the draft agent. At any + # point, you can save the draft agent as an agent version, which is an immutable + # snapshot of your agent. When you save the draft agent, it is published to the + # default environment. When you create agent versions, you can publish them to + # custom environments. You can create a variety of custom environments for: - + # testing - development - production - etc. For more information, see the [ + # versions and environments guide](https://cloud.google.com/dialogflow/docs/ + # agents-versions). class GoogleCloudDialogflowV2Environment include Google::Apis::Core::Hashable - # Optional. The agent version loaded into this environment. - # Format: `projects//agent/versions/`. + # Optional. The agent version loaded into this environment. Format: `projects// + # agent/versions/`. # Corresponds to the JSON property `agentVersion` # @return [String] attr_accessor :agent_version - # Optional. The developer-provided description for this environment. - # The maximum length is 500 characters. If exceeded, the request is rejected. + # Optional. The developer-provided description for this environment. The maximum + # length is 500 characters. If exceeded, the request is rejected. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Output only. The unique identifier of this agent environment. - # Format: `projects//agent/environments/`. - # For Environment ID, "-" is reserved for 'draft' environment. + # Output only. The unique identifier of this agent environment. Format: ` + # projects//agent/environments/`. For Environment ID, "-" is reserved for 'draft' + # environment. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. The state of this environment. This field is read-only, i.e., it - # cannot be - # set by create and update methods. + # cannot be set by create and update methods. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Output only. The last update time of this environment. This field is read-only, - # i.e., it - # cannot be set by create and update methods. + # i.e., it cannot be set by create and update methods. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -1616,17 +1516,16 @@ module Google end # Events allow for matching intents by event name instead of the natural - # language input. For instance, input `` can trigger a personalized welcome response. - # The parameter `name` may be used by the agent in the response: - # `"Hello #welcome_event.name! What can I do for you today?"`. + # language input. For instance, input `` can trigger a personalized welcome + # response. The parameter `name` may be used by the agent in the response: `" + # Hello #welcome_event.name! What can I do for you today?"`. class GoogleCloudDialogflowV2EventInput include Google::Apis::Core::Hashable - # Required. The language of this query. See [Language - # Support](https://cloud.google.com/dialogflow/docs/reference/language) - # for a list of the currently supported language codes. Note that queries in - # the same session do not necessarily need to specify the same language. + # Required. The language of this query. See [Language Support](https://cloud. + # google.com/dialogflow/docs/reference/language) for a list of the currently + # supported language codes. Note that queries in the same session do not + # necessarily need to specify the same language. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -1636,19 +1535,14 @@ module Google # @return [String] attr_accessor :name - # The collection of parameters associated with the event. - # Depending on your protocol or client library language, this is a - # map, associative array, symbol table, dictionary, or JSON object - # composed of a collection of (MapKey, MapValue) pairs: - # - MapKey type: string - # - MapKey value: parameter name - # - MapValue type: - # - If parameter's entity type is a composite entity: map - # - Else: string or number, depending on parameter value type - # - MapValue value: - # - If parameter's entity type is a composite entity: - # map from composite entity property names to property values - # - Else: parameter value + # The collection of parameters associated with the event. Depending on your + # protocol or client library language, this is a map, associative array, symbol + # table, dictionary, or JSON object composed of a collection of (MapKey, + # MapValue) pairs: - MapKey type: string - MapKey value: parameter name - + # MapValue type: - If parameter's entity type is a composite entity: map - Else: + # string or number, depending on parameter value type - MapValue value: - If + # parameter's entity type is a composite entity: map from composite entity + # property names to property values - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -1670,9 +1564,8 @@ module Google include Google::Apis::Core::Hashable # Required. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) - # URI to export the agent to. - # The format of this URI must be `gs:///`. - # If left unspecified, the serialized agent is returned inline. + # URI to export the agent to. The format of this URI must be `gs:///`. If left + # unspecified, the serialized agent is returned inline. # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri @@ -1697,8 +1590,8 @@ module Google # @return [String] attr_accessor :agent_content - # The URI to a file containing the exported agent. This field is populated - # only if `agent_uri` is specified in `ExportAgentRequest`. + # The URI to a file containing the exported agent. This field is populated only + # if `agent_uri` is specified in `ExportAgentRequest`. # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri @@ -1714,15 +1607,14 @@ module Google end end - # By default, your agent responds to a matched intent with a static response. - # As an alternative, you can provide a more dynamic response by using - # fulfillment. When you enable fulfillment for an intent, Dialogflow responds - # to that intent by calling a service that you define. For example, if an - # end-user wants to schedule a haircut on Friday, your service can check your - # database and respond to the end-user with availability information for - # Friday. - # For more information, see the [fulfillment - # guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). + # By default, your agent responds to a matched intent with a static response. As + # an alternative, you can provide a more dynamic response by using fulfillment. + # When you enable fulfillment for an intent, Dialogflow responds to that intent + # by calling a service that you define. For example, if an end-user wants to + # schedule a haircut on Friday, your service can check your database and respond + # to the end-user with availability information for Friday. For more information, + # see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/ + # fulfillment-overview). class GoogleCloudDialogflowV2Fulfillment include Google::Apis::Core::Hashable @@ -1743,18 +1635,17 @@ module Google # @return [Array] attr_accessor :features - # Represents configuration for a generic web service. - # Dialogflow supports two mechanisms for authentications: - # - Basic authentication with username and password. - # - Authentication with additional authentication headers. - # More information could be found at: - # https://cloud.google.com/dialogflow/docs/fulfillment-configure. + # Represents configuration for a generic web service. Dialogflow supports two + # mechanisms for authentications: - Basic authentication with username and + # password. - Authentication with additional authentication headers. More + # information could be found at: https://cloud.google.com/dialogflow/docs/ + # fulfillment-configure. # Corresponds to the JSON property `genericWebService` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2FulfillmentGenericWebService] attr_accessor :generic_web_service - # Required. The unique identifier of the fulfillment. - # Format: `projects//agent/fulfillment`. + # Required. The unique identifier of the fulfillment. Format: `projects//agent/ + # fulfillment`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1792,12 +1683,11 @@ module Google end end - # Represents configuration for a generic web service. - # Dialogflow supports two mechanisms for authentications: - # - Basic authentication with username and password. - # - Authentication with additional authentication headers. - # More information could be found at: - # https://cloud.google.com/dialogflow/docs/fulfillment-configure. + # Represents configuration for a generic web service. Dialogflow supports two + # mechanisms for authentications: - Basic authentication with username and + # password. - Authentication with additional authentication headers. More + # information could be found at: https://cloud.google.com/dialogflow/docs/ + # fulfillment-configure. class GoogleCloudDialogflowV2FulfillmentGenericWebService include Google::Apis::Core::Hashable @@ -1818,8 +1708,8 @@ module Google # @return [Hash] attr_accessor :request_headers - # Required. The fulfillment URI for receiving POST requests. - # It must use https protocol. + # Required. The fulfillment URI for receiving POST requests. It must use https + # protocol. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -1853,8 +1743,8 @@ module Google # @return [String] attr_accessor :agent_content - # The URI to a Google Cloud Storage file containing the agent to import. - # Note: The URI must start with "gs://". + # The URI to a Google Cloud Storage file containing the agent to import. Note: + # The URI must start with "gs://". # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri @@ -1879,36 +1769,32 @@ module Google # @return [String] attr_accessor :audio_encoding - # If `true`, Dialogflow returns SpeechWordInfo in - # StreamingRecognitionResult with information about the recognized speech - # words, e.g. start and end time offsets. If false or unspecified, Speech - # doesn't return any word-level information. + # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult + # with information about the recognized speech words, e.g. start and end time + # offsets. If false or unspecified, Speech doesn't return any word-level + # information. # Corresponds to the JSON property `enableWordInfo` # @return [Boolean] attr_accessor :enable_word_info alias_method :enable_word_info?, :enable_word_info # Required. The language of the supplied audio. Dialogflow does not do - # translations. See [Language - # Support](https://cloud.google.com/dialogflow/docs/reference/language) - # for a list of the currently supported language codes. Note that queries in - # the same session do not necessarily need to specify the same language. + # translations. See [Language Support](https://cloud.google.com/dialogflow/docs/ + # reference/language) for a list of the currently supported language codes. Note + # that queries in the same session do not necessarily need to specify the same + # language. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # Which Speech model to select for the given request. Select the - # model best suited to your domain to get best results. If a model is not - # explicitly specified, then we auto-select a model based on the parameters - # in the InputAudioConfig. - # If enhanced speech model is enabled for the agent and an enhanced - # version of the specified model for the language does not exist, then the - # speech is recognized using the standard version of the specified model. - # Refer to - # [Cloud Speech API - # documentation](https://cloud.google.com/speech-to-text/docs/basics#select- - # model) - # for more details. + # Which Speech model to select for the given request. Select the model best + # suited to your domain to get best results. If a model is not explicitly + # specified, then we auto-select a model based on the parameters in the + # InputAudioConfig. If enhanced speech model is enabled for the agent and an + # enhanced version of the specified model for the language does not exist, then + # the speech is recognized using the standard version of the specified model. + # Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to- + # text/docs/basics#select-model) for more details. # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -1918,48 +1804,39 @@ module Google # @return [String] attr_accessor :model_variant - # A list of strings containing words and phrases that the speech - # recognizer should recognize with higher likelihood. - # See [the Cloud Speech - # documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase- - # hints) - # for more details. - # This field is deprecated. Please use [speech_contexts]() instead. If you - # specify both [phrase_hints]() and [speech_contexts](), Dialogflow will + # A list of strings containing words and phrases that the speech recognizer + # should recognize with higher likelihood. See [the Cloud Speech documentation]( + # https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more + # details. This field is deprecated. Please use [speech_contexts]() instead. If + # you specify both [phrase_hints]() and [speech_contexts](), Dialogflow will # treat the [phrase_hints]() as a single additional [SpeechContext](). # Corresponds to the JSON property `phraseHints` # @return [Array] attr_accessor :phrase_hints - # Required. Sample rate (in Hertz) of the audio content sent in the query. - # Refer to - # [Cloud Speech API - # documentation](https://cloud.google.com/speech-to-text/docs/basics) for - # more details. + # Required. Sample rate (in Hertz) of the audio content sent in the query. Refer + # to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/ + # docs/basics) for more details. # Corresponds to the JSON property `sampleRateHertz` # @return [Fixnum] attr_accessor :sample_rate_hertz - # If `false` (default), recognition does not cease until the - # client closes the stream. - # If `true`, the recognizer will detect a single spoken utterance in input - # audio. Recognition ceases when it detects the audio's voice has - # stopped or paused. In this case, once a detected intent is received, the - # client should close the stream and start a new request with a new stream as - # needed. - # Note: This setting is relevant only for streaming methods. - # Note: When specified, InputAudioConfig.single_utterance takes precedence - # over StreamingDetectIntentRequest.single_utterance. + # If `false` (default), recognition does not cease until the client closes the + # stream. If `true`, the recognizer will detect a single spoken utterance in + # input audio. Recognition ceases when it detects the audio's voice has stopped + # or paused. In this case, once a detected intent is received, the client should + # close the stream and start a new request with a new stream as needed. Note: + # This setting is relevant only for streaming methods. Note: When specified, + # InputAudioConfig.single_utterance takes precedence over + # StreamingDetectIntentRequest.single_utterance. # Corresponds to the JSON property `singleUtterance` # @return [Boolean] attr_accessor :single_utterance alias_method :single_utterance?, :single_utterance - # Context information to assist speech recognition. - # See [the Cloud Speech + # Context information to assist speech recognition. See [the Cloud Speech # documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase- - # hints) - # for more details. + # hints) for more details. # Corresponds to the JSON property `speechContexts` # @return [Array] attr_accessor :speech_contexts @@ -1987,20 +1864,19 @@ module Google # complete conversation. When an end-user writes or says something, referred to # as an end-user expression or end-user input, Dialogflow matches the end-user # input to the best intent in your agent. Matching an intent is also known as - # intent classification. - # For more information, see the [intent - # guide](https://cloud.google.com/dialogflow/docs/intents-overview). + # intent classification. For more information, see the [intent guide](https:// + # cloud.google.com/dialogflow/docs/intents-overview). class GoogleCloudDialogflowV2Intent include Google::Apis::Core::Hashable - # Optional. The name of the action associated with the intent. - # Note: The action name must not contain whitespaces. + # Optional. The name of the action associated with the intent. Note: The action + # name must not contain whitespaces. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action - # Optional. The list of platforms for which the first responses will be - # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). + # Optional. The list of platforms for which the first responses will be copied + # from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). # Corresponds to the JSON property `defaultResponsePlatforms` # @return [Array] attr_accessor :default_response_platforms @@ -2010,23 +1886,22 @@ module Google # @return [String] attr_accessor :display_name - # Optional. The collection of event names that trigger the intent. - # If the collection of input contexts is not empty, all of the contexts must - # be present in the active user session for an event to trigger this intent. - # Event names are limited to 150 characters. + # Optional. The collection of event names that trigger the intent. If the + # collection of input contexts is not empty, all of the contexts must be present + # in the active user session for an event to trigger this intent. Event names + # are limited to 150 characters. # Corresponds to the JSON property `events` # @return [Array] attr_accessor :events - # Read-only. Information about all followup intents that have this intent as - # a direct or indirect parent. We populate this field only in the output. + # Read-only. Information about all followup intents that have this intent as a + # direct or indirect parent. We populate this field only in the output. # Corresponds to the JSON property `followupIntentInfo` # @return [Array] attr_accessor :followup_intent_info - # Optional. The list of context names required for this intent to be - # triggered. - # Format: `projects//agent/sessions/-/contexts/`. + # Optional. The list of context names required for this intent to be triggered. + # Format: `projects//agent/sessions/-/contexts/`. # Corresponds to the JSON property `inputContextNames` # @return [Array] attr_accessor :input_context_names @@ -2037,34 +1912,32 @@ module Google attr_accessor :is_fallback alias_method :is_fallback?, :is_fallback - # Optional. The collection of rich messages corresponding to the - # `Response` field in the Dialogflow console. + # Optional. The collection of rich messages corresponding to the `Response` + # field in the Dialogflow console. # Corresponds to the JSON property `messages` # @return [Array] attr_accessor :messages - # Optional. Indicates whether Machine Learning is disabled for the intent. - # Note: If `ml_disabled` setting is set to true, then this intent is not - # taken into account during inference in `ML ONLY` match mode. Also, - # auto-markup in the UI is turned off. + # Optional. Indicates whether Machine Learning is disabled for the intent. Note: + # If `ml_disabled` setting is set to true, then this intent is not taken into + # account during inference in `ML ONLY` match mode. Also, auto-markup in the UI + # is turned off. # Corresponds to the JSON property `mlDisabled` # @return [Boolean] attr_accessor :ml_disabled alias_method :ml_disabled?, :ml_disabled - # Optional. The unique identifier of this intent. - # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents - # methods. - # Format: `projects//agent/intents/`. + # Optional. The unique identifier of this intent. Required for Intents. + # UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/ + # intents/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Optional. The collection of contexts that are activated when the intent - # is matched. Context messages in this collection should not set the - # parameters field. Setting the `lifespan_count` to 0 will reset the context - # when the intent is matched. - # Format: `projects//agent/sessions/-/contexts/`. + # Optional. The collection of contexts that are activated when the intent is + # matched. Context messages in this collection should not set the parameters + # field. Setting the `lifespan_count` to 0 will reset the context when the + # intent is matched. Format: `projects//agent/sessions/-/contexts/`. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts @@ -2075,44 +1948,38 @@ module Google attr_accessor :parameters # Read-only after creation. The unique identifier of the parent intent in the - # chain of followup intents. You can set this field when creating an intent, - # for example with CreateIntent or - # BatchUpdateIntents, in order to make this - # intent a followup intent. - # It identifies the parent followup intent. - # Format: `projects//agent/intents/`. + # chain of followup intents. You can set this field when creating an intent, for + # example with CreateIntent or BatchUpdateIntents, in order to make this intent + # a followup intent. It identifies the parent followup intent. Format: `projects/ + # /agent/intents/`. # Corresponds to the JSON property `parentFollowupIntentName` # @return [String] attr_accessor :parent_followup_intent_name # Optional. The priority of this intent. Higher numbers represent higher - # priorities. - # - If the supplied value is unspecified or 0, the service - # translates the value to 500,000, which corresponds to the - # `Normal` priority in the console. - # - If the supplied value is negative, the intent is ignored - # in runtime detect intent requests. + # priorities. - If the supplied value is unspecified or 0, the service + # translates the value to 500,000, which corresponds to the `Normal` priority in + # the console. - If the supplied value is negative, the intent is ignored in + # runtime detect intent requests. # Corresponds to the JSON property `priority` # @return [Fixnum] attr_accessor :priority - # Optional. Indicates whether to delete all contexts in the current - # session when this intent is matched. + # Optional. Indicates whether to delete all contexts in the current session when + # this intent is matched. # Corresponds to the JSON property `resetContexts` # @return [Boolean] attr_accessor :reset_contexts alias_method :reset_contexts?, :reset_contexts - # Read-only. The unique identifier of the root intent in the chain of - # followup intents. It identifies the correct followup intents chain for - # this intent. We populate this field only in the output. - # Format: `projects//agent/intents/`. + # Read-only. The unique identifier of the root intent in the chain of followup + # intents. It identifies the correct followup intents chain for this intent. We + # populate this field only in the output. Format: `projects//agent/intents/`. # Corresponds to the JSON property `rootFollowupIntentName` # @return [String] attr_accessor :root_followup_intent_name - # Optional. The collection of examples that the agent is - # trained on. + # Optional. The collection of examples that the agent is trained on. # Corresponds to the JSON property `trainingPhrases` # @return [Array] attr_accessor :training_phrases @@ -2172,14 +2039,14 @@ module Google class GoogleCloudDialogflowV2IntentFollowupIntentInfo include Google::Apis::Core::Hashable - # The unique identifier of the followup intent. - # Format: `projects//agent/intents/`. + # The unique identifier of the followup intent. Format: `projects//agent/intents/ + # `. # Corresponds to the JSON property `followupIntentName` # @return [String] attr_accessor :followup_intent_name - # The unique identifier of the followup intent's parent. - # Format: `projects//agent/intents/`. + # The unique identifier of the followup intent's parent. Format: `projects// + # agent/intents/`. # Corresponds to the JSON property `parentFollowupIntentName` # @return [String] attr_accessor :parent_followup_intent_name @@ -2195,11 +2062,9 @@ module Google end end - # A rich response message. - # Corresponds to the intent `Response` field in the Dialogflow console. - # For more information, see - # [Rich response - # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages). + # A rich response message. Corresponds to the intent `Response` field in the + # Dialogflow console. For more information, see [Rich response messages](https:// + # cloud.google.com/dialogflow/docs/intents-rich-messages). class GoogleCloudDialogflowV2IntentMessage include Google::Apis::Core::Hashable @@ -2208,8 +2073,8 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageBasicCard] attr_accessor :basic_card - # Browse Carousel Card for Actions on Google. - # https://developers.google.com/actions/assistant/responses#browsing_carousel + # Browse Carousel Card for Actions on Google. https://developers.google.com/ + # actions/assistant/responses#browsing_carousel # Corresponds to the JSON property `browseCarouselCard` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard] attr_accessor :browse_carousel_card @@ -2229,8 +2094,8 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageImage] attr_accessor :image - # The suggestion chip message that allows the user to jump out to the app - # or website associated with this agent. + # The suggestion chip message that allows the user to jump out to the app or + # website associated with this agent. # Corresponds to the JSON property `linkOutSuggestion` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion] attr_accessor :link_out_suggestion @@ -2260,10 +2125,9 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageQuickReplies] attr_accessor :quick_replies - # The collection of simple response candidates. - # This message in `QueryResult.fulfillment_messages` and - # `WebhookResponse.fulfillment_messages` should contain only one - # `SimpleResponse`. + # The collection of simple response candidates. This message in `QueryResult. + # fulfillment_messages` and `WebhookResponse.fulfillment_messages` should + # contain only one `SimpleResponse`. # Corresponds to the JSON property `simpleResponses` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageSimpleResponses] attr_accessor :simple_responses @@ -2394,19 +2258,18 @@ module Google end end - # Browse Carousel Card for Actions on Google. - # https://developers.google.com/actions/assistant/responses#browsing_carousel + # Browse Carousel Card for Actions on Google. https://developers.google.com/ + # actions/assistant/responses#browsing_carousel class GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard include Google::Apis::Core::Hashable - # Optional. Settings for displaying the image. Applies to every image in - # items. + # Optional. Settings for displaying the image. Applies to every image in items. # Corresponds to the JSON property `imageDisplayOptions` # @return [String] attr_accessor :image_display_options - # Required. List of items in the Browse Carousel Card. Minimum of two - # items, maximum of ten. + # Required. List of items in the Browse Carousel Card. Minimum of two items, + # maximum of ten. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items @@ -2426,14 +2289,13 @@ module Google class GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem include Google::Apis::Core::Hashable - # Optional. Description of the carousel item. Maximum of four lines of - # text. + # Optional. Description of the carousel item. Maximum of four lines of text. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional. Text that appears at the bottom of the Browse Carousel - # Card. Maximum of one line of text. + # Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum + # of one line of text. # Corresponds to the JSON property `footer` # @return [String] attr_accessor :footer @@ -2476,8 +2338,8 @@ module Google # @return [String] attr_accessor :url - # Optional. Specifies the type of viewer that is used when opening - # the URL. Defaults to opening via web browser. + # Optional. Specifies the type of viewer that is used when opening the URL. + # Defaults to opening via web browser. # Corresponds to the JSON property `urlTypeHint` # @return [String] attr_accessor :url_type_hint @@ -2534,8 +2396,7 @@ module Google class GoogleCloudDialogflowV2IntentMessageCardButton include Google::Apis::Core::Hashable - # Optional. The text to send back to the Dialogflow API or a URI to - # open. + # Optional. The text to send back to the Dialogflow API or a URI to open. # Corresponds to the JSON property `postback` # @return [String] attr_accessor :postback @@ -2589,8 +2450,7 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageImage] attr_accessor :image - # Additional info about the select item for when it is triggered in a - # dialog. + # Additional info about the select item for when it is triggered in a dialog. # Corresponds to the JSON property `info` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageSelectItemInfo] attr_accessor :info @@ -2642,8 +2502,8 @@ module Google class GoogleCloudDialogflowV2IntentMessageImage include Google::Apis::Core::Hashable - # Optional. A text description of the image to be used for accessibility, - # e.g., screen readers. + # Optional. A text description of the image to be used for accessibility, e.g., + # screen readers. # Corresponds to the JSON property `accessibilityText` # @return [String] attr_accessor :accessibility_text @@ -2664,8 +2524,8 @@ module Google end end - # The suggestion chip message that allows the user to jump out to the app - # or website associated with this agent. + # The suggestion chip message that allows the user to jump out to the app or + # website associated with this agent. class GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion include Google::Apis::Core::Hashable @@ -2674,8 +2534,8 @@ module Google # @return [String] attr_accessor :destination_name - # Required. The URI of the app or site to open when the user taps the - # suggestion chip. + # Required. The URI of the app or site to open when the user taps the suggestion + # chip. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -2736,8 +2596,7 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageImage] attr_accessor :image - # Additional info about the select item for when it is triggered in a - # dialog. + # Additional info about the select item for when it is triggered in a dialog. # Corresponds to the JSON property `info` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2IntentMessageSelectItemInfo] attr_accessor :info @@ -2853,19 +2712,18 @@ module Google end end - # Additional info about the select item for when it is triggered in a - # dialog. + # Additional info about the select item for when it is triggered in a dialog. class GoogleCloudDialogflowV2IntentMessageSelectItemInfo include Google::Apis::Core::Hashable - # Required. A unique key that will be sent back to the agent if this - # response is given. + # Required. A unique key that will be sent back to the agent if this response is + # given. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key - # Optional. A list of synonyms that can also be used to trigger this - # item in dialog. + # Optional. A list of synonyms that can also be used to trigger this item in + # dialog. # Corresponds to the JSON property `synonyms` # @return [Array] attr_accessor :synonyms @@ -2890,15 +2748,14 @@ module Google # @return [String] attr_accessor :display_text - # One of text_to_speech or ssml must be provided. Structured spoken - # response to the user in the SSML format. Mutually exclusive with - # text_to_speech. + # One of text_to_speech or ssml must be provided. Structured spoken response to + # the user in the SSML format. Mutually exclusive with text_to_speech. # Corresponds to the JSON property `ssml` # @return [String] attr_accessor :ssml - # One of text_to_speech or ssml must be provided. The plain text of the - # speech output. Mutually exclusive with ssml. + # One of text_to_speech or ssml must be provided. The plain text of the speech + # output. Mutually exclusive with ssml. # Corresponds to the JSON property `textToSpeech` # @return [String] attr_accessor :text_to_speech @@ -2915,10 +2772,9 @@ module Google end end - # The collection of simple response candidates. - # This message in `QueryResult.fulfillment_messages` and - # `WebhookResponse.fulfillment_messages` should contain only one - # `SimpleResponse`. + # The collection of simple response candidates. This message in `QueryResult. + # fulfillment_messages` and `WebhookResponse.fulfillment_messages` should + # contain only one `SimpleResponse`. class GoogleCloudDialogflowV2IntentMessageSimpleResponses include Google::Apis::Core::Hashable @@ -2937,8 +2793,8 @@ module Google end end - # The suggestion chip message that the user can tap to quickly post a reply - # to the conversation. + # The suggestion chip message that the user can tap to quickly post a reply to + # the conversation. class GoogleCloudDialogflowV2IntentMessageSuggestion include Google::Apis::Core::Hashable @@ -3093,10 +2949,9 @@ module Google class GoogleCloudDialogflowV2IntentParameter include Google::Apis::Core::Hashable - # Optional. The default value to use when the `value` yields an empty - # result. - # Default values can be extracted from contexts by using the following - # syntax: `#context_name.parameter_name`. + # Optional. The default value to use when the `value` yields an empty result. + # Default values can be extracted from contexts by using the following syntax: `# + # context_name.parameter_name`. # Corresponds to the JSON property `defaultValue` # @return [String] attr_accessor :default_value @@ -3106,9 +2961,8 @@ module Google # @return [String] attr_accessor :display_name - # Optional. The name of the entity type, prefixed with `@`, that - # describes values of the parameter. If the parameter is - # required, this must be provided. + # Optional. The name of the entity type, prefixed with `@`, that describes + # values of the parameter. If the parameter is required, this must be provided. # Corresponds to the JSON property `entityTypeDisplayName` # @return [String] attr_accessor :entity_type_display_name @@ -3119,9 +2973,8 @@ module Google attr_accessor :is_list alias_method :is_list?, :is_list - # Optional. Indicates whether the parameter is required. That is, - # whether the intent cannot be completed without collecting the parameter - # value. + # Optional. Indicates whether the parameter is required. That is, whether the + # intent cannot be completed without collecting the parameter value. # Corresponds to the JSON property `mandatory` # @return [Boolean] attr_accessor :mandatory @@ -3132,18 +2985,16 @@ module Google # @return [String] attr_accessor :name - # Optional. The collection of prompts that the agent can present to the - # user in order to collect a value for the parameter. + # Optional. The collection of prompts that the agent can present to the user in + # order to collect a value for the parameter. # Corresponds to the JSON property `prompts` # @return [Array] attr_accessor :prompts - # Optional. The definition of the parameter value. It can be: - # - a constant string, - # - a parameter value defined as `$parameter_name`, - # - an original parameter value defined as `$parameter_name.original`, - # - a parameter value from some context defined as - # `#context_name.parameter_name`. + # Optional. The definition of the parameter value. It can be: - a constant + # string, - a parameter value defined as `$parameter_name`, - an original + # parameter value defined as `$parameter_name.original`, - a parameter value + # from some context defined as `#context_name.parameter_name`. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -3174,27 +3025,25 @@ module Google # @return [String] attr_accessor :name - # Required. The ordered list of training phrase parts. - # The parts are concatenated in order to form the training phrase. - # Note: The API does not automatically annotate training phrases like the - # Dialogflow Console does. - # Note: Do not forget to include whitespace at part boundaries, - # so the training phrase is well formatted when the parts are concatenated. - # If the training phrase does not need to be annotated with parameters, - # you just need a single part with only the Part.text field set. - # If you want to annotate the training phrase, you must create multiple - # parts, where the fields of each part are populated in one of two ways: - # - `Part.text` is set to a part of the phrase that has no parameters. - # - `Part.text` is set to a part of the phrase that you want to annotate, - # and the `entity_type`, `alias`, and `user_defined` fields are all - # set. + # Required. The ordered list of training phrase parts. The parts are + # concatenated in order to form the training phrase. Note: The API does not + # automatically annotate training phrases like the Dialogflow Console does. Note: + # Do not forget to include whitespace at part boundaries, so the training + # phrase is well formatted when the parts are concatenated. If the training + # phrase does not need to be annotated with parameters, you just need a single + # part with only the Part.text field set. If you want to annotate the training + # phrase, you must create multiple parts, where the fields of each part are + # populated in one of two ways: - `Part.text` is set to a part of the phrase + # that has no parameters. - `Part.text` is set to a part of the phrase that you + # want to annotate, and the `entity_type`, `alias`, and `user_defined` fields + # are all set. # Corresponds to the JSON property `parts` # @return [Array] attr_accessor :parts - # Optional. Indicates how many times this example was added to - # the intent. Each time a developer adds an existing sample by editing an - # intent or training, this counter is increased. + # Optional. Indicates how many times this example was added to the intent. Each + # time a developer adds an existing sample by editing an intent or training, + # this counter is increased. # Corresponds to the JSON property `timesAddedCount` # @return [Fixnum] attr_accessor :times_added_count @@ -3221,15 +3070,15 @@ module Google class GoogleCloudDialogflowV2IntentTrainingPhrasePart include Google::Apis::Core::Hashable - # Optional. The parameter name for the value extracted from the - # annotated part of the example. - # This field is required for annotated parts of the training phrase. + # Optional. The parameter name for the value extracted from the annotated part + # of the example. This field is required for annotated parts of the training + # phrase. # Corresponds to the JSON property `alias` # @return [String] attr_accessor :alias - # Optional. The entity type name prefixed with `@`. - # This field is required for annotated parts of the training phrase. + # Optional. The entity type name prefixed with `@`. This field is required for + # annotated parts of the training phrase. # Corresponds to the JSON property `entityType` # @return [String] attr_accessor :entity_type @@ -3239,10 +3088,9 @@ module Google # @return [String] attr_accessor :text - # Optional. Indicates whether the text was manually annotated. - # This field is set to true when the Dialogflow Console is used to - # manually annotate the part. When creating an annotated part with the - # API, you must set this to true. + # Optional. Indicates whether the text was manually annotated. This field is set + # to true when the Dialogflow Console is used to manually annotate the part. + # When creating an annotated part with the API, you must set this to true. # Corresponds to the JSON property `userDefined` # @return [Boolean] attr_accessor :user_defined @@ -3265,14 +3113,14 @@ module Google class GoogleCloudDialogflowV2ListContextsResponse include Google::Apis::Core::Hashable - # The list of contexts. There will be a maximum number of items - # returned based on the page_size field in the request. + # The list of contexts. There will be a maximum number of items returned based + # on the page_size field in the request. # Corresponds to the JSON property `contexts` # @return [Array] attr_accessor :contexts - # 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 @@ -3298,8 +3146,8 @@ module Google # @return [Array] attr_accessor :entity_types - # 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 @@ -3325,8 +3173,8 @@ module Google # @return [Array] attr_accessor :environments - # 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 @@ -3346,14 +3194,14 @@ module Google class GoogleCloudDialogflowV2ListIntentsResponse include Google::Apis::Core::Hashable - # The list of agent intents. There will be a maximum number of items - # returned based on the page_size field in the request. + # The list of agent intents. There will be a maximum number of items returned + # based on the page_size field in the request. # Corresponds to the JSON property `intents` # @return [Array] attr_accessor :intents - # 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 @@ -3373,8 +3221,8 @@ module Google class GoogleCloudDialogflowV2ListSessionEntityTypesResponse 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 @@ -3410,9 +3258,8 @@ module Google # @return [String] attr_accessor :create_time - # Optional. The message language. - # This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag. Example: "en-US". + # Optional. The message language. This should be a [BCP-47](https://www.rfc- + # editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -3422,9 +3269,8 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2MessageAnnotation] attr_accessor :message_annotation - # The unique identifier of the message. - # Format: `projects//conversations//messages/`. + # The unique identifier of the message. Format: `projects//conversations// + # messages/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3465,9 +3311,9 @@ module Google attr_accessor :contain_entities alias_method :contain_entities?, :contain_entities - # The collection of annotated message parts ordered by their - # position in the message. You can recover the annotated message by - # concatenating [AnnotatedMessagePart.text]. + # The collection of annotated message parts ordered by their position in the + # message. You can recover the annotated message by concatenating [ + # AnnotatedMessagePart.text]. # Corresponds to the JSON property `parts` # @return [Array] attr_accessor :parts @@ -3483,36 +3329,30 @@ module Google end end - # Represents the contents of the original request that was passed to - # the `[Streaming]DetectIntent` call. + # Represents the contents of the original request that was passed to the `[ + # Streaming]DetectIntent` call. class GoogleCloudDialogflowV2OriginalDetectIntentRequest include Google::Apis::Core::Hashable # Optional. This field is set to the value of the `QueryParameters.payload` - # field passed in the request. Some integrations that query a Dialogflow - # agent may provide additional information in the payload. - # In particular, for the Dialogflow Phone Gateway integration, this field has - # the form: - # 
`
-        # "telephony": `
-        # "caller_id": "+18558363987"
-        # `
-        # `
- # Note: The caller ID field (`caller_id`) will be redacted for Standard - # Edition agents and populated with the caller ID in [E.164 - # format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. + # field passed in the request. Some integrations that query a Dialogflow agent + # may provide additional information in the payload. In particular, for the + # Dialogflow Phone Gateway integration, this field has the form: ` "telephony": ` + # "caller_id": "+18558363987" ` ` Note: The caller ID field (`caller_id`) will + # be redacted for Standard Edition agents and populated with the caller ID in [E. + # 164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload - # The source of this request, e.g., `google`, `facebook`, `slack`. It is set - # by Dialogflow-owned servers. + # The source of this request, e.g., `google`, `facebook`, `slack`. It is set by + # Dialogflow-owned servers. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source - # Optional. The version of the protocol used for this request. - # This field is AoG-specific. + # Optional. The version of the protocol used for this request. This field is AoG- + # specific. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -3530,8 +3370,8 @@ module Google end # Instructs the speech synthesizer on how to generate the output audio content. - # If this audio config is supplied in a request, it overrides all existing - # text-to-speech settings applied to the agent. + # If this audio config is supplied in a request, it overrides all existing text- + # to-speech settings applied to the agent. class GoogleCloudDialogflowV2OutputAudioConfig include Google::Apis::Core::Hashable @@ -3540,11 +3380,11 @@ module Google # @return [String] attr_accessor :audio_encoding - # The synthesis sample rate (in hertz) for this audio. If not - # provided, then the synthesizer will use the default sample rate based on - # the audio encoding. If this is different from the voice's natural sample - # rate, then the synthesizer will honor this request by converting to the - # desired sample rate (which might result in worse audio quality). + # The synthesis sample rate (in hertz) for this audio. If not provided, then the + # synthesizer will use the default sample rate based on the audio encoding. If + # this is different from the voice's natural sample rate, then the synthesizer + # will honor this request by converting to the desired sample rate (which might + # result in worse audio quality). # Corresponds to the JSON property `sampleRateHertz` # @return [Fixnum] attr_accessor :sample_rate_hertz @@ -3566,11 +3406,10 @@ module Google end end - # Represents the query input. It can contain either: - # 1. An audio config which - # instructs the speech recognizer how to process the speech audio. - # 2. A conversational query in the form of text,. - # 3. An event that specifies which intent to trigger. + # Represents the query input. It can contain either: 1. An audio config which + # instructs the speech recognizer how to process the speech audio. 2. A + # conversational query in the form of text,. 3. An event that specifies which + # intent to trigger. class GoogleCloudDialogflowV2QueryInput include Google::Apis::Core::Hashable @@ -3580,10 +3419,9 @@ module Google attr_accessor :audio_config # Events allow for matching intents by event name instead of the natural - # language input. For instance, input `` can trigger a personalized welcome response. - # The parameter `name` may be used by the agent in the response: - # `"Hello #welcome_event.name! What can I do for you today?"`. + # language input. For instance, input `` can trigger a personalized welcome + # response. The parameter `name` may be used by the agent in the response: `" + # Hello #welcome_event.name! What can I do for you today?"`. # Corresponds to the JSON property `event` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EventInput] attr_accessor :event @@ -3609,32 +3447,29 @@ module Google class GoogleCloudDialogflowV2QueryParameters include Google::Apis::Core::Hashable - # The collection of contexts to be activated before this query is - # executed. + # The collection of contexts to be activated before this query is executed. # Corresponds to the JSON property `contexts` # @return [Array] attr_accessor :contexts # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `geoLocation` # @return [Google::Apis::DialogflowV2::GoogleTypeLatLng] attr_accessor :geo_location - # This field can be used to pass custom data to your webhook. - # Arbitrary JSON objects are supported. - # If supplied, the value is used to populate the - # `WebhookRequest.original_detect_intent_request.payload` - # field sent to your webhook. + # This field can be used to pass custom data to your webhook. Arbitrary JSON + # objects are supported. If supplied, the value is used to populate the ` + # WebhookRequest.original_detect_intent_request.payload` field sent to your + # webhook. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload - # Specifies whether to delete all contexts in the current session - # before the new ones are activated. + # Specifies whether to delete all contexts in the current session before the new + # ones are activated. # Corresponds to the JSON property `resetContexts` # @return [Boolean] attr_accessor :reset_contexts @@ -3645,17 +3480,16 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SentimentAnalysisRequestConfig] attr_accessor :sentiment_analysis_request_config - # Additional session entity types to replace or extend developer - # entity types with. The entity synonyms apply to all languages and persist - # for the session of this query. + # Additional session entity types to replace or extend developer entity types + # with. The entity synonyms apply to all languages and persist for the session + # of this query. # Corresponds to the JSON property `sessionEntityTypes` # @return [Array] attr_accessor :session_entity_types - # The time zone of this conversational query from the - # [time zone database](https://www.iana.org/time-zones), e.g., - # America/New_York, Europe/Paris. If not provided, the time zone specified in - # agent settings is used. + # The time zone of this conversational query from the [time zone database](https: + # //www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not + # provided, the time zone specified in agent settings is used. # Corresponds to the JSON property `timeZone` # @return [String] attr_accessor :time_zone @@ -3685,22 +3519,19 @@ module Google # @return [String] attr_accessor :action - # This field is set to: - # - `false` if the matched intent has required parameters and not all of - # the required parameter values have been collected. - # - `true` if all required parameter values have been collected, or if the - # matched intent doesn't contain any required parameters. + # This field is set to: - `false` if the matched intent has required parameters + # and not all of the required parameter values have been collected. - `true` if + # all required parameter values have been collected, or if the matched intent + # doesn't contain any required parameters. # Corresponds to the JSON property `allRequiredParamsPresent` # @return [Boolean] attr_accessor :all_required_params_present alias_method :all_required_params_present?, :all_required_params_present - # Free-form diagnostic information for the associated detect intent request. - # The fields of this data can change without notice, so you should not write - # code that depends on its structure. - # The data may contain: - # - webhook call latency - # - webhook errors + # Free-form diagnostic information for the associated detect intent request. The + # fields of this data can change without notice, so you should not write code + # that depends on its structure. The data may contain: - webhook call latency - + # webhook errors # Corresponds to the JSON property `diagnosticInfo` # @return [Hash] attr_accessor :diagnostic_info @@ -3710,8 +3541,8 @@ module Google # @return [Array] attr_accessor :fulfillment_messages - # The text to be pronounced to the user or shown on the screen. - # Note: This is a legacy field, `fulfillment_messages` should be preferred. + # The text to be pronounced to the user or shown on the screen. Note: This is a + # legacy field, `fulfillment_messages` should be preferred. # Corresponds to the JSON property `fulfillmentText` # @return [String] attr_accessor :fulfillment_text @@ -3721,79 +3552,66 @@ module Google # complete conversation. When an end-user writes or says something, referred to # as an end-user expression or end-user input, Dialogflow matches the end-user # input to the best intent in your agent. Matching an intent is also known as - # intent classification. - # For more information, see the [intent - # guide](https://cloud.google.com/dialogflow/docs/intents-overview). + # intent classification. For more information, see the [intent guide](https:// + # cloud.google.com/dialogflow/docs/intents-overview). # Corresponds to the JSON property `intent` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent] attr_accessor :intent - # The intent detection confidence. Values range from 0.0 - # (completely uncertain) to 1.0 (completely certain). - # This value is for informational purpose only and is only used to - # help match the best intent within the classification threshold. + # The intent detection confidence. Values range from 0.0 (completely uncertain) + # to 1.0 (completely certain). This value is for informational purpose only and + # is only used to help match the best intent within the classification threshold. # This value may change for the same end-user expression at any time due to a - # model retraining or change in implementation. - # If there are `multiple knowledge_answers` messages, this value is set to - # the greatest `knowledgeAnswers.match_confidence` value in the list. + # model retraining or change in implementation. If there are `multiple + # knowledge_answers` messages, this value is set to the greatest ` + # knowledgeAnswers.match_confidence` value in the list. # Corresponds to the JSON property `intentDetectionConfidence` # @return [Float] attr_accessor :intent_detection_confidence - # The language that was triggered during intent detection. - # See [Language - # Support](https://cloud.google.com/dialogflow/docs/reference/language) - # for a list of the currently supported language codes. + # The language that was triggered during intent detection. See [Language Support] + # (https://cloud.google.com/dialogflow/docs/reference/language) for a list of + # the currently supported language codes. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # The collection of output contexts. If applicable, - # `output_contexts.parameters` contains entries with name - # `.original` containing the original parameter values - # before the query. + # The collection of output contexts. If applicable, `output_contexts.parameters` + # contains entries with name `.original` containing the original parameter + # values before the query. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts - # The collection of extracted parameters. - # Depending on your protocol or client library language, this is a - # map, associative array, symbol table, dictionary, or JSON object - # composed of a collection of (MapKey, MapValue) pairs: - # - MapKey type: string - # - MapKey value: parameter name - # - MapValue type: - # - If parameter's entity type is a composite entity: map - # - Else: string or number, depending on parameter value type - # - MapValue value: - # - If parameter's entity type is a composite entity: - # map from composite entity property names to property values - # - Else: parameter value + # The collection of extracted parameters. Depending on your protocol or client + # library language, this is a map, associative array, symbol table, dictionary, + # or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey + # type: string - MapKey value: parameter name - MapValue type: - If parameter's + # entity type is a composite entity: map - Else: string or number, depending on + # parameter value type - MapValue value: - If parameter's entity type is a + # composite entity: map from composite entity property names to property values - + # Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters - # The original conversational query text: - # - If natural language text was provided as input, `query_text` contains - # a copy of the input. - # - If natural language speech audio was provided as input, `query_text` - # contains the speech recognition result. If speech recognizer produced - # multiple alternatives, a particular one is picked. - # - If automatic spell correction is enabled, `query_text` will contain the - # corrected user input. + # The original conversational query text: - If natural language text was + # provided as input, `query_text` contains a copy of the input. - If natural + # language speech audio was provided as input, `query_text` contains the speech + # recognition result. If speech recognizer produced multiple alternatives, a + # particular one is picked. - If automatic spell correction is enabled, ` + # query_text` will contain the corrected user input. # Corresponds to the JSON property `queryText` # @return [String] attr_accessor :query_text - # The result of sentiment analysis. Sentiment analysis inspects user input - # and identifies the prevailing subjective opinion, especially to determine a - # user's attitude as positive, negative, or neutral. - # For Participants.AnalyzeContent, it needs to be configured in - # DetectIntentRequest.query_params. For - # Participants.StreamingAnalyzeContent, it needs to be configured in - # StreamingDetectIntentRequest.query_params. - # And for Participants.AnalyzeContent and + # The result of sentiment analysis. Sentiment analysis inspects user input and + # identifies the prevailing subjective opinion, especially to determine a user's + # attitude as positive, negative, or neutral. For Participants.AnalyzeContent, + # it needs to be configured in DetectIntentRequest.query_params. For # Participants.StreamingAnalyzeContent, it needs to be configured in + # StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent + # and Participants.StreamingAnalyzeContent, it needs to be configured in # ConversationProfile.human_agent_assistant_config # Corresponds to the JSON property `sentimentAnalysisResult` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SentimentAnalysisResult] @@ -3801,24 +3619,23 @@ module Google # The Speech recognition confidence between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. The default of 0.0 is a sentinel value indicating that confidence - # was not set. - # This field is not guaranteed to be accurate or set. In particular this - # field isn't set for StreamingDetectIntent since the streaming endpoint has - # separate confidence estimates per portion of the audio in + # correct. The default of 0.0 is a sentinel value indicating that confidence was + # not set. This field is not guaranteed to be accurate or set. In particular + # this field isn't set for StreamingDetectIntent since the streaming endpoint + # has separate confidence estimates per portion of the audio in # StreamingRecognitionResult. # Corresponds to the JSON property `speechRecognitionConfidence` # @return [Float] attr_accessor :speech_recognition_confidence - # If the query was fulfilled by a webhook call, this field is set to the - # value of the `payload` field returned in the webhook response. + # If the query was fulfilled by a webhook call, this field is set to the value + # of the `payload` field returned in the webhook response. # Corresponds to the JSON property `webhookPayload` # @return [Hash] attr_accessor :webhook_payload - # If the query was fulfilled by a webhook call, this field is set to the - # value of the `source` field returned in the webhook response. + # If the query was fulfilled by a webhook call, this field is set to the value + # of the `source` field returned in the webhook response. # Corresponds to the JSON property `webhookSource` # @return [String] attr_accessor :webhook_source @@ -3857,8 +3674,8 @@ module Google # @return [String] attr_accessor :agent_content - # The URI to a Google Cloud Storage file containing the agent to restore. - # Note: The URI must start with "gs://". + # The URI to a Google Cloud Storage file containing the agent to restore. Note: + # The URI must start with "gs://". # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri @@ -3878,14 +3695,14 @@ module Google class GoogleCloudDialogflowV2SearchAgentsResponse include Google::Apis::Core::Hashable - # The list of agents. There will be a maximum number of items returned based - # on the page_size field in the request. + # The list of agents. There will be a maximum number of items returned based on + # the page_size field in the request. # Corresponds to the JSON property `agents` # @return [Array] attr_accessor :agents - # 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 @@ -3901,8 +3718,8 @@ module Google end end - # The sentiment, such as positive/negative feeling or association, for a unit - # of analysis, such as the query text. + # The sentiment, such as positive/negative feeling or association, for a unit of + # analysis, such as the query text. class GoogleCloudDialogflowV2Sentiment include Google::Apis::Core::Hashable @@ -3912,8 +3729,7 @@ module Google # @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 @@ -3933,9 +3749,8 @@ module Google class GoogleCloudDialogflowV2SentimentAnalysisRequestConfig include Google::Apis::Core::Hashable - # Instructs the service to perform sentiment analysis on - # `query_text`. If not provided, sentiment analysis is not performed on - # `query_text`. + # Instructs the service to perform sentiment analysis on `query_text`. If not + # provided, sentiment analysis is not performed on `query_text`. # Corresponds to the JSON property `analyzeQueryTextSentiment` # @return [Boolean] attr_accessor :analyze_query_text_sentiment @@ -3951,21 +3766,19 @@ module Google end end - # The result of sentiment analysis. Sentiment analysis inspects user input - # and identifies the prevailing subjective opinion, especially to determine a - # user's attitude as positive, negative, or neutral. - # For Participants.AnalyzeContent, it needs to be configured in - # DetectIntentRequest.query_params. For - # Participants.StreamingAnalyzeContent, it needs to be configured in - # StreamingDetectIntentRequest.query_params. - # And for Participants.AnalyzeContent and + # The result of sentiment analysis. Sentiment analysis inspects user input and + # identifies the prevailing subjective opinion, especially to determine a user's + # attitude as positive, negative, or neutral. For Participants.AnalyzeContent, + # it needs to be configured in DetectIntentRequest.query_params. For # Participants.StreamingAnalyzeContent, it needs to be configured in + # StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent + # and Participants.StreamingAnalyzeContent, it needs to be configured in # ConversationProfile.human_agent_assistant_config class GoogleCloudDialogflowV2SentimentAnalysisResult include Google::Apis::Core::Hashable - # The sentiment, such as positive/negative feeling or association, for a unit - # of analysis, such as the query text. + # The sentiment, such as positive/negative feeling or association, for a unit of + # analysis, such as the query text. # Corresponds to the JSON property `queryTextSentiment` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Sentiment] attr_accessor :query_text_sentiment @@ -3980,37 +3793,33 @@ module Google end end - # A session represents a conversation between a Dialogflow agent and an - # end-user. You can create special entities, called session entities, during a - # session. Session entities can extend or replace custom entity types and only - # exist during the session that they were created for. All session data, - # including session entities, is stored by Dialogflow for 20 minutes. - # For more information, see the [session entity - # guide](https://cloud.google.com/dialogflow/docs/entities-session). + # A session represents a conversation between a Dialogflow agent and an end-user. + # You can create special entities, called session entities, during a session. + # Session entities can extend or replace custom entity types and only exist + # during the session that they were created for. All session data, including + # session entities, is stored by Dialogflow for 20 minutes. For more information, + # see the [session entity guide](https://cloud.google.com/dialogflow/docs/ + # entities-session). class GoogleCloudDialogflowV2SessionEntityType include Google::Apis::Core::Hashable - # Required. The collection of entities associated with this session entity - # type. + # Required. The collection of entities associated with this session entity type. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities - # Required. Indicates whether the additional data should override or - # supplement the custom entity type definition. + # Required. Indicates whether the additional data should override or supplement + # the custom entity type definition. # Corresponds to the JSON property `entityOverrideMode` # @return [String] attr_accessor :entity_override_mode - # Required. The unique identifier of this session entity type. Format: - # `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # `` must be the display name of an existing entity - # type in the same agent that will be overridden or supplemented. + # Required. The unique identifier of this session entity type. Format: `projects/ + # /agent/sessions//entityTypes/`, or `projects//agent/environments//users// + # sessions//entityTypes/`. If `Environment ID` is not specified, we assume + # default 'draft' environment. If `User ID` is not specified, we assume default ' + # -' user. `` must be the display name of an existing entity type in the same + # agent that will be overridden or supplemented. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4032,27 +3841,22 @@ module Google class GoogleCloudDialogflowV2SpeechContext include Google::Apis::Core::Hashable - # Optional. Boost for this context compared to other contexts: - # * If the boost is positive, Dialogflow will increase the probability that - # the phrases in this context are recognized over similar sounding phrases. - # * If the boost is unspecified or non-positive, Dialogflow will not apply - # any boost. - # Dialogflow recommends that you use boosts in the range (0, 20] and that you - # find a value that fits your use case with binary search. + # Optional. Boost for this context compared to other contexts: * If the boost is + # positive, Dialogflow will increase the probability that the phrases in this + # context are recognized over similar sounding phrases. * If the boost is + # unspecified or non-positive, Dialogflow will not apply any boost. Dialogflow + # recommends that you use boosts in the range (0, 20] and that you find a value + # that fits your use case with binary search. # Corresponds to the JSON property `boost` # @return [Float] attr_accessor :boost # Optional. A list of strings containing words and phrases that the speech - # recognizer should recognize with higher likelihood. - # This list can be used to: - # * improve accuracy for words and phrases you expect the user to say, - # e.g. typical commands for your Dialogflow agent - # * add additional words to the speech recognizer vocabulary - # * ... - # See the [Cloud Speech - # documentation](https://cloud.google.com/speech-to-text/quotas) for usage - # limits. + # recognizer should recognize with higher likelihood. This list can be used to: * + # improve accuracy for words and phrases you expect the user to say, e.g. + # typical commands for your Dialogflow agent * add additional words to the + # speech recognizer vocabulary * ... See the [Cloud Speech documentation](https:/ + # /cloud.google.com/speech-to-text/quotas) for usage limits. # Corresponds to the JSON property `phrases` # @return [Array] attr_accessor :phrases @@ -4087,9 +3891,9 @@ module Google attr_accessor :pitch # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal - # native speed supported by the specific voice. 2.0 is twice as fast, and - # 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any - # other values < 0.25 or > 4.0 will return an error. + # native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is + # half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other + # values < 0.25 or > 4.0 will return an error. # Corresponds to the JSON property `speakingRate` # @return [Float] attr_accessor :speaking_rate @@ -4100,13 +3904,13 @@ module Google attr_accessor :voice # Optional. Volume gain (in dB) of the normal native volume supported by the - # specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of - # 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) - # will play at approximately half the amplitude of the normal native signal - # amplitude. A value of +6.0 (dB) will play at approximately twice the - # amplitude of the normal native signal amplitude. We strongly recommend not - # to exceed +10 (dB) as there's usually no effective increase in loudness for - # any value greater than that. + # specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 + # (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will + # play at approximately half the amplitude of the normal native signal amplitude. + # A value of +6.0 (dB) will play at approximately twice the amplitude of the + # normal native signal amplitude. We strongly recommend not to exceed +10 (dB) + # as there's usually no effective increase in loudness for any value greater + # than that. # Corresponds to the JSON property `volumeGainDb` # @return [Float] attr_accessor :volume_gain_db @@ -4129,16 +3933,16 @@ module Google class GoogleCloudDialogflowV2TextInput include Google::Apis::Core::Hashable - # Required. The language of this conversational query. See [Language - # Support](https://cloud.google.com/dialogflow/docs/reference/language) - # for a list of the currently supported language codes. Note that queries in - # the same session do not necessarily need to specify the same language. + # Required. The language of this conversational query. See [Language Support]( + # https://cloud.google.com/dialogflow/docs/reference/language) for a list of the + # currently supported language codes. Note that queries in the same session do + # not necessarily need to specify the same language. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # Required. The UTF-8 encoded natural language text to be processed. - # Text length must not exceed 256 characters. + # Required. The UTF-8 encoded natural language text to be processed. Text length + # must not exceed 256 characters. # Corresponds to the JSON property `text` # @return [String] attr_accessor :text @@ -4171,19 +3975,13 @@ module Google class GoogleCloudDialogflowV2ValidationError include Google::Apis::Core::Hashable - # The names of the entries that the error is associated with. - # Format: - # - "projects//agent", if the error is associated with the entire - # agent. - # - "projects//agent/intents/", if the error is - # associated with certain intents. - # - "projects//agent/intents//trainingPhrases/", if the - # error is associated with certain intent training phrases. - # - "projects//agent/intents//parameters/", if the error is associated with certain intent parameters. - # - "projects//agent/entities/", if the error is - # associated with certain entities. + # The names of the entries that the error is associated with. Format: - " + # projects//agent", if the error is associated with the entire agent. - " + # projects//agent/intents/", if the error is associated with certain intents. - " + # projects//agent/intents//trainingPhrases/", if the error is associated with + # certain intent training phrases. - "projects//agent/intents//parameters/", if + # the error is associated with certain intent parameters. - "projects//agent/ + # entities/", if the error is associated with certain entities. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries @@ -4233,18 +4031,17 @@ module Google class GoogleCloudDialogflowV2VoiceSelectionParams include Google::Apis::Core::Hashable - # Optional. The name of the voice. If not set, the service will choose a - # voice based on the other parameters such as language_code and - # ssml_gender. + # Optional. The name of the voice. If not set, the service will choose a voice + # based on the other parameters such as language_code and ssml_gender. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Optional. The preferred gender of the voice. If not set, the service will - # choose a voice based on the other parameters such as language_code and - # name. Note that this is only a preference, not requirement. If a - # voice of the appropriate gender is not available, the synthesizer should - # substitute a voice with a different gender rather than failing the request. + # choose a voice based on the other parameters such as language_code and name. + # Note that this is only a preference, not requirement. If a voice of the + # appropriate gender is not available, the synthesizer should substitute a voice + # with a different gender rather than failing the request. # Corresponds to the JSON property `ssmlGender` # @return [String] attr_accessor :ssml_gender @@ -4264,8 +4061,8 @@ module Google class GoogleCloudDialogflowV2WebhookRequest include Google::Apis::Core::Hashable - # Represents the contents of the original request that was passed to - # the `[Streaming]DetectIntent` call. + # Represents the contents of the original request that was passed to the `[ + # Streaming]DetectIntent` call. # Corresponds to the JSON property `originalDetectIntentRequest` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2OriginalDetectIntentRequest] attr_accessor :original_detect_intent_request @@ -4275,17 +4072,15 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2QueryResult] attr_accessor :query_result - # The unique identifier of the response. Contains the same value as - # `[Streaming]DetectIntentResponse.response_id`. + # The unique identifier of the response. Contains the same value as `[Streaming] + # DetectIntentResponse.response_id`. # Corresponds to the JSON property `responseId` # @return [String] attr_accessor :response_id - # The unique identifier of detectIntent request session. - # Can be used to identify end-user inside webhook implementation. - # Format: `projects//agent/sessions/`, or - # `projects//agent/environments//users//sessions/`. + # The unique identifier of detectIntent request session. Can be used to identify + # end-user inside webhook implementation. Format: `projects//agent/sessions/`, + # or `projects//agent/environments//users//sessions/`. # Corresponds to the JSON property `session` # @return [String] attr_accessor :session @@ -4303,79 +4098,70 @@ module Google end end - # The response message for a webhook call. - # This response is validated by the Dialogflow server. If validation fails, - # an error will be returned in the QueryResult.diagnostic_info field. - # Setting JSON fields to an empty value with the wrong type is a common error. - # To avoid this error: - # - Use `""` for empty strings - # - Use ```` or `null` for empty objects - # - Use `[]` or `null` for empty arrays - # For more information, see the - # [Protocol Buffers Language - # Guide](https://developers.google.com/protocol-buffers/docs/proto3#json). + # The response message for a webhook call. This response is validated by the + # Dialogflow server. If validation fails, an error will be returned in the + # QueryResult.diagnostic_info field. Setting JSON fields to an empty value with + # the wrong type is a common error. To avoid this error: - Use `""` for empty + # strings - Use ```` or `null` for empty objects - Use `[]` or `null` for empty + # arrays For more information, see the [Protocol Buffers Language Guide](https:// + # developers.google.com/protocol-buffers/docs/proto3#json). class GoogleCloudDialogflowV2WebhookResponse include Google::Apis::Core::Hashable # Events allow for matching intents by event name instead of the natural - # language input. For instance, input `` can trigger a personalized welcome response. - # The parameter `name` may be used by the agent in the response: - # `"Hello #welcome_event.name! What can I do for you today?"`. + # language input. For instance, input `` can trigger a personalized welcome + # response. The parameter `name` may be used by the agent in the response: `" + # Hello #welcome_event.name! What can I do for you today?"`. # Corresponds to the JSON property `followupEventInput` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EventInput] attr_accessor :followup_event_input - # Optional. The rich response messages intended for the end-user. - # When provided, Dialogflow uses this field to populate - # QueryResult.fulfillment_messages sent to the integration or API caller. + # Optional. The rich response messages intended for the end-user. When provided, + # Dialogflow uses this field to populate QueryResult.fulfillment_messages sent + # to the integration or API caller. # Corresponds to the JSON property `fulfillmentMessages` # @return [Array] attr_accessor :fulfillment_messages - # Optional. The text response message intended for the end-user. - # It is recommended to use `fulfillment_messages.text.text[0]` instead. - # When provided, Dialogflow uses this field to populate - # QueryResult.fulfillment_text sent to the integration or API caller. + # Optional. The text response message intended for the end-user. It is + # recommended to use `fulfillment_messages.text.text[0]` instead. When provided, + # Dialogflow uses this field to populate QueryResult.fulfillment_text sent to + # the integration or API caller. # Corresponds to the JSON property `fulfillmentText` # @return [String] attr_accessor :fulfillment_text # Optional. The collection of output contexts that will overwrite currently - # active contexts for the session and reset their lifespans. - # When provided, Dialogflow uses this field to populate - # QueryResult.output_contexts sent to the integration or API caller. + # active contexts for the session and reset their lifespans. When provided, + # Dialogflow uses this field to populate QueryResult.output_contexts sent to the + # integration or API caller. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts # Optional. This field can be used to pass custom data from your webhook to the - # integration or API caller. Arbitrary JSON objects are supported. - # When provided, Dialogflow uses this field to populate - # QueryResult.webhook_payload sent to the integration or API caller. - # This field is also used by the - # [Google Assistant - # integration](https://cloud.google.com/dialogflow/docs/integrations/aog) - # for rich response messages. - # See the format definition at [Google Assistant Dialogflow webhook - # format](https://developers.google.com/assistant/actions/build/json/dialogflow- - # webhook-json) + # integration or API caller. Arbitrary JSON objects are supported. When provided, + # Dialogflow uses this field to populate QueryResult.webhook_payload sent to + # the integration or API caller. This field is also used by the [Google + # Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/ + # aog) for rich response messages. See the format definition at [Google + # Assistant Dialogflow webhook format](https://developers.google.com/assistant/ + # actions/build/json/dialogflow-webhook-json) # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload # Optional. Additional session entity types to replace or extend developer - # entity types with. The entity synonyms apply to all languages and persist - # for the session. Setting this data from a webhook overwrites - # the session entity types that have been set using `detectIntent`, - # `streamingDetectIntent` or SessionEntityType management methods. + # entity types with. The entity synonyms apply to all languages and persist for + # the session. Setting this data from a webhook overwrites the session entity + # types that have been set using `detectIntent`, `streamingDetectIntent` or + # SessionEntityType management methods. # Corresponds to the JSON property `sessionEntityTypes` # @return [Array] attr_accessor :session_entity_types - # Optional. A custom field used to identify the webhook source. - # Arbitrary strings are supported. - # When provided, Dialogflow uses this field to populate + # Optional. A custom field used to identify the webhook source. Arbitrary + # strings are supported. When provided, Dialogflow uses this field to populate # QueryResult.webhook_source sent to the integration or API caller. # Corresponds to the JSON property `source` # @return [String] @@ -4397,11 +4183,10 @@ module Google end end - # Represents an annotated conversation dataset. - # ConversationDataset can have multiple AnnotatedConversationDataset, each of - # them represents one result from one annotation task. - # AnnotatedConversationDataset can only be generated from annotation task, - # which will be triggered by LabelConversation. + # Represents an annotated conversation dataset. ConversationDataset can have + # multiple AnnotatedConversationDataset, each of them represents one result from + # one annotation task. AnnotatedConversationDataset can only be generated from + # annotation task, which will be triggered by LabelConversation. class GoogleCloudDialogflowV2beta1AnnotatedConversationDataset include Google::Apis::Core::Hashable @@ -4416,14 +4201,14 @@ module Google # @return [String] attr_accessor :create_time - # Optional. The description of the annotated conversation dataset. - # Maximum of 10000 bytes. + # Optional. The description of the annotated conversation dataset. Maximum of + # 10000 bytes. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Required. The display name of the annotated conversation dataset. - # It's specified when user starts an annotation task. Maximum of 64 bytes. + # Required. The display name of the annotated conversation dataset. It's + # specified when user starts an annotation task. Maximum of 64 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -4433,17 +4218,16 @@ module Google # @return [Fixnum] attr_accessor :example_count - # Output only. AnnotatedConversationDataset resource name. Format: - # `projects//conversationDatasets//annotatedConversationDatasets/` + # Output only. AnnotatedConversationDataset resource name. Format: `projects// + # conversationDatasets//annotatedConversationDatasets/` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Output only. Question type name that identifies a labeling task. - # A question is a single task that a worker answers. A question type is set - # of related questions. Each question belongs to a particular question type. - # It can be used in CrowdCompute UI to filter and manage labeling tasks. + # Output only. Question type name that identifies a labeling task. A question is + # a single task that a worker answers. A question type is set of related + # questions. Each question belongs to a particular question type. It can be used + # in CrowdCompute UI to filter and manage labeling tasks. # Corresponds to the JSON property `questionTypeName` # @return [String] attr_accessor :question_type_name @@ -4536,57 +4320,47 @@ module Google # Dialogflow contexts are similar to natural language context. If a person says # to you "they are orange", you need context in order to understand what "they" # is referring to. Similarly, for Dialogflow to handle an end-user expression - # like that, it needs to be provided with context in order to correctly match - # an intent. - # Using contexts, you can control the flow of a conversation. You can configure - # contexts for an intent by setting input and output contexts, which are - # identified by string names. When an intent is matched, any configured output - # contexts for that intent become active. While any contexts are active, + # like that, it needs to be provided with context in order to correctly match an + # intent. Using contexts, you can control the flow of a conversation. You can + # configure contexts for an intent by setting input and output contexts, which + # are identified by string names. When an intent is matched, any configured + # output contexts for that intent become active. While any contexts are active, # Dialogflow is more likely to match intents that are configured with input - # contexts that correspond to the currently active contexts. - # For more information about context, see the - # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview). + # contexts that correspond to the currently active contexts. For more + # information about context, see the [Contexts guide](https://cloud.google.com/ + # dialogflow/docs/contexts-overview). class GoogleCloudDialogflowV2beta1Context include Google::Apis::Core::Hashable - # Optional. The number of conversational query requests after which the - # context expires. The default is `0`. If set to `0`, the context expires - # immediately. Contexts expire automatically after 20 minutes if there - # are no matching queries. + # Optional. The number of conversational query requests after which the context + # expires. The default is `0`. If set to `0`, the context expires immediately. + # Contexts expire automatically after 20 minutes if there are no matching + # queries. # Corresponds to the JSON property `lifespanCount` # @return [Fixnum] attr_accessor :lifespan_count - # Required. The unique identifier of the context. Format: - # `projects//agent/sessions//contexts/`, - # or `projects//agent/environments//users//sessions//contexts/`. - # The `Context ID` is always converted to lowercase, may only contain - # characters in a-zA-Z0-9_-% and may be at most 250 bytes long. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # The following context names are reserved for internal use by Dialogflow. - # You should not use these contexts or create contexts with these names: - # * `__system_counters__` - # * `*_id_dialog_context` - # * `*_dialog_params_size` + # Required. The unique identifier of the context. Format: `projects//agent/ + # sessions//contexts/`, or `projects//agent/environments//users//sessions// + # contexts/`. The `Context ID` is always converted to lowercase, may only + # contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. The following context + # names are reserved for internal use by Dialogflow. You should not use these + # contexts or create contexts with these names: * `__system_counters__` * `* + # _id_dialog_context` * `*_dialog_params_size` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Optional. The collection of parameters associated with this context. - # Depending on your protocol or client library language, this is a - # map, associative array, symbol table, dictionary, or JSON object - # composed of a collection of (MapKey, MapValue) pairs: - # - MapKey type: string - # - MapKey value: parameter name - # - MapValue type: - # - If parameter's entity type is a composite entity: map - # - Else: string or number, depending on parameter value type - # - MapValue value: - # - If parameter's entity type is a composite entity: - # map from composite entity property names to property values - # - Else: parameter value + # Optional. The collection of parameters associated with this context. Depending + # on your protocol or client library language, this is a map, associative array, + # symbol table, dictionary, or JSON object composed of a collection of (MapKey, + # MapValue) pairs: - MapKey type: string - MapKey value: parameter name - + # MapValue type: - If parameter's entity type is a composite entity: map - Else: + # string or number, depending on parameter value type - MapValue value: - If + # parameter's entity type is a composite entity: map from composite entity + # property names to property values - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -4604,20 +4378,18 @@ module Google end # Each intent parameter has a type, called the entity type, which dictates - # exactly how data from an end-user expression is extracted. - # Dialogflow provides predefined system entities that can match many common - # types of data. For example, there are system entities for matching dates, - # times, colors, email addresses, and so on. You can also create your own - # custom entities for matching custom data. For example, you could define a - # vegetable entity that can match the types of vegetables available for - # purchase with a grocery store agent. - # For more information, see the - # [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview). + # exactly how data from an end-user expression is extracted. Dialogflow provides + # predefined system entities that can match many common types of data. For + # example, there are system entities for matching dates, times, colors, email + # addresses, and so on. You can also create your own custom entities for + # matching custom data. For example, you could define a vegetable entity that + # can match the types of vegetables available for purchase with a grocery store + # agent. For more information, see the [Entity guide](https://cloud.google.com/ + # dialogflow/docs/entities-overview). class GoogleCloudDialogflowV2beta1EntityType include Google::Apis::Core::Hashable - # Optional. Indicates whether the entity type can be automatically - # expanded. + # Optional. Indicates whether the entity type can be automatically expanded. # Corresponds to the JSON property `autoExpansionMode` # @return [String] attr_accessor :auto_expansion_mode @@ -4643,10 +4415,9 @@ module Google # @return [String] attr_accessor :kind - # The unique identifier of the entity type. - # Required for EntityTypes.UpdateEntityType and - # EntityTypes.BatchUpdateEntityTypes methods. - # Format: `projects//agent/entityTypes/`. + # The unique identifier of the entity type. Required for EntityTypes. + # UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: ` + # projects//agent/entityTypes/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4670,23 +4441,19 @@ module Google class GoogleCloudDialogflowV2beta1EntityTypeEntity include Google::Apis::Core::Hashable - # Required. A collection of value synonyms. For example, if the entity type - # is *vegetable*, and `value` is *scallions*, a synonym could be *green - # onions*. - # For `KIND_LIST` entity types: - # * This collection must contain exactly one synonym equal to `value`. + # Required. A collection of value synonyms. For example, if the entity type is * + # vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For + # `KIND_LIST` entity types: * This collection must contain exactly one synonym + # equal to `value`. # Corresponds to the JSON property `synonyms` # @return [Array] attr_accessor :synonyms - # Required. The primary value associated with this entity entry. - # For example, if the entity type is *vegetable*, the value could be - # *scallions*. - # For `KIND_MAP` entity types: - # * A reference value to be used in place of synonyms. - # For `KIND_LIST` entity types: - # * A string that can contain references to other entity types (with or - # without aliases). + # Required. The primary value associated with this entity entry. For example, if + # the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` + # entity types: * A reference value to be used in place of synonyms. For ` + # KIND_LIST` entity types: * A string that can contain references to other + # entity types (with or without aliases). # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -4703,17 +4470,16 @@ module Google end # Events allow for matching intents by event name instead of the natural - # language input. For instance, input `` can trigger a personalized welcome response. - # The parameter `name` may be used by the agent in the response: - # `"Hello #welcome_event.name! What can I do for you today?"`. + # language input. For instance, input `` can trigger a personalized welcome + # response. The parameter `name` may be used by the agent in the response: `" + # Hello #welcome_event.name! What can I do for you today?"`. class GoogleCloudDialogflowV2beta1EventInput include Google::Apis::Core::Hashable - # Required. The language of this query. See [Language - # Support](https://cloud.google.com/dialogflow/docs/reference/language) - # for a list of the currently supported language codes. Note that queries in - # the same session do not necessarily need to specify the same language. + # Required. The language of this query. See [Language Support](https://cloud. + # google.com/dialogflow/docs/reference/language) for a list of the currently + # supported language codes. Note that queries in the same session do not + # necessarily need to specify the same language. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -4723,19 +4489,14 @@ module Google # @return [String] attr_accessor :name - # The collection of parameters associated with the event. - # Depending on your protocol or client library language, this is a - # map, associative array, symbol table, dictionary, or JSON object - # composed of a collection of (MapKey, MapValue) pairs: - # - MapKey type: string - # - MapKey value: parameter name - # - MapValue type: - # - If parameter's entity type is a composite entity: map - # - Else: string or number, depending on parameter value type - # - MapValue value: - # - If parameter's entity type is a composite entity: - # map from composite entity property names to property values - # - Else: parameter value + # The collection of parameters associated with the event. Depending on your + # protocol or client library language, this is a map, associative array, symbol + # table, dictionary, or JSON object composed of a collection of (MapKey, + # MapValue) pairs: - MapKey type: string - MapKey value: parameter name - + # MapValue type: - If parameter's entity type is a composite entity: map - Else: + # string or number, depending on parameter value type - MapValue value: - If + # parameter's entity type is a composite entity: map from composite entity + # property names to property values - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -4762,8 +4523,8 @@ module Google # @return [String] attr_accessor :agent_content - # The URI to a file containing the exported agent. This field is populated - # only if `agent_uri` is specified in `ExportAgentRequest`. + # The URI to a file containing the exported agent. This field is populated only + # if `agent_uri` is specified in `ExportAgentRequest`. # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri @@ -4784,20 +4545,19 @@ module Google # complete conversation. When an end-user writes or says something, referred to # as an end-user expression or end-user input, Dialogflow matches the end-user # input to the best intent in your agent. Matching an intent is also known as - # intent classification. - # For more information, see the [intent - # guide](https://cloud.google.com/dialogflow/docs/intents-overview). + # intent classification. For more information, see the [intent guide](https:// + # cloud.google.com/dialogflow/docs/intents-overview). class GoogleCloudDialogflowV2beta1Intent include Google::Apis::Core::Hashable - # Optional. The name of the action associated with the intent. - # Note: The action name must not contain whitespaces. + # Optional. The name of the action associated with the intent. Note: The action + # name must not contain whitespaces. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action - # Optional. The list of platforms for which the first responses will be - # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). + # Optional. The list of platforms for which the first responses will be copied + # from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). # Corresponds to the JSON property `defaultResponsePlatforms` # @return [Array] attr_accessor :default_response_platforms @@ -4807,31 +4567,30 @@ module Google # @return [String] attr_accessor :display_name - # Optional. Indicates that this intent ends an interaction. Some integrations - # (e.g., Actions on Google or Dialogflow phone gateway) use this information - # to close interaction with an end user. Default is false. + # Optional. Indicates that this intent ends an interaction. Some integrations (e. + # g., Actions on Google or Dialogflow phone gateway) use this information to + # close interaction with an end user. Default is false. # Corresponds to the JSON property `endInteraction` # @return [Boolean] attr_accessor :end_interaction alias_method :end_interaction?, :end_interaction - # Optional. The collection of event names that trigger the intent. - # If the collection of input contexts is not empty, all of the contexts must - # be present in the active user session for an event to trigger this intent. - # Event names are limited to 150 characters. + # Optional. The collection of event names that trigger the intent. If the + # collection of input contexts is not empty, all of the contexts must be present + # in the active user session for an event to trigger this intent. Event names + # are limited to 150 characters. # Corresponds to the JSON property `events` # @return [Array] attr_accessor :events - # Output only. Information about all followup intents that have this intent as - # a direct or indirect parent. We populate this field only in the output. + # Output only. Information about all followup intents that have this intent as a + # direct or indirect parent. We populate this field only in the output. # Corresponds to the JSON property `followupIntentInfo` # @return [Array] attr_accessor :followup_intent_info - # Optional. The list of context names required for this intent to be - # triggered. - # Format: `projects//agent/sessions/-/contexts/`. + # Optional. The list of context names required for this intent to be triggered. + # Format: `projects//agent/sessions/-/contexts/`. # Corresponds to the JSON property `inputContextNames` # @return [Array] attr_accessor :input_context_names @@ -4842,50 +4601,45 @@ module Google attr_accessor :is_fallback alias_method :is_fallback?, :is_fallback - # Optional. The collection of rich messages corresponding to the - # `Response` field in the Dialogflow console. + # Optional. The collection of rich messages corresponding to the `Response` + # field in the Dialogflow console. # Corresponds to the JSON property `messages` # @return [Array] attr_accessor :messages - # Optional. Indicates whether Machine Learning is disabled for the intent. - # Note: If `ml_disabled` setting is set to true, then this intent is not - # taken into account during inference in `ML ONLY` match mode. Also, - # auto-markup in the UI is turned off. + # Optional. Indicates whether Machine Learning is disabled for the intent. Note: + # If `ml_disabled` setting is set to true, then this intent is not taken into + # account during inference in `ML ONLY` match mode. Also, auto-markup in the UI + # is turned off. # Corresponds to the JSON property `mlDisabled` # @return [Boolean] attr_accessor :ml_disabled alias_method :ml_disabled?, :ml_disabled - # Optional. Indicates whether Machine Learning is enabled for the intent. - # Note: If `ml_enabled` setting is set to false, then this intent is not - # taken into account during inference in `ML ONLY` match mode. Also, - # auto-markup in the UI is turned off. - # DEPRECATED! Please use `ml_disabled` field instead. - # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, - # then the default value is determined as follows: - # - Before April 15th, 2018 the default is: - # ml_enabled = false / ml_disabled = true. - # - After April 15th, 2018 the default is: - # ml_enabled = true / ml_disabled = false. + # Optional. Indicates whether Machine Learning is enabled for the intent. Note: + # If `ml_enabled` setting is set to false, then this intent is not taken into + # account during inference in `ML ONLY` match mode. Also, auto-markup in the UI + # is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If + # both `ml_enabled` and `ml_disabled` are either not set or false, then the + # default value is determined as follows: - Before April 15th, 2018 the default + # is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the + # default is: ml_enabled = true / ml_disabled = false. # Corresponds to the JSON property `mlEnabled` # @return [Boolean] attr_accessor :ml_enabled alias_method :ml_enabled?, :ml_enabled - # Optional. The unique identifier of this intent. - # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents - # methods. - # Format: `projects//agent/intents/`. + # Optional. The unique identifier of this intent. Required for Intents. + # UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/ + # intents/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Optional. The collection of contexts that are activated when the intent - # is matched. Context messages in this collection should not set the - # parameters field. Setting the `lifespan_count` to 0 will reset the context - # when the intent is matched. - # Format: `projects//agent/sessions/-/contexts/`. + # Optional. The collection of contexts that are activated when the intent is + # matched. Context messages in this collection should not set the parameters + # field. Setting the `lifespan_count` to 0 will reset the context when the + # intent is matched. Format: `projects//agent/sessions/-/contexts/`. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts @@ -4895,45 +4649,39 @@ module Google # @return [Array] attr_accessor :parameters - # Optional. The unique identifier of the parent intent in the - # chain of followup intents. You can set this field when creating an intent, - # for example with CreateIntent or - # BatchUpdateIntents, in order to make this - # intent a followup intent. - # It identifies the parent followup intent. - # Format: `projects//agent/intents/`. + # Optional. The unique identifier of the parent intent in the chain of followup + # intents. You can set this field when creating an intent, for example with + # CreateIntent or BatchUpdateIntents, in order to make this intent a followup + # intent. It identifies the parent followup intent. Format: `projects//agent/ + # intents/`. # Corresponds to the JSON property `parentFollowupIntentName` # @return [String] attr_accessor :parent_followup_intent_name # Optional. The priority of this intent. Higher numbers represent higher - # priorities. - # - If the supplied value is unspecified or 0, the service - # translates the value to 500,000, which corresponds to the - # `Normal` priority in the console. - # - If the supplied value is negative, the intent is ignored - # in runtime detect intent requests. + # priorities. - If the supplied value is unspecified or 0, the service + # translates the value to 500,000, which corresponds to the `Normal` priority in + # the console. - If the supplied value is negative, the intent is ignored in + # runtime detect intent requests. # Corresponds to the JSON property `priority` # @return [Fixnum] attr_accessor :priority - # Optional. Indicates whether to delete all contexts in the current - # session when this intent is matched. + # Optional. Indicates whether to delete all contexts in the current session when + # this intent is matched. # Corresponds to the JSON property `resetContexts` # @return [Boolean] attr_accessor :reset_contexts alias_method :reset_contexts?, :reset_contexts - # Output only. The unique identifier of the root intent in the chain of - # followup intents. It identifies the correct followup intents chain for - # this intent. - # Format: `projects//agent/intents/`. + # Output only. The unique identifier of the root intent in the chain of followup + # intents. It identifies the correct followup intents chain for this intent. + # Format: `projects//agent/intents/`. # Corresponds to the JSON property `rootFollowupIntentName` # @return [String] attr_accessor :root_followup_intent_name - # Optional. The collection of examples that the agent is - # trained on. + # Optional. The collection of examples that the agent is trained on. # Corresponds to the JSON property `trainingPhrases` # @return [Array] attr_accessor :training_phrases @@ -4976,14 +4724,14 @@ module Google class GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo include Google::Apis::Core::Hashable - # The unique identifier of the followup intent. - # Format: `projects//agent/intents/`. + # The unique identifier of the followup intent. Format: `projects//agent/intents/ + # `. # Corresponds to the JSON property `followupIntentName` # @return [String] attr_accessor :followup_intent_name - # The unique identifier of the followup intent's parent. - # Format: `projects//agent/intents/`. + # The unique identifier of the followup intent's parent. Format: `projects// + # agent/intents/`. # Corresponds to the JSON property `parentFollowupIntentName` # @return [String] attr_accessor :parent_followup_intent_name @@ -5008,8 +4756,8 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageBasicCard] attr_accessor :basic_card - # Browse Carousel Card for Actions on Google. - # https://developers.google.com/actions/assistant/responses#browsing_carousel + # Browse Carousel Card for Actions on Google. https://developers.google.com/ + # actions/assistant/responses#browsing_carousel # Corresponds to the JSON property `browseCarouselCard` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard] attr_accessor :browse_carousel_card @@ -5029,8 +4777,8 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageImage] attr_accessor :image - # The suggestion chip message that allows the user to jump out to the app - # or website associated with this agent. + # The suggestion chip message that allows the user to jump out to the app or + # website associated with this agent. # Corresponds to the JSON property `linkOutSuggestion` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion] attr_accessor :link_out_suggestion @@ -5060,20 +4808,18 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageQuickReplies] attr_accessor :quick_replies - # Carousel Rich Business Messaging (RBM) rich card. - # Rich cards allow you to respond to users with more vivid content, e.g. - # with media and suggestions. - # If you want to show a single card with more control over the layout, - # please use RbmStandaloneCard instead. + # Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to + # respond to users with more vivid content, e.g. with media and suggestions. If + # you want to show a single card with more control over the layout, please use + # RbmStandaloneCard instead. # Corresponds to the JSON property `rbmCarouselRichCard` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard] attr_accessor :rbm_carousel_rich_card - # Standalone Rich Business Messaging (RBM) rich card. - # Rich cards allow you to respond to users with more vivid content, e.g. - # with media and suggestions. - # You can group multiple rich cards into one using RbmCarouselCard but - # carousel cards will give you less control over the card layout. + # Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to + # respond to users with more vivid content, e.g. with media and suggestions. You + # can group multiple rich cards into one using RbmCarouselCard but carousel + # cards will give you less control over the card layout. # Corresponds to the JSON property `rbmStandaloneRichCard` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard] attr_accessor :rbm_standalone_rich_card @@ -5083,10 +4829,9 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmText] attr_accessor :rbm_text - # The collection of simple response candidates. - # This message in `QueryResult.fulfillment_messages` and - # `WebhookResponse.fulfillment_messages` should contain only one - # `SimpleResponse`. + # The collection of simple response candidates. This message in `QueryResult. + # fulfillment_messages` and `WebhookResponse.fulfillment_messages` should + # contain only one `SimpleResponse`. # Corresponds to the JSON property `simpleResponses` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses] attr_accessor :simple_responses @@ -5107,10 +4852,9 @@ module Google attr_accessor :telephony_play_audio # Synthesizes speech and plays back the synthesized audio to the caller in - # Telephony Gateway. - # Telephony Gateway takes the synthesizer settings from - # `DetectIntentResponse.output_audio_config` which can either be set - # at request-level or can come from the agent-level synthesizer config. + # Telephony Gateway. Telephony Gateway takes the synthesizer settings from ` + # DetectIntentResponse.output_audio_config` which can either be set at request- + # level or can come from the agent-level synthesizer config. # Corresponds to the JSON property `telephonySynthesizeSpeech` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech] attr_accessor :telephony_synthesize_speech @@ -5242,19 +4986,18 @@ module Google end end - # Browse Carousel Card for Actions on Google. - # https://developers.google.com/actions/assistant/responses#browsing_carousel + # Browse Carousel Card for Actions on Google. https://developers.google.com/ + # actions/assistant/responses#browsing_carousel class GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard include Google::Apis::Core::Hashable - # Optional. Settings for displaying the image. Applies to every image in - # items. + # Optional. Settings for displaying the image. Applies to every image in items. # Corresponds to the JSON property `imageDisplayOptions` # @return [String] attr_accessor :image_display_options - # Required. List of items in the Browse Carousel Card. Minimum of two - # items, maximum of ten. + # Required. List of items in the Browse Carousel Card. Minimum of two items, + # maximum of ten. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items @@ -5274,14 +5017,13 @@ module Google class GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem include Google::Apis::Core::Hashable - # Optional. Description of the carousel item. Maximum of four lines of - # text. + # Optional. Description of the carousel item. Maximum of four lines of text. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional. Text that appears at the bottom of the Browse Carousel - # Card. Maximum of one line of text. + # Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum + # of one line of text. # Corresponds to the JSON property `footer` # @return [String] attr_accessor :footer @@ -5324,8 +5066,8 @@ module Google # @return [String] attr_accessor :url - # Optional. Specifies the type of viewer that is used when opening - # the URL. Defaults to opening via web browser. + # Optional. Specifies the type of viewer that is used when opening the URL. + # Defaults to opening via web browser. # Corresponds to the JSON property `urlTypeHint` # @return [String] attr_accessor :url_type_hint @@ -5382,8 +5124,7 @@ module Google class GoogleCloudDialogflowV2beta1IntentMessageCardButton include Google::Apis::Core::Hashable - # Optional. The text to send back to the Dialogflow API or a URI to - # open. + # Optional. The text to send back to the Dialogflow API or a URI to open. # Corresponds to the JSON property `postback` # @return [String] attr_accessor :postback @@ -5437,8 +5178,7 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageImage] attr_accessor :image - # Additional info about the select item for when it is triggered in a - # dialog. + # Additional info about the select item for when it is triggered in a dialog. # Corresponds to the JSON property `info` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo] attr_accessor :info @@ -5490,8 +5230,8 @@ module Google class GoogleCloudDialogflowV2beta1IntentMessageImage include Google::Apis::Core::Hashable - # A text description of the image to be used for accessibility, - # e.g., screen readers. Required if image_uri is set for CarouselSelect. + # A text description of the image to be used for accessibility, e.g., screen + # readers. Required if image_uri is set for CarouselSelect. # Corresponds to the JSON property `accessibilityText` # @return [String] attr_accessor :accessibility_text @@ -5512,8 +5252,8 @@ module Google end end - # The suggestion chip message that allows the user to jump out to the app - # or website associated with this agent. + # The suggestion chip message that allows the user to jump out to the app or + # website associated with this agent. class GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion include Google::Apis::Core::Hashable @@ -5522,8 +5262,8 @@ module Google # @return [String] attr_accessor :destination_name - # Required. The URI of the app or site to open when the user taps the - # suggestion chip. + # Required. The URI of the app or site to open when the user taps the suggestion + # chip. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -5584,8 +5324,7 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageImage] attr_accessor :image - # Additional info about the select item for when it is triggered in a - # dialog. + # Additional info about the select item for when it is triggered in a dialog. # Corresponds to the JSON property `info` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo] attr_accessor :info @@ -5705,26 +5444,16 @@ module Google class GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent include Google::Apis::Core::Hashable - # Optional. Description of the card (at most 2000 bytes). - # At least one of the title, description or media must be set. + # Optional. Description of the card (at most 2000 bytes). At least one of the + # title, description or media must be set. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Rich Business Messaging (RBM) Media displayed in Cards - # The following media-types are currently supported: - # Image Types - # * image/jpeg - # * image/jpg' - # * image/gif - # * image/png - # Video Types - # * video/h263 - # * video/m4v - # * video/mp4 - # * video/mpeg - # * video/mpeg4 - # * video/webm + # Rich Business Messaging (RBM) Media displayed in Cards The following media- + # types are currently supported: Image Types * image/jpeg * image/jpg' * image/ + # gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * + # video/mpeg4 * video/webm # Corresponds to the JSON property `media` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia] attr_accessor :media @@ -5734,8 +5463,8 @@ module Google # @return [Array] attr_accessor :suggestions - # Optional. Title of the card (at most 200 bytes). - # At least one of the title, description or media must be set. + # Optional. Title of the card (at most 200 bytes). At least one of the title, + # description or media must be set. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -5753,44 +5482,33 @@ module Google end end - # Rich Business Messaging (RBM) Media displayed in Cards - # The following media-types are currently supported: - # Image Types - # * image/jpeg - # * image/jpg' - # * image/gif - # * image/png - # Video Types - # * video/h263 - # * video/m4v - # * video/mp4 - # * video/mpeg - # * video/mpeg4 - # * video/webm + # Rich Business Messaging (RBM) Media displayed in Cards The following media- + # types are currently supported: Image Types * image/jpeg * image/jpg' * image/ + # gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * + # video/mpeg4 * video/webm class GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia include Google::Apis::Core::Hashable - # Required. Publicly reachable URI of the file. The RBM platform - # determines the MIME type of the file from the content-type field in - # the HTTP headers when the platform fetches the file. The content-type - # field must be present and accurate in the HTTP response from the URL. + # Required. Publicly reachable URI of the file. The RBM platform determines the + # MIME type of the file from the content-type field in the HTTP headers when the + # platform fetches the file. The content-type field must be present and accurate + # in the HTTP response from the URL. # Corresponds to the JSON property `fileUri` # @return [String] attr_accessor :file_uri - # Required for cards with vertical orientation. The height of the media - # within a rich card with a vertical layout. - # For a standalone card with horizontal layout, height is not - # customizable, and this field is ignored. + # Required for cards with vertical orientation. The height of the media within a + # rich card with a vertical layout. For a standalone card with horizontal layout, + # height is not customizable, and this field is ignored. # Corresponds to the JSON property `height` # @return [String] attr_accessor :height - # Optional. Publicly reachable URI of the thumbnail.If you don't - # provide a thumbnail URI, the RBM platform displays a blank - # placeholder thumbnail until the user's device downloads the file. - # Depending on the user's setting, the file may not download - # automatically and may require the user to tap a download button. + # Optional. Publicly reachable URI of the thumbnail.If you don't provide a + # thumbnail URI, the RBM platform displays a blank placeholder thumbnail until + # the user's device downloads the file. Depending on the user's setting, the + # file may not download automatically and may require the user to tap a download + # button. # Corresponds to the JSON property `thumbnailUri` # @return [String] attr_accessor :thumbnail_uri @@ -5807,16 +5525,15 @@ module Google end end - # Carousel Rich Business Messaging (RBM) rich card. - # Rich cards allow you to respond to users with more vivid content, e.g. - # with media and suggestions. - # If you want to show a single card with more control over the layout, - # please use RbmStandaloneCard instead. + # Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to + # respond to users with more vivid content, e.g. with media and suggestions. If + # you want to show a single card with more control over the layout, please use + # RbmStandaloneCard instead. class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard include Google::Apis::Core::Hashable - # Required. The cards in the carousel. A carousel must have at least - # 2 cards and at most 10. + # Required. The cards in the carousel. A carousel must have at least 2 cards and + # at most 10. # Corresponds to the JSON property `cardContents` # @return [Array] attr_accessor :card_contents @@ -5837,11 +5554,10 @@ module Google end end - # Standalone Rich Business Messaging (RBM) rich card. - # Rich cards allow you to respond to users with more vivid content, e.g. - # with media and suggestions. - # You can group multiple rich cards into one using RbmCarouselCard but - # carousel cards will give you less control over the card layout. + # Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to + # respond to users with more vivid content, e.g. with media and suggestions. You + # can group multiple rich cards into one using RbmCarouselCard but carousel + # cards will give you less control over the card layout. class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard include Google::Apis::Core::Hashable @@ -5855,8 +5571,8 @@ module Google # @return [String] attr_accessor :card_orientation - # Required if orientation is horizontal. - # Image preview alignment for standalone cards with horizontal layout. + # Required if orientation is horizontal. Image preview alignment for standalone + # cards with horizontal layout. # Corresponds to the JSON property `thumbnailImageAlignment` # @return [String] attr_accessor :thumbnail_image_alignment @@ -5873,34 +5589,34 @@ module Google end end - # Rich Business Messaging (RBM) suggested client-side action that the user - # can choose from the card. + # Rich Business Messaging (RBM) suggested client-side action that the user can + # choose from the card. class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction include Google::Apis::Core::Hashable - # Opens the user's default dialer app with the specified phone number - # but does not dial automatically. + # Opens the user's default dialer app with the specified phone number but does + # not dial automatically. # Corresponds to the JSON property `dial` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial] attr_accessor :dial - # Opens the user's default web browser app to the specified uri - # If the user has an app installed that is - # registered as the default handler for the URL, then this app will be - # opened instead, and its icon will be used in the suggested action UI. + # Opens the user's default web browser app to the specified uri If the user has + # an app installed that is registered as the default handler for the URL, then + # this app will be opened instead, and its icon will be used in the suggested + # action UI. # Corresponds to the JSON property `openUrl` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri] attr_accessor :open_url - # Opaque payload that the Dialogflow receives in a user event - # when the user taps the suggested action. This data will be also - # forwarded to webhook to allow performing custom business logic. + # Opaque payload that the Dialogflow receives in a user event when the user taps + # the suggested action. This data will be also forwarded to webhook to allow + # performing custom business logic. # Corresponds to the JSON property `postbackData` # @return [String] attr_accessor :postback_data - # Opens the device's location chooser so the user can pick a location - # to send back to the agent. + # Opens the device's location chooser so the user can pick a location to send + # back to the agent. # Corresponds to the JSON property `shareLocation` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation] attr_accessor :share_location @@ -5924,15 +5640,14 @@ module Google end end - # Opens the user's default dialer app with the specified phone number - # but does not dial automatically. + # Opens the user's default dialer app with the specified phone number but does + # not dial automatically. class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial include Google::Apis::Core::Hashable - # Required. The phone number to fill in the default dialer app. - # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) - # format. An example of a correctly formatted phone number: - # +15556767888. + # Required. The phone number to fill in the default dialer app. This field + # should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example + # of a correctly formatted phone number: +15556767888. # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number @@ -5947,10 +5662,10 @@ module Google end end - # Opens the user's default web browser app to the specified uri - # If the user has an app installed that is - # registered as the default handler for the URL, then this app will be - # opened instead, and its icon will be used in the suggested action UI. + # Opens the user's default web browser app to the specified uri If the user has + # an app installed that is registered as the default handler for the URL, then + # this app will be opened instead, and its icon will be used in the suggested + # action UI. class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri include Google::Apis::Core::Hashable @@ -5969,8 +5684,8 @@ module Google end end - # Opens the device's location chooser so the user can pick a location - # to send back to the agent. + # Opens the device's location chooser so the user can pick a location to send + # back to the agent. class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation include Google::Apis::Core::Hashable @@ -5983,14 +5698,14 @@ module Google end end - # Rich Business Messaging (RBM) suggested reply that the user can click - # instead of typing in their own response. + # Rich Business Messaging (RBM) suggested reply that the user can click instead + # of typing in their own response. class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply include Google::Apis::Core::Hashable - # Opaque payload that the Dialogflow receives in a user event - # when the user taps the suggested reply. This data will be also - # forwarded to webhook to allow performing custom business logic. + # Opaque payload that the Dialogflow receives in a user event when the user taps + # the suggested reply. This data will be also forwarded to webhook to allow + # performing custom business logic. # Corresponds to the JSON property `postbackData` # @return [String] attr_accessor :postback_data @@ -6011,20 +5726,20 @@ module Google end end - # Rich Business Messaging (RBM) suggestion. Suggestions allow user to - # easily select/click a predefined response or perform an action (like - # opening a web uri). + # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily + # select/click a predefined response or perform an action (like opening a web + # uri). class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion include Google::Apis::Core::Hashable - # Rich Business Messaging (RBM) suggested client-side action that the user - # can choose from the card. + # Rich Business Messaging (RBM) suggested client-side action that the user can + # choose from the card. # Corresponds to the JSON property `action` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction] attr_accessor :action - # Rich Business Messaging (RBM) suggested reply that the user can click - # instead of typing in their own response. + # Rich Business Messaging (RBM) suggested reply that the user can click instead + # of typing in their own response. # Corresponds to the JSON property `reply` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply] attr_accessor :reply @@ -6065,19 +5780,18 @@ module Google end end - # Additional info about the select item for when it is triggered in a - # dialog. + # Additional info about the select item for when it is triggered in a dialog. class GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo include Google::Apis::Core::Hashable - # Required. A unique key that will be sent back to the agent if this - # response is given. + # Required. A unique key that will be sent back to the agent if this response is + # given. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key - # Optional. A list of synonyms that can also be used to trigger this - # item in dialog. + # Optional. A list of synonyms that can also be used to trigger this item in + # dialog. # Corresponds to the JSON property `synonyms` # @return [Array] attr_accessor :synonyms @@ -6102,15 +5816,14 @@ module Google # @return [String] attr_accessor :display_text - # One of text_to_speech or ssml must be provided. Structured spoken - # response to the user in the SSML format. Mutually exclusive with - # text_to_speech. + # One of text_to_speech or ssml must be provided. Structured spoken response to + # the user in the SSML format. Mutually exclusive with text_to_speech. # Corresponds to the JSON property `ssml` # @return [String] attr_accessor :ssml - # One of text_to_speech or ssml must be provided. The plain text of the - # speech output. Mutually exclusive with ssml. + # One of text_to_speech or ssml must be provided. The plain text of the speech + # output. Mutually exclusive with ssml. # Corresponds to the JSON property `textToSpeech` # @return [String] attr_accessor :text_to_speech @@ -6127,10 +5840,9 @@ module Google end end - # The collection of simple response candidates. - # This message in `QueryResult.fulfillment_messages` and - # `WebhookResponse.fulfillment_messages` should contain only one - # `SimpleResponse`. + # The collection of simple response candidates. This message in `QueryResult. + # fulfillment_messages` and `WebhookResponse.fulfillment_messages` should + # contain only one `SimpleResponse`. class GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses include Google::Apis::Core::Hashable @@ -6149,8 +5861,8 @@ module Google end end - # The suggestion chip message that the user can tap to quickly post a reply - # to the conversation. + # The suggestion chip message that the user can tap to quickly post a reply to + # the conversation. class GoogleCloudDialogflowV2beta1IntentMessageSuggestion include Google::Apis::Core::Hashable @@ -6286,17 +5998,15 @@ module Google class GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio include Google::Apis::Core::Hashable - # Required. URI to a Google Cloud Storage object containing the audio to - # play, e.g., "gs://bucket/object". The object must contain a single - # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. - # This object must be readable by the `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account - # where is the number of the Telephony Gateway project - # (usually the same as the Dialogflow agent project). If the Google Cloud - # Storage bucket is in the Telephony Gateway project, this permission is - # added by default when enabling the Dialogflow V2 API. - # For audio from other sources, consider using the - # `TelephonySynthesizeSpeech` message with SSML. + # Required. URI to a Google Cloud Storage object containing the audio to play, e. + # g., "gs://bucket/object". The object must contain a single channel (mono) of + # linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by + # the `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where + # is the number of the Telephony Gateway project (usually the same as the + # Dialogflow agent project). If the Google Cloud Storage bucket is in the + # Telephony Gateway project, this permission is added by default when enabling + # the Dialogflow V2 API. For audio from other sources, consider using the ` + # TelephonySynthesizeSpeech` message with SSML. # Corresponds to the JSON property `audioUri` # @return [String] attr_accessor :audio_uri @@ -6312,15 +6022,14 @@ module Google end # Synthesizes speech and plays back the synthesized audio to the caller in - # Telephony Gateway. - # Telephony Gateway takes the synthesizer settings from - # `DetectIntentResponse.output_audio_config` which can either be set - # at request-level or can come from the agent-level synthesizer config. + # Telephony Gateway. Telephony Gateway takes the synthesizer settings from ` + # DetectIntentResponse.output_audio_config` which can either be set at request- + # level or can come from the agent-level synthesizer config. class GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech include Google::Apis::Core::Hashable - # The SSML to be synthesized. For more information, see - # [SSML](https://developers.google.com/actions/reference/ssml). + # The SSML to be synthesized. For more information, see [SSML](https:// + # developers.google.com/actions/reference/ssml). # Corresponds to the JSON property `ssml` # @return [String] attr_accessor :ssml @@ -6345,9 +6054,9 @@ module Google class GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall include Google::Apis::Core::Hashable - # Required. The phone number to transfer the call to - # in [E.164 format](https://en.wikipedia.org/wiki/E.164). - # We currently only allow transferring to US numbers (+1xxxyyyzzzz). + # Required. The phone number to transfer the call to in [E.164 format](https:// + # en.wikipedia.org/wiki/E.164). We currently only allow transferring to US + # numbers (+1xxxyyyzzzz). # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number @@ -6385,10 +6094,9 @@ module Google class GoogleCloudDialogflowV2beta1IntentParameter include Google::Apis::Core::Hashable - # Optional. The default value to use when the `value` yields an empty - # result. - # Default values can be extracted from contexts by using the following - # syntax: `#context_name.parameter_name`. + # Optional. The default value to use when the `value` yields an empty result. + # Default values can be extracted from contexts by using the following syntax: `# + # context_name.parameter_name`. # Corresponds to the JSON property `defaultValue` # @return [String] attr_accessor :default_value @@ -6398,9 +6106,8 @@ module Google # @return [String] attr_accessor :display_name - # Optional. The name of the entity type, prefixed with `@`, that - # describes values of the parameter. If the parameter is - # required, this must be provided. + # Optional. The name of the entity type, prefixed with `@`, that describes + # values of the parameter. If the parameter is required, this must be provided. # Corresponds to the JSON property `entityTypeDisplayName` # @return [String] attr_accessor :entity_type_display_name @@ -6411,9 +6118,8 @@ module Google attr_accessor :is_list alias_method :is_list?, :is_list - # Optional. Indicates whether the parameter is required. That is, - # whether the intent cannot be completed without collecting the parameter - # value. + # Optional. Indicates whether the parameter is required. That is, whether the + # intent cannot be completed without collecting the parameter value. # Corresponds to the JSON property `mandatory` # @return [Boolean] attr_accessor :mandatory @@ -6424,18 +6130,16 @@ module Google # @return [String] attr_accessor :name - # Optional. The collection of prompts that the agent can present to the - # user in order to collect a value for the parameter. + # Optional. The collection of prompts that the agent can present to the user in + # order to collect a value for the parameter. # Corresponds to the JSON property `prompts` # @return [Array] attr_accessor :prompts - # Optional. The definition of the parameter value. It can be: - # - a constant string, - # - a parameter value defined as `$parameter_name`, - # - an original parameter value defined as `$parameter_name.original`, - # - a parameter value from some context defined as - # `#context_name.parameter_name`. + # Optional. The definition of the parameter value. It can be: - a constant + # string, - a parameter value defined as `$parameter_name`, - an original + # parameter value defined as `$parameter_name.original`, - a parameter value + # from some context defined as `#context_name.parameter_name`. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -6466,27 +6170,25 @@ module Google # @return [String] attr_accessor :name - # Required. The ordered list of training phrase parts. - # The parts are concatenated in order to form the training phrase. - # Note: The API does not automatically annotate training phrases like the - # Dialogflow Console does. - # Note: Do not forget to include whitespace at part boundaries, - # so the training phrase is well formatted when the parts are concatenated. - # If the training phrase does not need to be annotated with parameters, - # you just need a single part with only the Part.text field set. - # If you want to annotate the training phrase, you must create multiple - # parts, where the fields of each part are populated in one of two ways: - # - `Part.text` is set to a part of the phrase that has no parameters. - # - `Part.text` is set to a part of the phrase that you want to annotate, - # and the `entity_type`, `alias`, and `user_defined` fields are all - # set. + # Required. The ordered list of training phrase parts. The parts are + # concatenated in order to form the training phrase. Note: The API does not + # automatically annotate training phrases like the Dialogflow Console does. Note: + # Do not forget to include whitespace at part boundaries, so the training + # phrase is well formatted when the parts are concatenated. If the training + # phrase does not need to be annotated with parameters, you just need a single + # part with only the Part.text field set. If you want to annotate the training + # phrase, you must create multiple parts, where the fields of each part are + # populated in one of two ways: - `Part.text` is set to a part of the phrase + # that has no parameters. - `Part.text` is set to a part of the phrase that you + # want to annotate, and the `entity_type`, `alias`, and `user_defined` fields + # are all set. # Corresponds to the JSON property `parts` # @return [Array] attr_accessor :parts - # Optional. Indicates how many times this example was added to - # the intent. Each time a developer adds an existing sample by editing an - # intent or training, this counter is increased. + # Optional. Indicates how many times this example was added to the intent. Each + # time a developer adds an existing sample by editing an intent or training, + # this counter is increased. # Corresponds to the JSON property `timesAddedCount` # @return [Fixnum] attr_accessor :times_added_count @@ -6513,15 +6215,15 @@ module Google class GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart include Google::Apis::Core::Hashable - # Optional. The parameter name for the value extracted from the - # annotated part of the example. - # This field is required for annotated parts of the training phrase. + # Optional. The parameter name for the value extracted from the annotated part + # of the example. This field is required for annotated parts of the training + # phrase. # Corresponds to the JSON property `alias` # @return [String] attr_accessor :alias - # Optional. The entity type name prefixed with `@`. - # This field is required for annotated parts of the training phrase. + # Optional. The entity type name prefixed with `@`. This field is required for + # annotated parts of the training phrase. # Corresponds to the JSON property `entityType` # @return [String] attr_accessor :entity_type @@ -6531,10 +6233,9 @@ module Google # @return [String] attr_accessor :text - # Optional. Indicates whether the text was manually annotated. - # This field is set to true when the Dialogflow Console is used to - # manually annotate the part. When creating an annotated part with the - # API, you must set this to true. + # Optional. Indicates whether the text was manually annotated. This field is set + # to true when the Dialogflow Console is used to manually annotate the part. + # When creating an annotated part with the API, you must set this to true. # Corresponds to the JSON property `userDefined` # @return [Boolean] attr_accessor :user_defined @@ -6576,43 +6277,39 @@ module Google class GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer include Google::Apis::Core::Hashable - # The piece of text from the `source` knowledge base document that answers - # this conversational query. + # The piece of text from the `source` knowledge base document that answers this + # conversational query. # Corresponds to the JSON property `answer` # @return [String] attr_accessor :answer - # The corresponding FAQ question if the answer was extracted from a FAQ - # Document, empty otherwise. + # The corresponding FAQ question if the answer was extracted from a FAQ Document, + # empty otherwise. # Corresponds to the JSON property `faqQuestion` # @return [String] attr_accessor :faq_question - # The system's confidence score that this Knowledge answer is a good match - # for this conversational query. - # The range is from 0.0 (completely uncertain) to 1.0 (completely certain). - # Note: The confidence score is likely to vary somewhat (possibly even for - # identical requests), as the underlying model is under constant - # improvement. It may be deprecated in the future. We recommend using - # `match_confidence_level` which should be generally more stable. + # The system's confidence score that this Knowledge answer is a good match for + # this conversational query. The range is from 0.0 (completely uncertain) to 1.0 + # (completely certain). Note: The confidence score is likely to vary somewhat ( + # possibly even for identical requests), as the underlying model is under + # constant improvement. It may be deprecated in the future. We recommend using ` + # match_confidence_level` which should be generally more stable. # Corresponds to the JSON property `matchConfidence` # @return [Float] attr_accessor :match_confidence - # The system's confidence level that this knowledge answer is a good match - # for this conversational query. - # NOTE: The confidence level for a given `` pair may change - # without notice, as it depends on models that are constantly being - # improved. However, it will change less frequently than the confidence - # score below, and should be preferred for referencing the quality of an - # answer. + # The system's confidence level that this knowledge answer is a good match for + # this conversational query. NOTE: The confidence level for a given `` pair may + # change without notice, as it depends on models that are constantly being + # improved. However, it will change less frequently than the confidence score + # below, and should be preferred for referencing the quality of an answer. # Corresponds to the JSON property `matchConfidenceLevel` # @return [String] attr_accessor :match_confidence_level - # Indicates which Knowledge Document this answer was extracted from. - # Format: `projects//knowledgeBases//documents/`. + # Indicates which Knowledge Document this answer was extracted from. Format: ` + # projects//knowledgeBases//documents/`. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source @@ -6650,16 +6347,14 @@ module Google end end - # The response for - # ConversationDatasets.LabelConversation. + # The response for ConversationDatasets.LabelConversation. class GoogleCloudDialogflowV2beta1LabelConversationResponse include Google::Apis::Core::Hashable - # Represents an annotated conversation dataset. - # ConversationDataset can have multiple AnnotatedConversationDataset, each of - # them represents one result from one annotation task. - # AnnotatedConversationDataset can only be generated from annotation task, - # which will be triggered by LabelConversation. + # Represents an annotated conversation dataset. ConversationDataset can have + # multiple AnnotatedConversationDataset, each of them represents one result from + # one annotation task. AnnotatedConversationDataset can only be generated from + # annotation task, which will be triggered by LabelConversation. # Corresponds to the JSON property `annotatedConversationDataset` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1AnnotatedConversationDataset] attr_accessor :annotated_conversation_dataset @@ -6674,36 +6369,30 @@ module Google end end - # Represents the contents of the original request that was passed to - # the `[Streaming]DetectIntent` call. + # Represents the contents of the original request that was passed to the `[ + # Streaming]DetectIntent` call. class GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest include Google::Apis::Core::Hashable # Optional. This field is set to the value of the `QueryParameters.payload` - # field passed in the request. Some integrations that query a Dialogflow - # agent may provide additional information in the payload. - # In particular, for the Dialogflow Phone Gateway integration, this field has - # the form: - # 
`
-        # "telephony": `
-        # "caller_id": "+18558363987"
-        # `
-        # `
- # Note: The caller ID field (`caller_id`) will be redacted for Standard - # Edition agents and populated with the caller ID in [E.164 - # format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. + # field passed in the request. Some integrations that query a Dialogflow agent + # may provide additional information in the payload. In particular, for the + # Dialogflow Phone Gateway integration, this field has the form: ` "telephony": ` + # "caller_id": "+18558363987" ` ` Note: The caller ID field (`caller_id`) will + # be redacted for Standard Edition agents and populated with the caller ID in [E. + # 164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload - # The source of this request, e.g., `google`, `facebook`, `slack`. It is set - # by Dialogflow-owned servers. + # The source of this request, e.g., `google`, `facebook`, `slack`. It is set by + # Dialogflow-owned servers. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source - # Optional. The version of the protocol used for this request. - # This field is AoG-specific. + # Optional. The version of the protocol used for this request. This field is AoG- + # specific. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -6729,22 +6418,19 @@ module Google # @return [String] attr_accessor :action - # This field is set to: - # - `false` if the matched intent has required parameters and not all of - # the required parameter values have been collected. - # - `true` if all required parameter values have been collected, or if the - # matched intent doesn't contain any required parameters. + # This field is set to: - `false` if the matched intent has required parameters + # and not all of the required parameter values have been collected. - `true` if + # all required parameter values have been collected, or if the matched intent + # doesn't contain any required parameters. # Corresponds to the JSON property `allRequiredParamsPresent` # @return [Boolean] attr_accessor :all_required_params_present alias_method :all_required_params_present?, :all_required_params_present - # Free-form diagnostic information for the associated detect intent request. - # The fields of this data can change without notice, so you should not write - # code that depends on its structure. - # The data may contain: - # - webhook call latency - # - webhook errors + # Free-form diagnostic information for the associated detect intent request. The + # fields of this data can change without notice, so you should not write code + # that depends on its structure. The data may contain: - webhook call latency - + # webhook errors # Corresponds to the JSON property `diagnosticInfo` # @return [Hash] attr_accessor :diagnostic_info @@ -6754,8 +6440,8 @@ module Google # @return [Array] attr_accessor :fulfillment_messages - # The text to be pronounced to the user or shown on the screen. - # Note: This is a legacy field, `fulfillment_messages` should be preferred. + # The text to be pronounced to the user or shown on the screen. Note: This is a + # legacy field, `fulfillment_messages` should be preferred. # Corresponds to the JSON property `fulfillmentText` # @return [String] attr_accessor :fulfillment_text @@ -6765,21 +6451,19 @@ module Google # complete conversation. When an end-user writes or says something, referred to # as an end-user expression or end-user input, Dialogflow matches the end-user # input to the best intent in your agent. Matching an intent is also known as - # intent classification. - # For more information, see the [intent - # guide](https://cloud.google.com/dialogflow/docs/intents-overview). + # intent classification. For more information, see the [intent guide](https:// + # cloud.google.com/dialogflow/docs/intents-overview). # Corresponds to the JSON property `intent` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1Intent] attr_accessor :intent - # The intent detection confidence. Values range from 0.0 - # (completely uncertain) to 1.0 (completely certain). - # This value is for informational purpose only and is only used to - # help match the best intent within the classification threshold. + # The intent detection confidence. Values range from 0.0 (completely uncertain) + # to 1.0 (completely certain). This value is for informational purpose only and + # is only used to help match the best intent within the classification threshold. # This value may change for the same end-user expression at any time due to a - # model retraining or change in implementation. - # If there are `multiple knowledge_answers` messages, this value is set to - # the greatest `knowledgeAnswers.match_confidence` value in the list. + # model retraining or change in implementation. If there are `multiple + # knowledge_answers` messages, this value is set to the greatest ` + # knowledgeAnswers.match_confidence` value in the list. # Corresponds to the JSON property `intentDetectionConfidence` # @return [Float] attr_accessor :intent_detection_confidence @@ -6789,60 +6473,49 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1KnowledgeAnswers] attr_accessor :knowledge_answers - # The language that was triggered during intent detection. - # See [Language - # Support](https://cloud.google.com/dialogflow/docs/reference/language) - # for a list of the currently supported language codes. + # The language that was triggered during intent detection. See [Language Support] + # (https://cloud.google.com/dialogflow/docs/reference/language) for a list of + # the currently supported language codes. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # The collection of output contexts. If applicable, - # `output_contexts.parameters` contains entries with name - # `.original` containing the original parameter values - # before the query. + # The collection of output contexts. If applicable, `output_contexts.parameters` + # contains entries with name `.original` containing the original parameter + # values before the query. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts - # The collection of extracted parameters. - # Depending on your protocol or client library language, this is a - # map, associative array, symbol table, dictionary, or JSON object - # composed of a collection of (MapKey, MapValue) pairs: - # - MapKey type: string - # - MapKey value: parameter name - # - MapValue type: - # - If parameter's entity type is a composite entity: map - # - Else: string or number, depending on parameter value type - # - MapValue value: - # - If parameter's entity type is a composite entity: - # map from composite entity property names to property values - # - Else: parameter value + # The collection of extracted parameters. Depending on your protocol or client + # library language, this is a map, associative array, symbol table, dictionary, + # or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey + # type: string - MapKey value: parameter name - MapValue type: - If parameter's + # entity type is a composite entity: map - Else: string or number, depending on + # parameter value type - MapValue value: - If parameter's entity type is a + # composite entity: map from composite entity property names to property values - + # Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters - # The original conversational query text: - # - If natural language text was provided as input, `query_text` contains - # a copy of the input. - # - If natural language speech audio was provided as input, `query_text` - # contains the speech recognition result. If speech recognizer produced - # multiple alternatives, a particular one is picked. - # - If automatic spell correction is enabled, `query_text` will contain the - # corrected user input. + # The original conversational query text: - If natural language text was + # provided as input, `query_text` contains a copy of the input. - If natural + # language speech audio was provided as input, `query_text` contains the speech + # recognition result. If speech recognizer produced multiple alternatives, a + # particular one is picked. - If automatic spell correction is enabled, ` + # query_text` will contain the corrected user input. # Corresponds to the JSON property `queryText` # @return [String] attr_accessor :query_text - # The result of sentiment analysis. Sentiment analysis inspects user input - # and identifies the prevailing subjective opinion, especially to determine a - # user's attitude as positive, negative, or neutral. - # For Participants.AnalyzeContent, it needs to be configured in - # DetectIntentRequest.query_params. For - # Participants.StreamingAnalyzeContent, it needs to be configured in - # StreamingDetectIntentRequest.query_params. - # And for Participants.AnalyzeContent and + # The result of sentiment analysis. Sentiment analysis inspects user input and + # identifies the prevailing subjective opinion, especially to determine a user's + # attitude as positive, negative, or neutral. For Participants.AnalyzeContent, + # it needs to be configured in DetectIntentRequest.query_params. For # Participants.StreamingAnalyzeContent, it needs to be configured in + # StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent + # and Participants.StreamingAnalyzeContent, it needs to be configured in # ConversationProfile.human_agent_assistant_config # Corresponds to the JSON property `sentimentAnalysisResult` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1SentimentAnalysisResult] @@ -6850,24 +6523,23 @@ module Google # The Speech recognition confidence between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. The default of 0.0 is a sentinel value indicating that confidence - # was not set. - # This field is not guaranteed to be accurate or set. In particular this - # field isn't set for StreamingDetectIntent since the streaming endpoint has - # separate confidence estimates per portion of the audio in + # correct. The default of 0.0 is a sentinel value indicating that confidence was + # not set. This field is not guaranteed to be accurate or set. In particular + # this field isn't set for StreamingDetectIntent since the streaming endpoint + # has separate confidence estimates per portion of the audio in # StreamingRecognitionResult. # Corresponds to the JSON property `speechRecognitionConfidence` # @return [Float] attr_accessor :speech_recognition_confidence - # If the query was fulfilled by a webhook call, this field is set to the - # value of the `payload` field returned in the webhook response. + # If the query was fulfilled by a webhook call, this field is set to the value + # of the `payload` field returned in the webhook response. # Corresponds to the JSON property `webhookPayload` # @return [Hash] attr_accessor :webhook_payload - # If the query was fulfilled by a webhook call, this field is set to the - # value of the `source` field returned in the webhook response. + # If the query was fulfilled by a webhook call, this field is set to the value + # of the `source` field returned in the webhook response. # Corresponds to the JSON property `webhookSource` # @return [String] attr_accessor :webhook_source @@ -6897,8 +6569,8 @@ module Google end end - # The sentiment, such as positive/negative feeling or association, for a unit - # of analysis, such as the query text. + # The sentiment, such as positive/negative feeling or association, for a unit of + # analysis, such as the query text. class GoogleCloudDialogflowV2beta1Sentiment include Google::Apis::Core::Hashable @@ -6908,8 +6580,7 @@ module Google # @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 @@ -6925,21 +6596,19 @@ module Google end end - # The result of sentiment analysis. Sentiment analysis inspects user input - # and identifies the prevailing subjective opinion, especially to determine a - # user's attitude as positive, negative, or neutral. - # For Participants.AnalyzeContent, it needs to be configured in - # DetectIntentRequest.query_params. For - # Participants.StreamingAnalyzeContent, it needs to be configured in - # StreamingDetectIntentRequest.query_params. - # And for Participants.AnalyzeContent and + # The result of sentiment analysis. Sentiment analysis inspects user input and + # identifies the prevailing subjective opinion, especially to determine a user's + # attitude as positive, negative, or neutral. For Participants.AnalyzeContent, + # it needs to be configured in DetectIntentRequest.query_params. For # Participants.StreamingAnalyzeContent, it needs to be configured in + # StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent + # and Participants.StreamingAnalyzeContent, it needs to be configured in # ConversationProfile.human_agent_assistant_config class GoogleCloudDialogflowV2beta1SentimentAnalysisResult include Google::Apis::Core::Hashable - # The sentiment, such as positive/negative feeling or association, for a unit - # of analysis, such as the query text. + # The sentiment, such as positive/negative feeling or association, for a unit of + # analysis, such as the query text. # Corresponds to the JSON property `queryTextSentiment` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1Sentiment] attr_accessor :query_text_sentiment @@ -6954,37 +6623,33 @@ module Google end end - # A session represents a conversation between a Dialogflow agent and an - # end-user. You can create special entities, called session entities, during a - # session. Session entities can extend or replace custom entity types and only - # exist during the session that they were created for. All session data, - # including session entities, is stored by Dialogflow for 20 minutes. - # For more information, see the [session entity - # guide](https://cloud.google.com/dialogflow/docs/entities-session). + # A session represents a conversation between a Dialogflow agent and an end-user. + # You can create special entities, called session entities, during a session. + # Session entities can extend or replace custom entity types and only exist + # during the session that they were created for. All session data, including + # session entities, is stored by Dialogflow for 20 minutes. For more information, + # see the [session entity guide](https://cloud.google.com/dialogflow/docs/ + # entities-session). class GoogleCloudDialogflowV2beta1SessionEntityType include Google::Apis::Core::Hashable - # Required. The collection of entities associated with this session entity - # type. + # Required. The collection of entities associated with this session entity type. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities - # Required. Indicates whether the additional data should override or - # supplement the custom entity type definition. + # Required. Indicates whether the additional data should override or supplement + # the custom entity type definition. # Corresponds to the JSON property `entityOverrideMode` # @return [String] attr_accessor :entity_override_mode - # Required. The unique identifier of this session entity type. Format: - # `projects//agent/sessions//entityTypes/`, or - # `projects//agent/environments//users//sessions//entityTypes/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # `` must be the display name of an existing entity - # type in the same agent that will be overridden or supplemented. + # Required. The unique identifier of this session entity type. Format: `projects/ + # /agent/sessions//entityTypes/`, or `projects//agent/environments//users// + # sessions//entityTypes/`. If `Environment ID` is not specified, we assume + # default 'draft' environment. If `User ID` is not specified, we assume default ' + # -' user. `` must be the display name of an existing entity type in the same + # agent that will be overridden or supplemented. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -7010,8 +6675,8 @@ module Google # @return [Array] attr_accessor :alternative_query_results - # Represents the contents of the original request that was passed to - # the `[Streaming]DetectIntent` call. + # Represents the contents of the original request that was passed to the `[ + # Streaming]DetectIntent` call. # Corresponds to the JSON property `originalDetectIntentRequest` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest] attr_accessor :original_detect_intent_request @@ -7021,17 +6686,15 @@ module Google # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1QueryResult] attr_accessor :query_result - # The unique identifier of the response. Contains the same value as - # `[Streaming]DetectIntentResponse.response_id`. + # The unique identifier of the response. Contains the same value as `[Streaming] + # DetectIntentResponse.response_id`. # Corresponds to the JSON property `responseId` # @return [String] attr_accessor :response_id - # The unique identifier of detectIntent request session. - # Can be used to identify end-user inside webhook implementation. - # Format: `projects//agent/sessions/`, or - # `projects//agent/environments//users//sessions/`. + # The unique identifier of detectIntent request session. Can be used to identify + # end-user inside webhook implementation. Format: `projects//agent/sessions/`, + # or `projects//agent/environments//users//sessions/`. # Corresponds to the JSON property `session` # @return [String] attr_accessor :session @@ -7050,87 +6713,78 @@ module Google end end - # The response message for a webhook call. - # This response is validated by the Dialogflow server. If validation fails, - # an error will be returned in the QueryResult.diagnostic_info field. - # Setting JSON fields to an empty value with the wrong type is a common error. - # To avoid this error: - # - Use `""` for empty strings - # - Use ```` or `null` for empty objects - # - Use `[]` or `null` for empty arrays - # For more information, see the - # [Protocol Buffers Language - # Guide](https://developers.google.com/protocol-buffers/docs/proto3#json). + # The response message for a webhook call. This response is validated by the + # Dialogflow server. If validation fails, an error will be returned in the + # QueryResult.diagnostic_info field. Setting JSON fields to an empty value with + # the wrong type is a common error. To avoid this error: - Use `""` for empty + # strings - Use ```` or `null` for empty objects - Use `[]` or `null` for empty + # arrays For more information, see the [Protocol Buffers Language Guide](https:// + # developers.google.com/protocol-buffers/docs/proto3#json). class GoogleCloudDialogflowV2beta1WebhookResponse include Google::Apis::Core::Hashable - # Optional. Indicates that this intent ends an interaction. Some integrations - # (e.g., Actions on Google or Dialogflow phone gateway) use this information - # to close interaction with an end user. Default is false. + # Optional. Indicates that this intent ends an interaction. Some integrations (e. + # g., Actions on Google or Dialogflow phone gateway) use this information to + # close interaction with an end user. Default is false. # Corresponds to the JSON property `endInteraction` # @return [Boolean] attr_accessor :end_interaction alias_method :end_interaction?, :end_interaction # Events allow for matching intents by event name instead of the natural - # language input. For instance, input `` can trigger a personalized welcome response. - # The parameter `name` may be used by the agent in the response: - # `"Hello #welcome_event.name! What can I do for you today?"`. + # language input. For instance, input `` can trigger a personalized welcome + # response. The parameter `name` may be used by the agent in the response: `" + # Hello #welcome_event.name! What can I do for you today?"`. # Corresponds to the JSON property `followupEventInput` # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2beta1EventInput] attr_accessor :followup_event_input - # Optional. The rich response messages intended for the end-user. - # When provided, Dialogflow uses this field to populate - # QueryResult.fulfillment_messages sent to the integration or API caller. + # Optional. The rich response messages intended for the end-user. When provided, + # Dialogflow uses this field to populate QueryResult.fulfillment_messages sent + # to the integration or API caller. # Corresponds to the JSON property `fulfillmentMessages` # @return [Array] attr_accessor :fulfillment_messages - # Optional. The text response message intended for the end-user. - # It is recommended to use `fulfillment_messages.text.text[0]` instead. - # When provided, Dialogflow uses this field to populate - # QueryResult.fulfillment_text sent to the integration or API caller. + # Optional. The text response message intended for the end-user. It is + # recommended to use `fulfillment_messages.text.text[0]` instead. When provided, + # Dialogflow uses this field to populate QueryResult.fulfillment_text sent to + # the integration or API caller. # Corresponds to the JSON property `fulfillmentText` # @return [String] attr_accessor :fulfillment_text # Optional. The collection of output contexts that will overwrite currently - # active contexts for the session and reset their lifespans. - # When provided, Dialogflow uses this field to populate - # QueryResult.output_contexts sent to the integration or API caller. + # active contexts for the session and reset their lifespans. When provided, + # Dialogflow uses this field to populate QueryResult.output_contexts sent to the + # integration or API caller. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts # Optional. This field can be used to pass custom data from your webhook to the - # integration or API caller. Arbitrary JSON objects are supported. - # When provided, Dialogflow uses this field to populate - # QueryResult.webhook_payload sent to the integration or API caller. - # This field is also used by the - # [Google Assistant - # integration](https://cloud.google.com/dialogflow/docs/integrations/aog) - # for rich response messages. - # See the format definition at [Google Assistant Dialogflow webhook - # format](https://developers.google.com/assistant/actions/build/json/dialogflow- - # webhook-json) + # integration or API caller. Arbitrary JSON objects are supported. When provided, + # Dialogflow uses this field to populate QueryResult.webhook_payload sent to + # the integration or API caller. This field is also used by the [Google + # Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/ + # aog) for rich response messages. See the format definition at [Google + # Assistant Dialogflow webhook format](https://developers.google.com/assistant/ + # actions/build/json/dialogflow-webhook-json) # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload # Optional. Additional session entity types to replace or extend developer - # entity types with. The entity synonyms apply to all languages and persist - # for the session. Setting this data from a webhook overwrites - # the session entity types that have been set using `detectIntent`, - # `streamingDetectIntent` or SessionEntityType management methods. + # entity types with. The entity synonyms apply to all languages and persist for + # the session. Setting this data from a webhook overwrites the session entity + # types that have been set using `detectIntent`, `streamingDetectIntent` or + # SessionEntityType management methods. # Corresponds to the JSON property `sessionEntityTypes` # @return [Array] attr_accessor :session_entity_types - # Optional. A custom field used to identify the webhook source. - # Arbitrary strings are supported. - # When provided, Dialogflow uses this field to populate + # Optional. A custom field used to identify the webhook source. Arbitrary + # strings are supported. When provided, Dialogflow uses this field to populate # QueryResult.webhook_source sent to the integration or API caller. # Corresponds to the JSON property `source` # @return [String] @@ -7163,8 +6817,8 @@ module Google # @return [String] attr_accessor :agent_content - # The URI to a file containing the exported agent. This field is populated - # only if `agent_uri` is specified in ExportAgentRequest. + # The URI to a file containing the exported agent. This field is populated only + # if `agent_uri` is specified in ExportAgentRequest. # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri @@ -7210,47 +6864,45 @@ module Google class GoogleLongrunningOperation 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::DialogflowV2::GoogleRpcStatus] 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 @@ -7269,13 +6921,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 @@ -7288,12 +6938,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 GoogleRpcStatus include Google::Apis::Core::Hashable @@ -7302,15 +6952,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 @@ -7329,9 +6979,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. class GoogleTypeLatLng include Google::Apis::Core::Hashable diff --git a/generated/google/apis/dialogflow_v2/service.rb b/generated/google/apis/dialogflow_v2/service.rb index d08cfe427..40cc1e6be 100644 --- a/generated/google/apis/dialogflow_v2/service.rb +++ b/generated/google/apis/dialogflow_v2/service.rb @@ -50,8 +50,8 @@ module Google # Deletes the specified agent. # @param [String] parent - # Required. The project that the agent to delete is associated with. - # Format: `projects/`. + # Required. The project that the agent to delete is associated with. Format: ` + # projects/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -81,8 +81,8 @@ module Google # Retrieves the specified agent. # @param [String] parent - # Required. The project that the agent to fetch is associated with. - # Format: `projects/`. + # Required. The project that the agent to fetch is associated with. Format: ` + # projects/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -112,8 +112,7 @@ module Google # Creates/updates the specified agent. # @param [String] parent - # Required. The project of this agent. - # Format: `projects/`. + # Required. The project of this agent. Format: `projects/`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Agent] google_cloud_dialogflow_v2_agent_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -147,11 +146,10 @@ module Google execute_or_queue_command(command, &block) end - # Exports the specified agent to a ZIP file. - # Operation + # Exports the specified agent to a ZIP file. Operation # @param [String] parent - # Required. The project that the agent to export is associated with. - # Format: `projects/`. + # Required. The project that the agent to export is associated with. Format: ` + # projects/`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ExportAgentRequest] google_cloud_dialogflow_v2_export_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -184,8 +182,7 @@ module Google # Retrieves the fulfillment. # @param [String] name - # Required. The name of the fulfillment. - # Format: `projects//agent/fulfillment`. + # Required. The name of the fulfillment. Format: `projects//agent/fulfillment`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -213,17 +210,15 @@ module Google execute_or_queue_command(command, &block) end - # Gets agent validation result. Agent validation is performed during - # training time and is updated automatically when training is completed. + # Gets agent validation result. Agent validation is performed during training + # time and is updated automatically when training is completed. # @param [String] parent - # Required. The project that the agent is associated with. - # Format: `projects/`. + # Required. The project that the agent is associated with. Format: `projects/`. # @param [String] language_code # Optional. The language for which you want a validation result. If not - # specified, the agent's default language is used. [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # specified, the agent's default language is used. [Many languages](https:// + # cloud.google.com/dialogflow/docs/reference/language) are supported. Note: + # languages must be enabled in the agent before they can be used. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -252,20 +247,18 @@ module Google execute_or_queue_command(command, &block) end - # Imports the specified agent from a ZIP file. - # Uploads new intents and entity types without deleting the existing ones. - # Intents and entity types with the same name are replaced with the new - # versions from ImportAgentRequest. After the import, the imported draft - # agent will be trained automatically (unless disabled in agent settings). - # However, once the import is done, training may not be completed yet. Please - # call TrainAgent and wait for the operation it returns in order to train - # explicitly. - # Operation - # An operation which tracks when importing is complete. It only tracks - # when the draft agent is updated not when it is done training. + # Imports the specified agent from a ZIP file. Uploads new intents and entity + # types without deleting the existing ones. Intents and entity types with the + # same name are replaced with the new versions from ImportAgentRequest. After + # the import, the imported draft agent will be trained automatically (unless + # disabled in agent settings). However, once the import is done, training may + # not be completed yet. Please call TrainAgent and wait for the operation it + # returns in order to train explicitly. Operation An operation which tracks when + # importing is complete. It only tracks when the draft agent is updated not when + # it is done training. # @param [String] parent - # Required. The project that the agent to import is associated with. - # Format: `projects/`. + # Required. The project that the agent to import is associated with. Format: ` + # projects/`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2ImportAgentRequest] google_cloud_dialogflow_v2_import_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -296,19 +289,17 @@ module Google execute_or_queue_command(command, &block) end - # Restores the specified agent from a ZIP file. - # Replaces the current agent version with a new one. All the intents and - # entity types in the older version are deleted. After the restore, the - # restored draft agent will be trained automatically (unless disabled in - # agent settings). However, once the restore is done, training may not be - # completed yet. Please call TrainAgent and wait for the operation it - # returns in order to train explicitly. - # Operation - # An operation which tracks when restoring is complete. It only tracks - # when the draft agent is updated not when it is done training. + # Restores the specified agent from a ZIP file. Replaces the current agent + # version with a new one. All the intents and entity types in the older version + # are deleted. After the restore, the restored draft agent will be trained + # automatically (unless disabled in agent settings). However, once the restore + # is done, training may not be completed yet. Please call TrainAgent and wait + # for the operation it returns in order to train explicitly. Operation An + # operation which tracks when restoring is complete. It only tracks when the + # draft agent is updated not when it is done training. # @param [String] parent - # Required. The project that the agent to restore is associated with. - # Format: `projects/`. + # Required. The project that the agent to restore is associated with. Format: ` + # projects/`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2RestoreAgentRequest] google_cloud_dialogflow_v2_restore_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -339,19 +330,16 @@ module Google execute_or_queue_command(command, &block) end - # Returns the list of agents. - # Since there is at most one conversational agent per project, this method is - # useful primarily for listing all agents across projects the caller has - # access to. One can achieve that with a wildcard project collection id "-". - # Refer to [List - # Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub- - # collections). + # Returns the list of agents. Since there is at most one conversational agent + # per project, this method is useful primarily for listing all agents across + # projects the caller has access to. One can achieve that with a wildcard + # project collection id "-". Refer to [List Sub-Collections](https://cloud. + # google.com/apis/design/design_patterns#list_sub-collections). # @param [String] parent - # Required. The project to list agents from. - # Format: `projects/`. + # Required. The project to list agents from. Format: `projects/`. # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # The next_page_token value returned from a previous list request. # @param [String] fields @@ -383,11 +371,10 @@ module Google execute_or_queue_command(command, &block) end - # Trains the specified agent. - # Operation + # Trains the specified agent. Operation # @param [String] parent - # Required. The project that the agent to train is associated with. - # Format: `projects/`. + # Required. The project that the agent to train is associated with. Format: ` + # projects/`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2TrainAgentRequest] google_cloud_dialogflow_v2_train_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -420,8 +407,8 @@ module Google # Updates the fulfillment. # @param [String] name - # Required. The unique identifier of the fulfillment. - # Format: `projects//agent/fulfillment`. + # Required. The unique identifier of the fulfillment. Format: `projects//agent/ + # fulfillment`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Fulfillment] google_cloud_dialogflow_v2_fulfillment_object # @param [String] update_mask # Required. The mask to control which fields get updated. If the mask is not @@ -456,11 +443,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes entity types in the specified agent. - # Operation + # Deletes entity types in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to delete all entities types for. Format: - # `projects//agent`. + # Required. The name of the agent to delete all entities types for. Format: ` + # projects//agent`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchDeleteEntityTypesRequest] google_cloud_dialogflow_v2_batch_delete_entity_types_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -491,11 +477,10 @@ module Google execute_or_queue_command(command, &block) end - # Updates/Creates multiple entity types in the specified agent. - # Operation + # Updates/Creates multiple entity types in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to update or create entity types in. - # Format: `projects//agent`. + # Required. The name of the agent to update or create entity types in. Format: ` + # projects//agent`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchUpdateEntityTypesRequest] google_cloud_dialogflow_v2_batch_update_entity_types_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -528,16 +513,13 @@ module Google # Creates an entity type in the specified agent. # @param [String] parent - # Required. The agent to create a entity type for. - # Format: `projects//agent`. + # Required. The agent to create a entity type for. Format: `projects//agent`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType] google_cloud_dialogflow_v2_entity_type_object # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -570,8 +552,8 @@ module Google # Deletes the specified entity type. # @param [String] name - # Required. The name of the entity type to delete. - # Format: `projects//agent/entityTypes/`. + # Required. The name of the entity type to delete. Format: `projects//agent/ + # entityTypes/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -601,15 +583,12 @@ module Google # Retrieves the specified entity type. # @param [String] name - # Required. The name of the entity type. - # Format: `projects//agent/entityTypes/`. + # Required. The name of the entity type. Format: `projects//agent/entityTypes/`. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -640,18 +619,15 @@ module Google # Returns the list of all entity types in the specified agent. # @param [String] parent - # Required. The agent to list all entity types from. - # Format: `projects//agent`. + # Required. The agent to list all entity types from. Format: `projects//agent`. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -686,18 +662,15 @@ module Google # Updates the specified entity type. # @param [String] name - # The unique identifier of the entity type. - # Required for EntityTypes.UpdateEntityType and - # EntityTypes.BatchUpdateEntityTypes methods. - # Format: `projects//agent/entityTypes/`. + # The unique identifier of the entity type. Required for EntityTypes. + # UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: ` + # projects//agent/entityTypes/`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EntityType] google_cloud_dialogflow_v2_entity_type_object # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] update_mask # Optional. The mask to control which fields get updated. # @param [String] fields @@ -731,11 +704,10 @@ module Google execute_or_queue_command(command, &block) end - # Creates multiple new entities in the specified entity type. - # Operation + # Creates multiple new entities in the specified entity type. Operation # @param [String] parent - # Required. The name of the entity type to create entities in. Format: - # `projects//agent/entityTypes/`. + # Required. The name of the entity type to create entities in. Format: `projects/ + # /agent/entityTypes/`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchCreateEntitiesRequest] google_cloud_dialogflow_v2_batch_create_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -766,11 +738,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes entities in the specified entity type. - # Operation + # Deletes entities in the specified entity type. Operation # @param [String] parent - # Required. The name of the entity type to delete entries for. Format: - # `projects//agent/entityTypes/`. + # Required. The name of the entity type to delete entries for. Format: `projects/ + # /agent/entityTypes/`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchDeleteEntitiesRequest] google_cloud_dialogflow_v2_batch_delete_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -801,13 +772,12 @@ module Google execute_or_queue_command(command, &block) end - # Updates or creates multiple entities in the specified entity type. This - # method does not affect entities in the entity type that aren't explicitly - # specified in the request. - # Operation + # Updates or creates multiple entities in the specified entity type. This method + # does not affect entities in the entity type that aren't explicitly specified + # in the request. Operation # @param [String] parent - # Required. The name of the entity type to update or create entities in. - # Format: `projects//agent/entityTypes/`. + # Required. The name of the entity type to update or create entities in. Format: + # `projects//agent/entityTypes/`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchUpdateEntitiesRequest] google_cloud_dialogflow_v2_batch_update_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -840,12 +810,10 @@ module Google # Returns the list of all non-draft environments of the specified agent. # @param [String] parent - # Required. The agent to list all environments from. - # Format: `projects//agent`. + # Required. The agent to list all environments from. Format: `projects//agent`. # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By default - # 100 and - # at most 1000. + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -879,10 +847,8 @@ module Google # Deletes all active contexts in the specified session. # @param [String] parent - # Required. The name of the session to delete all contexts from. Format: - # `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. + # Required. The name of the session to delete all contexts from. Format: ` + # projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. # If `Environment ID` is not specified we assume default 'draft' environment. # If `User ID` is not specified, we assume default '-' user. # @param [String] fields @@ -912,22 +878,20 @@ module Google execute_or_queue_command(command, &block) end - # Processes a natural language query and returns structured, actionable data - # as a result. This method is not idempotent, because it may cause contexts - # and session entity types to be updated, which in turn might affect - # results of future queries. + # Processes a natural language query and returns structured, actionable data as + # a result. This method is not idempotent, because it may cause contexts and + # session entity types to be updated, which in turn might affect results of + # future queries. # @param [String] session - # Required. The name of the session this query is sent to. Format: - # `projects//agent/sessions/`, or - # `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we are using - # "-". It's up to the API caller to choose an appropriate `Session ID` and - # `User Id`. They can be a random number or some type of user and session - # identifiers (preferably hashed). The length of the `Session ID` and - # `User ID` must not exceed 36 characters. - # For more information, see the [API interactions - # guide](https://cloud.google.com/dialogflow/docs/api-overview). + # Required. The name of the session this query is sent to. Format: `projects// + # agent/sessions/`, or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we are using "-". It's up to the API caller to + # choose an appropriate `Session ID` and `User Id`. They can be a random number + # or some type of user and session identifiers (preferably hashed). The length + # of the `Session ID` and `User ID` must not exceed 36 characters. For more + # information, see the [API interactions guide](https://cloud.google.com/ + # dialogflow/docs/api-overview). # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DetectIntentRequest] google_cloud_dialogflow_v2_detect_intent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -958,15 +922,13 @@ module Google execute_or_queue_command(command, &block) end - # Creates a context. - # If the specified context already exists, overrides the context. + # Creates a context. If the specified context already exists, overrides the + # context. # @param [String] parent - # Required. The session to create a context for. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users//sessions/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The session to create a context for. Format: `projects//agent/ + # sessions/` or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context] google_cloud_dialogflow_v2_context_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -999,12 +961,10 @@ module Google # Deletes the specified context. # @param [String] name - # Required. The name of the context to delete. Format: - # `projects//agent/sessions//contexts/` - # or `projects//agent/environments//users//sessions//contexts/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The name of the context to delete. Format: `projects//agent/sessions/ + # /contexts/` or `projects//agent/environments//users//sessions//contexts/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1034,12 +994,10 @@ module Google # Retrieves the specified context. # @param [String] name - # Required. The name of the context. Format: - # `projects//agent/sessions//contexts/` - # or `projects//agent/environments//users//sessions//contexts/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The name of the context. Format: `projects//agent/sessions//contexts/ + # ` or `projects//agent/environments//users//sessions//contexts/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1069,15 +1027,13 @@ module Google # Returns the list of all contexts in the specified session. # @param [String] parent - # Required. The session to list all contexts from. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users//sessions/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The session to list all contexts from. Format: `projects//agent/ + # sessions/` or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -1111,19 +1067,15 @@ module Google # Updates the specified context. # @param [String] name - # Required. The unique identifier of the context. Format: - # `projects//agent/sessions//contexts/`, - # or `projects//agent/environments//users//sessions//contexts/`. - # The `Context ID` is always converted to lowercase, may only contain - # characters in a-zA-Z0-9_-% and may be at most 250 bytes long. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # The following context names are reserved for internal use by Dialogflow. - # You should not use these contexts or create contexts with these names: - # * `__system_counters__` - # * `*_id_dialog_context` - # * `*_dialog_params_size` + # Required. The unique identifier of the context. Format: `projects//agent/ + # sessions//contexts/`, or `projects//agent/environments//users//sessions// + # contexts/`. The `Context ID` is always converted to lowercase, may only + # contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. The following context + # names are reserved for internal use by Dialogflow. You should not use these + # contexts or create contexts with these names: * `__system_counters__` * `* + # _id_dialog_context` * `*_dialog_params_size` # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context] google_cloud_dialogflow_v2_context_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -1157,19 +1109,15 @@ module Google execute_or_queue_command(command, &block) end - # Creates a session entity type. - # If the specified session entity type already exists, overrides the session - # entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Creates a session entity type. If the specified session entity type already + # exists, overrides the session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] parent - # Required. The session to create a session entity type for. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users// - # sessions/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The session to create a session entity type for. Format: `projects// + # agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType] google_cloud_dialogflow_v2_session_entity_type_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1200,17 +1148,13 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Deletes the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the entity type to delete. Format: - # `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. - # If `Environment ID` is not specified, we assume default 'draft' + # Required. The name of the entity type to delete. Format: `projects//agent/ + # sessions//entityTypes/` or `projects//agent/environments//users//sessions// + # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' # environment. If `User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1239,17 +1183,13 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Retrieves the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the session entity type. Format: - # `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. - # If `Environment ID` is not specified, we assume default 'draft' + # Required. The name of the session entity type. Format: `projects//agent/ + # sessions//entityTypes/` or `projects//agent/environments//users//sessions// + # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' # environment. If `User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1278,20 +1218,17 @@ module Google execute_or_queue_command(command, &block) end - # Returns the list of all session entity types in the specified session. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Returns the list of all session entity types in the specified session. This + # method doesn't work with Google Assistant integration. Contact Dialogflow + # support if you need to use session entities with Google Assistant integration. # @param [String] parent - # Required. The session to list all session entity types from. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users// - # sessions/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The session to list all session entity types from. Format: `projects/ + # /agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -1323,20 +1260,16 @@ module Google execute_or_queue_command(command, &block) end - # Updates the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Updates the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The unique identifier of this session entity type. Format: - # `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # `` must be the display name of an existing entity - # type in the same agent that will be overridden or supplemented. + # Required. The unique identifier of this session entity type. Format: `projects/ + # /agent/sessions//entityTypes/`, or `projects//agent/environments//users// + # sessions//entityTypes/`. If `Environment ID` is not specified, we assume + # default 'draft' environment. If `User ID` is not specified, we assume default ' + # -' user. `` must be the display name of an existing entity type in the same + # agent that will be overridden or supplemented. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType] google_cloud_dialogflow_v2_session_entity_type_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -1370,11 +1303,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes intents in the specified agent. - # Operation + # Deletes intents in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to delete all entities types for. Format: - # `projects//agent`. + # Required. The name of the agent to delete all entities types for. Format: ` + # projects//agent`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchDeleteIntentsRequest] google_cloud_dialogflow_v2_batch_delete_intents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1405,11 +1337,10 @@ module Google execute_or_queue_command(command, &block) end - # Updates/Creates multiple intents in the specified agent. - # Operation + # Updates/Creates multiple intents in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to update or create intents in. - # Format: `projects//agent`. + # Required. The name of the agent to update or create intents in. Format: ` + # projects//agent`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2BatchUpdateIntentsRequest] google_cloud_dialogflow_v2_batch_update_intents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1442,18 +1373,15 @@ module Google # Creates an intent in the specified agent. # @param [String] parent - # Required. The agent to create a intent for. - # Format: `projects//agent`. + # Required. The agent to create a intent for. Format: `projects//agent`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent] google_cloud_dialogflow_v2_intent_object # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1488,8 +1416,8 @@ module Google # Deletes the specified intent and its direct or indirect followup intents. # @param [String] name # Required. The name of the intent to delete. If this intent has direct or - # indirect followup intents, we also delete them. - # Format: `projects//agent/intents/`. + # indirect followup intents, we also delete them. Format: `projects//agent/ + # intents/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1519,17 +1447,14 @@ module Google # Retrieves the specified intent. # @param [String] name - # Required. The name of the intent. - # Format: `projects//agent/intents/`. + # Required. The name of the intent. Format: `projects//agent/intents/`. # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1561,20 +1486,17 @@ module Google # Returns the list of all intents in the specified agent. # @param [String] parent - # Required. The agent to list all intents from. - # Format: `projects//agent`. + # Required. The agent to list all intents from. Format: `projects//agent`. # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -1610,20 +1532,17 @@ module Google # Updates the specified intent. # @param [String] name - # Optional. The unique identifier of this intent. - # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents - # methods. - # Format: `projects//agent/intents/`. + # Optional. The unique identifier of this intent. Required for Intents. + # UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/ + # intents/`. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Intent] google_cloud_dialogflow_v2_intent_object # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] update_mask # Optional. The mask to control which fields get updated. # @param [String] fields @@ -1660,10 +1579,8 @@ module Google # Deletes all active contexts in the specified session. # @param [String] parent - # Required. The name of the session to delete all contexts from. Format: - # `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. + # Required. The name of the session to delete all contexts from. Format: ` + # projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. # If `Environment ID` is not specified we assume default 'draft' environment. # If `User ID` is not specified, we assume default '-' user. # @param [String] fields @@ -1693,22 +1610,20 @@ module Google execute_or_queue_command(command, &block) end - # Processes a natural language query and returns structured, actionable data - # as a result. This method is not idempotent, because it may cause contexts - # and session entity types to be updated, which in turn might affect - # results of future queries. + # Processes a natural language query and returns structured, actionable data as + # a result. This method is not idempotent, because it may cause contexts and + # session entity types to be updated, which in turn might affect results of + # future queries. # @param [String] session - # Required. The name of the session this query is sent to. Format: - # `projects//agent/sessions/`, or - # `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we are using - # "-". It's up to the API caller to choose an appropriate `Session ID` and - # `User Id`. They can be a random number or some type of user and session - # identifiers (preferably hashed). The length of the `Session ID` and - # `User ID` must not exceed 36 characters. - # For more information, see the [API interactions - # guide](https://cloud.google.com/dialogflow/docs/api-overview). + # Required. The name of the session this query is sent to. Format: `projects// + # agent/sessions/`, or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we are using "-". It's up to the API caller to + # choose an appropriate `Session ID` and `User Id`. They can be a random number + # or some type of user and session identifiers (preferably hashed). The length + # of the `Session ID` and `User ID` must not exceed 36 characters. For more + # information, see the [API interactions guide](https://cloud.google.com/ + # dialogflow/docs/api-overview). # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2DetectIntentRequest] google_cloud_dialogflow_v2_detect_intent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1739,15 +1654,13 @@ module Google execute_or_queue_command(command, &block) end - # Creates a context. - # If the specified context already exists, overrides the context. + # Creates a context. If the specified context already exists, overrides the + # context. # @param [String] parent - # Required. The session to create a context for. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users//sessions/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The session to create a context for. Format: `projects//agent/ + # sessions/` or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context] google_cloud_dialogflow_v2_context_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1780,12 +1693,10 @@ module Google # Deletes the specified context. # @param [String] name - # Required. The name of the context to delete. Format: - # `projects//agent/sessions//contexts/` - # or `projects//agent/environments//users//sessions//contexts/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The name of the context to delete. Format: `projects//agent/sessions/ + # /contexts/` or `projects//agent/environments//users//sessions//contexts/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1815,12 +1726,10 @@ module Google # Retrieves the specified context. # @param [String] name - # Required. The name of the context. Format: - # `projects//agent/sessions//contexts/` - # or `projects//agent/environments//users//sessions//contexts/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The name of the context. Format: `projects//agent/sessions//contexts/ + # ` or `projects//agent/environments//users//sessions//contexts/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1850,15 +1759,13 @@ module Google # Returns the list of all contexts in the specified session. # @param [String] parent - # Required. The session to list all contexts from. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users//sessions/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The session to list all contexts from. Format: `projects//agent/ + # sessions/` or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -1892,19 +1799,15 @@ module Google # Updates the specified context. # @param [String] name - # Required. The unique identifier of the context. Format: - # `projects//agent/sessions//contexts/`, - # or `projects//agent/environments//users//sessions//contexts/`. - # The `Context ID` is always converted to lowercase, may only contain - # characters in a-zA-Z0-9_-% and may be at most 250 bytes long. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # The following context names are reserved for internal use by Dialogflow. - # You should not use these contexts or create contexts with these names: - # * `__system_counters__` - # * `*_id_dialog_context` - # * `*_dialog_params_size` + # Required. The unique identifier of the context. Format: `projects//agent/ + # sessions//contexts/`, or `projects//agent/environments//users//sessions// + # contexts/`. The `Context ID` is always converted to lowercase, may only + # contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. The following context + # names are reserved for internal use by Dialogflow. You should not use these + # contexts or create contexts with these names: * `__system_counters__` * `* + # _id_dialog_context` * `*_dialog_params_size` # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Context] google_cloud_dialogflow_v2_context_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -1938,19 +1841,15 @@ module Google execute_or_queue_command(command, &block) end - # Creates a session entity type. - # If the specified session entity type already exists, overrides the session - # entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Creates a session entity type. If the specified session entity type already + # exists, overrides the session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] parent - # Required. The session to create a session entity type for. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users// - # sessions/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The session to create a session entity type for. Format: `projects// + # agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType] google_cloud_dialogflow_v2_session_entity_type_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1981,17 +1880,13 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Deletes the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the entity type to delete. Format: - # `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. - # If `Environment ID` is not specified, we assume default 'draft' + # Required. The name of the entity type to delete. Format: `projects//agent/ + # sessions//entityTypes/` or `projects//agent/environments//users//sessions// + # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' # environment. If `User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2020,17 +1915,13 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Retrieves the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the session entity type. Format: - # `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. - # If `Environment ID` is not specified, we assume default 'draft' + # Required. The name of the session entity type. Format: `projects//agent/ + # sessions//entityTypes/` or `projects//agent/environments//users//sessions// + # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' # environment. If `User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2059,20 +1950,17 @@ module Google execute_or_queue_command(command, &block) end - # Returns the list of all session entity types in the specified session. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Returns the list of all session entity types in the specified session. This + # method doesn't work with Google Assistant integration. Contact Dialogflow + # support if you need to use session entities with Google Assistant integration. # @param [String] parent - # Required. The session to list all session entity types from. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users// - # sessions/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The session to list all session entity types from. Format: `projects/ + # /agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -2104,20 +1992,16 @@ module Google execute_or_queue_command(command, &block) end - # Updates the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Updates the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The unique identifier of this session entity type. Format: - # `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # `` must be the display name of an existing entity - # type in the same agent that will be overridden or supplemented. + # Required. The unique identifier of this session entity type. Format: `projects/ + # /agent/sessions//entityTypes/`, or `projects//agent/environments//users// + # sessions//entityTypes/`. If `Environment ID` is not specified, we assume + # default 'draft' environment. If `User ID` is not specified, we assume default ' + # -' user. `` must be the display name of an existing entity type in the same + # agent that will be overridden or supplemented. # @param [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SessionEntityType] google_cloud_dialogflow_v2_session_entity_type_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -2151,15 +2035,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. @@ -2190,9 +2072,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 @@ -2222,15 +2103,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 @@ -2269,15 +2149,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. @@ -2308,9 +2186,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 @@ -2340,15 +2217,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/dialogflow_v2beta1.rb b/generated/google/apis/dialogflow_v2beta1.rb index 30d718400..59283abef 100644 --- a/generated/google/apis/dialogflow_v2beta1.rb +++ b/generated/google/apis/dialogflow_v2beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/dialogflow/ module DialogflowV2beta1 VERSION = 'V2beta1' - REVISION = '20200719' + 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/dialogflow_v2beta1/classes.rb b/generated/google/apis/dialogflow_v2beta1/classes.rb index 59bbc2fac..706e3b1ba 100644 --- a/generated/google/apis/dialogflow_v2beta1/classes.rb +++ b/generated/google/apis/dialogflow_v2beta1/classes.rb @@ -32,8 +32,8 @@ module Google # @return [String] attr_accessor :agent_content - # The URI to a file containing the exported agent. This field is populated - # only if `agent_uri` is specified in ExportAgentRequest. + # The URI to a file containing the exported agent. This field is populated only + # if `agent_uri` is specified in ExportAgentRequest. # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri @@ -53,10 +53,9 @@ module Google class GoogleCloudDialogflowCxV3beta1PageInfo include Google::Apis::Core::Hashable - # Always present for WebhookRequest. Ignored for WebhookResponse. - # The unique identifier of the current page. - # Format: `projects//locations//agents//flows//pages/`. + # Always present for WebhookRequest. Ignored for WebhookResponse. The unique + # identifier of the current page. Format: `projects//locations//agents//flows// + # pages/`. # Corresponds to the JSON property `currentPage` # @return [String] attr_accessor :current_page @@ -81,9 +80,8 @@ module Google class GoogleCloudDialogflowCxV3beta1PageInfoFormInfo include Google::Apis::Core::Hashable - # Optional for both WebhookRequest and WebhookResponse. - # The parameters contained in the form. Note that the webhook cannot add - # or remove any form parameter. + # Optional for both WebhookRequest and WebhookResponse. The parameters contained + # in the form. Note that the webhook cannot add or remove any form parameter. # Corresponds to the JSON property `parameterInfo` # @return [Array] attr_accessor :parameter_info @@ -102,43 +100,38 @@ module Google class GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo include Google::Apis::Core::Hashable - # Always present for WebhookRequest. Required for - # WebhookResponse. - # The human-readable name of the parameter, unique within the form. This - # field cannot be modified by the webhook. + # Always present for WebhookRequest. Required for WebhookResponse. The human- + # readable name of the parameter, unique within the form. This field cannot be + # modified by the webhook. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Optional for WebhookRequest. Ignored for WebhookResponse. - # Indicates if the parameter value was just collected on the last - # conversation turn. + # Optional for WebhookRequest. Ignored for WebhookResponse. Indicates if the + # parameter value was just collected on the last conversation turn. # Corresponds to the JSON property `justCollected` # @return [Boolean] attr_accessor :just_collected alias_method :just_collected?, :just_collected - # Optional for both WebhookRequest and WebhookResponse. - # Indicates whether the parameter is required. Optional parameters will - # not trigger prompts; however, they are filled if the user specifies - # them. Required parameters must be filled before form filling concludes. + # Optional for both WebhookRequest and WebhookResponse. Indicates whether the + # parameter is required. Optional parameters will not trigger prompts; however, + # they are filled if the user specifies them. Required parameters must be filled + # before form filling concludes. # Corresponds to the JSON property `required` # @return [Boolean] attr_accessor :required alias_method :required?, :required - # Always present for WebhookRequest. Required for - # WebhookResponse. The state of the parameter. This field can be set - # to INVALID by - # the webhook to invalidate the parameter; other values set by the - # webhook will be ignored. + # Always present for WebhookRequest. Required for WebhookResponse. The state of + # the parameter. This field can be set to INVALID by the webhook to invalidate + # the parameter; other values set by the webhook will be ignored. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state - # Optional for both WebhookRequest and WebhookResponse. - # The value of the parameter. This field can be set by the webhook to - # change the parameter value. + # Optional for both WebhookRequest and WebhookResponse. The value of the + # parameter. This field can be set by the webhook to change the parameter value. # Corresponds to the JSON property `value` # @return [Object] attr_accessor :value @@ -158,80 +151,65 @@ module Google end # Represents a response message that can be returned by a conversational agent. - # Response messages are also used for output audio synthesis. The approach is - # as follows: - # * If at least one OutputAudioText response is present, then all + # Response messages are also used for output audio synthesis. The approach is as + # follows: * If at least one OutputAudioText response is present, then all # OutputAudioText responses are linearly concatenated, and the result is used - # for output audio synthesis. - # * If the OutputAudioText responses are a mixture of text and SSML, then the - # concatenated result is treated as SSML; otherwise, the result is treated as - # either text or SSML as appropriate. The agent designer should ideally use - # either text or SSML consistently throughout the bot design. - # * Otherwise, all Text responses are linearly concatenated, and the result is - # used for output audio synthesis. - # This approach allows for more sophisticated user experience scenarios, where - # the text displayed to the user may differ from what is heard. + # for output audio synthesis. * If the OutputAudioText responses are a mixture + # of text and SSML, then the concatenated result is treated as SSML; otherwise, + # the result is treated as either text or SSML as appropriate. The agent + # designer should ideally use either text or SSML consistently throughout the + # bot design. * Otherwise, all Text responses are linearly concatenated, and the + # result is used for output audio synthesis. This approach allows for more + # sophisticated user experience scenarios, where the text displayed to the user + # may differ from what is heard. class GoogleCloudDialogflowCxV3beta1ResponseMessage include Google::Apis::Core::Hashable # Indicates that the conversation succeeded, i.e., the bot handled the issue - # that the customer talked to it about. - # Dialogflow only uses this to determine which conversations should be - # counted as successful and doesn't process the metadata in this message in - # any way. Note that Dialogflow also considers conversations that get to the - # conversation end page as successful even if they don't return - # ConversationSuccess. - # You may set this, for example: - # * In the entry_fulfillment of a Page if - # entering the page indicates that the conversation succeeded. - # * In a webhook response when you determine that you handled the customer - # issue. + # that the customer talked to it about. Dialogflow only uses this to determine + # which conversations should be counted as successful and doesn't process the + # metadata in this message in any way. Note that Dialogflow also considers + # conversations that get to the conversation end page as successful even if they + # don't return ConversationSuccess. You may set this, for example: * In the + # entry_fulfillment of a Page if entering the page indicates that the + # conversation succeeded. * In a webhook response when you determine that you + # handled the customer issue. # Corresponds to the JSON property `conversationSuccess` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess] attr_accessor :conversation_success - # Indicates that interaction with the Dialogflow agent has ended. - # This message is generated by Dialogflow only and not supposed to be - # defined by the user. + # Indicates that interaction with the Dialogflow agent has ended. This message + # is generated by Dialogflow only and not supposed to be defined by the user. # Corresponds to the JSON property `endInteraction` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction] attr_accessor :end_interaction # Indicates that the conversation should be handed off to a human agent. - # Dialogflow only uses this to determine which conversations were handed off - # to a human agent for measurement purposes. What else to do with this signal - # is up to you and your handoff procedures. - # You may set this, for example: - # * In the entry_fulfillment of a Page if - # entering the page indicates something went extremely wrong in the - # conversation. - # * In a webhook response when you determine that the customer issue can only - # be handled by a human. + # Dialogflow only uses this to determine which conversations were handed off to + # a human agent for measurement purposes. What else to do with this signal is up + # to you and your handoff procedures. You may set this, for example: * In the + # entry_fulfillment of a Page if entering the page indicates something went + # extremely wrong in the conversation. * In a webhook response when you + # determine that the customer issue can only be handled by a human. # Corresponds to the JSON property `humanAgentHandoff` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff] attr_accessor :human_agent_handoff # Indicates that the conversation should be handed off to a live agent. - # Dialogflow only uses this to determine which conversations were handed off - # to a human agent for measurement purposes. What else to do with this signal - # is up to you and your handoff procedures. - # You may set this, for example: - # * In the entry_fulfillment of a Page if - # entering the page indicates something went extremely wrong in the - # conversation. - # * In a webhook response when you determine that the customer issue can only - # be handled by a human. + # Dialogflow only uses this to determine which conversations were handed off to + # a human agent for measurement purposes. What else to do with this signal is up + # to you and your handoff procedures. You may set this, for example: * In the + # entry_fulfillment of a Page if entering the page indicates something went + # extremely wrong in the conversation. * In a webhook response when you + # determine that the customer issue can only be handled by a human. # Corresponds to the JSON property `liveAgentHandoff` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff] attr_accessor :live_agent_handoff - # Represents an audio message that is composed of both segments - # synthesized from the Dialogflow agent prompts and ones hosted externally - # at the specified URIs. - # The external URIs are specified via - # play_audio. - # This message is generated by Dialogflow only and not supposed to be - # defined by the user. + # Represents an audio message that is composed of both segments synthesized from + # the Dialogflow agent prompts and ones hosted externally at the specified URIs. + # The external URIs are specified via play_audio. This message is generated by + # Dialogflow only and not supposed to be defined by the user. # Corresponds to the JSON property `mixedAudio` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio] attr_accessor :mixed_audio @@ -276,17 +254,14 @@ module Google end # Indicates that the conversation succeeded, i.e., the bot handled the issue - # that the customer talked to it about. - # Dialogflow only uses this to determine which conversations should be - # counted as successful and doesn't process the metadata in this message in - # any way. Note that Dialogflow also considers conversations that get to the - # conversation end page as successful even if they don't return - # ConversationSuccess. - # You may set this, for example: - # * In the entry_fulfillment of a Page if - # entering the page indicates that the conversation succeeded. - # * In a webhook response when you determine that you handled the customer - # issue. + # that the customer talked to it about. Dialogflow only uses this to determine + # which conversations should be counted as successful and doesn't process the + # metadata in this message in any way. Note that Dialogflow also considers + # conversations that get to the conversation end page as successful even if they + # don't return ConversationSuccess. You may set this, for example: * In the + # entry_fulfillment of a Page if entering the page indicates that the + # conversation succeeded. * In a webhook response when you determine that you + # handled the customer issue. class GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess include Google::Apis::Core::Hashable @@ -305,9 +280,8 @@ module Google end end - # Indicates that interaction with the Dialogflow agent has ended. - # This message is generated by Dialogflow only and not supposed to be - # defined by the user. + # Indicates that interaction with the Dialogflow agent has ended. This message + # is generated by Dialogflow only and not supposed to be defined by the user. class GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction include Google::Apis::Core::Hashable @@ -321,20 +295,17 @@ module Google end # Indicates that the conversation should be handed off to a human agent. - # Dialogflow only uses this to determine which conversations were handed off - # to a human agent for measurement purposes. What else to do with this signal - # is up to you and your handoff procedures. - # You may set this, for example: - # * In the entry_fulfillment of a Page if - # entering the page indicates something went extremely wrong in the - # conversation. - # * In a webhook response when you determine that the customer issue can only - # be handled by a human. + # Dialogflow only uses this to determine which conversations were handed off to + # a human agent for measurement purposes. What else to do with this signal is up + # to you and your handoff procedures. You may set this, for example: * In the + # entry_fulfillment of a Page if entering the page indicates something went + # extremely wrong in the conversation. * In a webhook response when you + # determine that the customer issue can only be handled by a human. class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff include Google::Apis::Core::Hashable - # Custom metadata for your handoff procedure. Dialogflow doesn't impose - # any structure on this. + # Custom metadata for your handoff procedure. Dialogflow doesn't impose any + # structure on this. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata @@ -350,20 +321,17 @@ module Google end # Indicates that the conversation should be handed off to a live agent. - # Dialogflow only uses this to determine which conversations were handed off - # to a human agent for measurement purposes. What else to do with this signal - # is up to you and your handoff procedures. - # You may set this, for example: - # * In the entry_fulfillment of a Page if - # entering the page indicates something went extremely wrong in the - # conversation. - # * In a webhook response when you determine that the customer issue can only - # be handled by a human. + # Dialogflow only uses this to determine which conversations were handed off to + # a human agent for measurement purposes. What else to do with this signal is up + # to you and your handoff procedures. You may set this, for example: * In the + # entry_fulfillment of a Page if entering the page indicates something went + # extremely wrong in the conversation. * In a webhook response when you + # determine that the customer issue can only be handled by a human. class GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff include Google::Apis::Core::Hashable - # Custom metadata for your handoff procedure. Dialogflow doesn't impose - # any structure on this. + # Custom metadata for your handoff procedure. Dialogflow doesn't impose any + # structure on this. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata @@ -378,13 +346,10 @@ module Google end end - # Represents an audio message that is composed of both segments - # synthesized from the Dialogflow agent prompts and ones hosted externally - # at the specified URIs. - # The external URIs are specified via - # play_audio. - # This message is generated by Dialogflow only and not supposed to be - # defined by the user. + # Represents an audio message that is composed of both segments synthesized from + # the Dialogflow agent prompts and ones hosted externally at the specified URIs. + # The external URIs are specified via play_audio. This message is generated by + # Dialogflow only and not supposed to be defined by the user. class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio include Google::Apis::Core::Hashable @@ -407,23 +372,22 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment include Google::Apis::Core::Hashable - # Whether the playback of this segment can be interrupted by the end - # user's speech and the client should then start the next Dialogflow - # request. + # Whether the playback of this segment can be interrupted by the end user's + # speech and the client should then start the next Dialogflow request. # Corresponds to the JSON property `allowPlaybackInterruption` # @return [Boolean] attr_accessor :allow_playback_interruption alias_method :allow_playback_interruption?, :allow_playback_interruption - # Raw audio synthesized from the Dialogflow agent's response using - # the output config specified in the request. + # Raw audio synthesized from the Dialogflow agent's response using the output + # config specified in the request. # Corresponds to the JSON property `audio` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :audio - # Client-specific URI that points to an audio clip accessible to the - # client. Dialogflow does not impose any validation on it. + # Client-specific URI that points to an audio clip accessible to the client. + # Dialogflow does not impose any validation on it. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -445,8 +409,8 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText include Google::Apis::Core::Hashable - # The SSML text to be synthesized. For more information, see - # [SSML](/speech/text-to-speech/docs/ssml). + # The SSML text to be synthesized. For more information, see [SSML](/speech/text- + # to-speech/docs/ssml). # Corresponds to the JSON property `ssml` # @return [String] attr_accessor :ssml @@ -471,17 +435,15 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio include Google::Apis::Core::Hashable - # Whether the playback of this message can be interrupted by the end - # user's speech and the client can then starts the next Dialogflow - # request. + # Whether the playback of this message can be interrupted by the end user's + # speech and the client can then starts the next Dialogflow request. # Corresponds to the JSON property `allowPlaybackInterruption` # @return [Boolean] attr_accessor :allow_playback_interruption alias_method :allow_playback_interruption?, :allow_playback_interruption # Required. URI of the audio clip. Dialogflow does not impose any validation on - # this - # value. It is specific to the client that reads it. + # this value. It is specific to the client that reads it. # Corresponds to the JSON property `audioUri` # @return [String] attr_accessor :audio_uri @@ -501,9 +463,8 @@ module Google class GoogleCloudDialogflowCxV3beta1ResponseMessageText include Google::Apis::Core::Hashable - # Whether the playback of this message can be interrupted by the end - # user's speech and the client can then starts the next Dialogflow - # request. + # Whether the playback of this message can be interrupted by the end user's + # speech and the client can then starts the next Dialogflow request. # Corresponds to the JSON property `allowPlaybackInterruption` # @return [Boolean] attr_accessor :allow_playback_interruption @@ -529,21 +490,18 @@ module Google class GoogleCloudDialogflowCxV3beta1SessionInfo include Google::Apis::Core::Hashable - # Optional for WebhookRequest. Optional for WebhookResponse. - # All parameters collected from forms and intents during the session. - # Parameters can be created, updated, or removed by the webhook. To remove a - # parameter from the session, the webhook should explicitly set the parameter - # value to null in WebhookResponse. The map is keyed by parameters' - # display names. + # Optional for WebhookRequest. Optional for WebhookResponse. All parameters + # collected from forms and intents during the session. Parameters can be created, + # updated, or removed by the webhook. To remove a parameter from the session, + # the webhook should explicitly set the parameter value to null in + # WebhookResponse. The map is keyed by parameters' display names. # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters - # Always present for WebhookRequest. Ignored for WebhookResponse. - # The unique identifier of the session. This - # field can be used by the webhook to identify a user. - # Format: `projects//locations//agents//sessions/`. + # Always present for WebhookRequest. Ignored for WebhookResponse. The unique + # identifier of the session. This field can be used by the webhook to identify a + # user. Format: `projects//locations//agents//sessions/`. # Corresponds to the JSON property `session` # @return [String] attr_accessor :session @@ -563,8 +521,8 @@ module Google class GoogleCloudDialogflowCxV3beta1WebhookRequest include Google::Apis::Core::Hashable - # Always present. The unique identifier of the DetectIntentResponse that - # will be returned to the API caller. + # Always present. The unique identifier of the DetectIntentResponse that will be + # returned to the API caller. # Corresponds to the JSON property `detectIntentResponseId` # @return [String] attr_accessor :detect_intent_response_id @@ -579,9 +537,8 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo] attr_accessor :intent_info - # The list of rich message responses to present to the user. Webhook can - # choose to append or replace this list in - # WebhookResponse.fulfillment_response; + # The list of rich message responses to present to the user. Webhook can choose + # to append or replace this list in WebhookResponse.fulfillment_response; # Corresponds to the JSON property `messages` # @return [Array] attr_accessor :messages @@ -621,8 +578,7 @@ module Google class GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo include Google::Apis::Core::Hashable - # Always present. The tag used to identify which fulfillment is being - # called. + # Always present. The tag used to identify which fulfillment is being called. # Corresponds to the JSON property `tag` # @return [String] attr_accessor :tag @@ -641,17 +597,16 @@ module Google class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo include Google::Apis::Core::Hashable - # Always present. The unique identifier of the last matched - # intent. Format: `projects//locations//agents//intents/`. + # Always present. The unique identifier of the last matched intent. Format: ` + # projects//locations//agents//intents/`. # Corresponds to the JSON property `lastMatchedIntent` # @return [String] attr_accessor :last_matched_intent - # Parameters identified as a result of intent matching. This is a map of - # the name of the identified parameter to the value of the parameter - # identified from the user's utterance. All parameters defined in the - # matched intent that are identified will be surfaced here. + # Parameters identified as a result of intent matching. This is a map of the + # name of the identified parameter to the value of the parameter identified from + # the user's utterance. All parameters defined in the matched intent that are + # identified will be surfaced here. # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -717,16 +672,14 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowCxV3beta1SessionInfo] attr_accessor :session_info - # The target flow to transition to. - # Format: `projects//locations//agents//flows/`. + # The target flow to transition to. Format: `projects//locations//agents//flows/` + # . # Corresponds to the JSON property `targetFlow` # @return [String] attr_accessor :target_flow - # The target page to transition to. - # Format: `projects//locations//agents//flows//pages/`. + # The target page to transition to. Format: `projects//locations//agents//flows// + # pages/`. # Corresponds to the JSON property `targetPage` # @return [String] attr_accessor :target_page @@ -771,30 +724,23 @@ module Google end end - # Represents a part of a message possibly annotated with an entity. The part - # can be an entity or purely a part of the message between two entities or - # message start/end. + # Represents a part of a message possibly annotated with an entity. The part can + # be an entity or purely a part of the message between two entities or message + # start/end. class GoogleCloudDialogflowV2AnnotatedMessagePart include Google::Apis::Core::Hashable - # The [Dialogflow system entity - # type](https://cloud.google.com/dialogflow/docs/reference/system-entities) - # of this message part. If this is empty, Dialogflow could not annotate the - # phrase part with a system entity. + # The [Dialogflow system entity type](https://cloud.google.com/dialogflow/docs/ + # reference/system-entities) of this message part. If this is empty, Dialogflow + # could not annotate the phrase part with a system entity. # Corresponds to the JSON property `entityType` # @return [String] attr_accessor :entity_type - # The [Dialogflow system entity formatted value - # ](https://cloud.google.com/dialogflow/docs/reference/system-entities) of - # this message part. For example for a system entity of type - # `@sys.unit-currency`, this may contain: - # 
-        # `
-        # "amount": 5,
-        # "currency": "USD"
-        # `
-        #
+ # The [Dialogflow system entity formatted value ](https://cloud.google.com/ + # dialogflow/docs/reference/system-entities) of this message part. For example + # for a system entity of type `@sys.unit-currency`, this may contain: ` "amount": + # 5, "currency": "USD" ` # Corresponds to the JSON property `formattedValue` # @return [Object] attr_accessor :formatted_value @@ -857,57 +803,47 @@ module Google # Dialogflow contexts are similar to natural language context. If a person says # to you "they are orange", you need context in order to understand what "they" # is referring to. Similarly, for Dialogflow to handle an end-user expression - # like that, it needs to be provided with context in order to correctly match - # an intent. - # Using contexts, you can control the flow of a conversation. You can configure - # contexts for an intent by setting input and output contexts, which are - # identified by string names. When an intent is matched, any configured output - # contexts for that intent become active. While any contexts are active, + # like that, it needs to be provided with context in order to correctly match an + # intent. Using contexts, you can control the flow of a conversation. You can + # configure contexts for an intent by setting input and output contexts, which + # are identified by string names. When an intent is matched, any configured + # output contexts for that intent become active. While any contexts are active, # Dialogflow is more likely to match intents that are configured with input - # contexts that correspond to the currently active contexts. - # For more information about context, see the - # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview). + # contexts that correspond to the currently active contexts. For more + # information about context, see the [Contexts guide](https://cloud.google.com/ + # dialogflow/docs/contexts-overview). class GoogleCloudDialogflowV2Context include Google::Apis::Core::Hashable - # Optional. The number of conversational query requests after which the - # context expires. The default is `0`. If set to `0`, the context expires - # immediately. Contexts expire automatically after 20 minutes if there - # are no matching queries. + # Optional. The number of conversational query requests after which the context + # expires. The default is `0`. If set to `0`, the context expires immediately. + # Contexts expire automatically after 20 minutes if there are no matching + # queries. # Corresponds to the JSON property `lifespanCount` # @return [Fixnum] attr_accessor :lifespan_count - # Required. The unique identifier of the context. Format: - # `projects//agent/sessions//contexts/`, - # or `projects//agent/environments//users//sessions//contexts/`. - # The `Context ID` is always converted to lowercase, may only contain - # characters in a-zA-Z0-9_-% and may be at most 250 bytes long. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # The following context names are reserved for internal use by Dialogflow. - # You should not use these contexts or create contexts with these names: - # * `__system_counters__` - # * `*_id_dialog_context` - # * `*_dialog_params_size` + # Required. The unique identifier of the context. Format: `projects//agent/ + # sessions//contexts/`, or `projects//agent/environments//users//sessions// + # contexts/`. The `Context ID` is always converted to lowercase, may only + # contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. The following context + # names are reserved for internal use by Dialogflow. You should not use these + # contexts or create contexts with these names: * `__system_counters__` * `* + # _id_dialog_context` * `*_dialog_params_size` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Optional. The collection of parameters associated with this context. - # Depending on your protocol or client library language, this is a - # map, associative array, symbol table, dictionary, or JSON object - # composed of a collection of (MapKey, MapValue) pairs: - # - MapKey type: string - # - MapKey value: parameter name - # - MapValue type: - # - If parameter's entity type is a composite entity: map - # - Else: string or number, depending on parameter value type - # - MapValue value: - # - If parameter's entity type is a composite entity: - # map from composite entity property names to property values - # - Else: parameter value + # Optional. The collection of parameters associated with this context. Depending + # on your protocol or client library language, this is a map, associative array, + # symbol table, dictionary, or JSON object composed of a collection of (MapKey, + # MapValue) pairs: - MapKey type: string - MapKey value: parameter name - + # MapValue type: - If parameter's entity type is a composite entity: map - Else: + # string or number, depending on parameter value type - MapValue value: - If + # parameter's entity type is a composite entity: map from composite entity + # property names to property values - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -929,19 +865,18 @@ module Google class GoogleCloudDialogflowV2ConversationEvent include Google::Apis::Core::Hashable - # The unique identifier of the conversation this notification - # refers to. - # Format: `projects//conversations/`. + # The unique identifier of the conversation this notification refers to. Format: + # `projects//conversations/`. # Corresponds to the JSON property `conversation` # @return [String] attr_accessor :conversation - # 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 `errorStatus` # @return [Google::Apis::DialogflowV2beta1::GoogleRpcStatus] attr_accessor :error_status @@ -970,20 +905,18 @@ module Google end # Each intent parameter has a type, called the entity type, which dictates - # exactly how data from an end-user expression is extracted. - # Dialogflow provides predefined system entities that can match many common - # types of data. For example, there are system entities for matching dates, - # times, colors, email addresses, and so on. You can also create your own - # custom entities for matching custom data. For example, you could define a - # vegetable entity that can match the types of vegetables available for - # purchase with a grocery store agent. - # For more information, see the - # [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview). + # exactly how data from an end-user expression is extracted. Dialogflow provides + # predefined system entities that can match many common types of data. For + # example, there are system entities for matching dates, times, colors, email + # addresses, and so on. You can also create your own custom entities for + # matching custom data. For example, you could define a vegetable entity that + # can match the types of vegetables available for purchase with a grocery store + # agent. For more information, see the [Entity guide](https://cloud.google.com/ + # dialogflow/docs/entities-overview). class GoogleCloudDialogflowV2EntityType include Google::Apis::Core::Hashable - # Optional. Indicates whether the entity type can be automatically - # expanded. + # Optional. Indicates whether the entity type can be automatically expanded. # Corresponds to the JSON property `autoExpansionMode` # @return [String] attr_accessor :auto_expansion_mode @@ -1009,10 +942,9 @@ module Google # @return [String] attr_accessor :kind - # The unique identifier of the entity type. - # Required for EntityTypes.UpdateEntityType and - # EntityTypes.BatchUpdateEntityTypes methods. - # Format: `projects//agent/entityTypes/`. + # The unique identifier of the entity type. Required for EntityTypes. + # UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: ` + # projects//agent/entityTypes/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1036,23 +968,19 @@ module Google class GoogleCloudDialogflowV2EntityTypeEntity include Google::Apis::Core::Hashable - # Required. A collection of value synonyms. For example, if the entity type - # is *vegetable*, and `value` is *scallions*, a synonym could be *green - # onions*. - # For `KIND_LIST` entity types: - # * This collection must contain exactly one synonym equal to `value`. + # Required. A collection of value synonyms. For example, if the entity type is * + # vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For + # `KIND_LIST` entity types: * This collection must contain exactly one synonym + # equal to `value`. # Corresponds to the JSON property `synonyms` # @return [Array] attr_accessor :synonyms - # Required. The primary value associated with this entity entry. - # For example, if the entity type is *vegetable*, the value could be - # *scallions*. - # For `KIND_MAP` entity types: - # * A reference value to be used in place of synonyms. - # For `KIND_LIST` entity types: - # * A string that can contain references to other entity types (with or - # without aliases). + # Required. The primary value associated with this entity entry. For example, if + # the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` + # entity types: * A reference value to be used in place of synonyms. For ` + # KIND_LIST` entity types: * A string that can contain references to other + # entity types (with or without aliases). # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -1069,17 +997,16 @@ module Google end # Events allow for matching intents by event name instead of the natural - # language input. For instance, input `` can trigger a personalized welcome response. - # The parameter `name` may be used by the agent in the response: - # `"Hello #welcome_event.name! What can I do for you today?"`. + # language input. For instance, input `` can trigger a personalized welcome + # response. The parameter `name` may be used by the agent in the response: `" + # Hello #welcome_event.name! What can I do for you today?"`. class GoogleCloudDialogflowV2EventInput include Google::Apis::Core::Hashable - # Required. The language of this query. See [Language - # Support](https://cloud.google.com/dialogflow/docs/reference/language) - # for a list of the currently supported language codes. Note that queries in - # the same session do not necessarily need to specify the same language. + # Required. The language of this query. See [Language Support](https://cloud. + # google.com/dialogflow/docs/reference/language) for a list of the currently + # supported language codes. Note that queries in the same session do not + # necessarily need to specify the same language. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -1089,19 +1016,14 @@ module Google # @return [String] attr_accessor :name - # The collection of parameters associated with the event. - # Depending on your protocol or client library language, this is a - # map, associative array, symbol table, dictionary, or JSON object - # composed of a collection of (MapKey, MapValue) pairs: - # - MapKey type: string - # - MapKey value: parameter name - # - MapValue type: - # - If parameter's entity type is a composite entity: map - # - Else: string or number, depending on parameter value type - # - MapValue value: - # - If parameter's entity type is a composite entity: - # map from composite entity property names to property values - # - Else: parameter value + # The collection of parameters associated with the event. Depending on your + # protocol or client library language, this is a map, associative array, symbol + # table, dictionary, or JSON object composed of a collection of (MapKey, + # MapValue) pairs: - MapKey type: string - MapKey value: parameter name - + # MapValue type: - If parameter's entity type is a composite entity: map - Else: + # string or number, depending on parameter value type - MapValue value: - If + # parameter's entity type is a composite entity: map from composite entity + # property names to property values - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -1128,8 +1050,8 @@ module Google # @return [String] attr_accessor :agent_content - # The URI to a file containing the exported agent. This field is populated - # only if `agent_uri` is specified in `ExportAgentRequest`. + # The URI to a file containing the exported agent. This field is populated only + # if `agent_uri` is specified in `ExportAgentRequest`. # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri @@ -1150,20 +1072,19 @@ module Google # complete conversation. When an end-user writes or says something, referred to # as an end-user expression or end-user input, Dialogflow matches the end-user # input to the best intent in your agent. Matching an intent is also known as - # intent classification. - # For more information, see the [intent - # guide](https://cloud.google.com/dialogflow/docs/intents-overview). + # intent classification. For more information, see the [intent guide](https:// + # cloud.google.com/dialogflow/docs/intents-overview). class GoogleCloudDialogflowV2Intent include Google::Apis::Core::Hashable - # Optional. The name of the action associated with the intent. - # Note: The action name must not contain whitespaces. + # Optional. The name of the action associated with the intent. Note: The action + # name must not contain whitespaces. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action - # Optional. The list of platforms for which the first responses will be - # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). + # Optional. The list of platforms for which the first responses will be copied + # from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). # Corresponds to the JSON property `defaultResponsePlatforms` # @return [Array] attr_accessor :default_response_platforms @@ -1173,23 +1094,22 @@ module Google # @return [String] attr_accessor :display_name - # Optional. The collection of event names that trigger the intent. - # If the collection of input contexts is not empty, all of the contexts must - # be present in the active user session for an event to trigger this intent. - # Event names are limited to 150 characters. + # Optional. The collection of event names that trigger the intent. If the + # collection of input contexts is not empty, all of the contexts must be present + # in the active user session for an event to trigger this intent. Event names + # are limited to 150 characters. # Corresponds to the JSON property `events` # @return [Array] attr_accessor :events - # Read-only. Information about all followup intents that have this intent as - # a direct or indirect parent. We populate this field only in the output. + # Read-only. Information about all followup intents that have this intent as a + # direct or indirect parent. We populate this field only in the output. # Corresponds to the JSON property `followupIntentInfo` # @return [Array] attr_accessor :followup_intent_info - # Optional. The list of context names required for this intent to be - # triggered. - # Format: `projects//agent/sessions/-/contexts/`. + # Optional. The list of context names required for this intent to be triggered. + # Format: `projects//agent/sessions/-/contexts/`. # Corresponds to the JSON property `inputContextNames` # @return [Array] attr_accessor :input_context_names @@ -1200,34 +1120,32 @@ module Google attr_accessor :is_fallback alias_method :is_fallback?, :is_fallback - # Optional. The collection of rich messages corresponding to the - # `Response` field in the Dialogflow console. + # Optional. The collection of rich messages corresponding to the `Response` + # field in the Dialogflow console. # Corresponds to the JSON property `messages` # @return [Array] attr_accessor :messages - # Optional. Indicates whether Machine Learning is disabled for the intent. - # Note: If `ml_disabled` setting is set to true, then this intent is not - # taken into account during inference in `ML ONLY` match mode. Also, - # auto-markup in the UI is turned off. + # Optional. Indicates whether Machine Learning is disabled for the intent. Note: + # If `ml_disabled` setting is set to true, then this intent is not taken into + # account during inference in `ML ONLY` match mode. Also, auto-markup in the UI + # is turned off. # Corresponds to the JSON property `mlDisabled` # @return [Boolean] attr_accessor :ml_disabled alias_method :ml_disabled?, :ml_disabled - # Optional. The unique identifier of this intent. - # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents - # methods. - # Format: `projects//agent/intents/`. + # Optional. The unique identifier of this intent. Required for Intents. + # UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/ + # intents/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Optional. The collection of contexts that are activated when the intent - # is matched. Context messages in this collection should not set the - # parameters field. Setting the `lifespan_count` to 0 will reset the context - # when the intent is matched. - # Format: `projects//agent/sessions/-/contexts/`. + # Optional. The collection of contexts that are activated when the intent is + # matched. Context messages in this collection should not set the parameters + # field. Setting the `lifespan_count` to 0 will reset the context when the + # intent is matched. Format: `projects//agent/sessions/-/contexts/`. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts @@ -1238,44 +1156,38 @@ module Google attr_accessor :parameters # Read-only after creation. The unique identifier of the parent intent in the - # chain of followup intents. You can set this field when creating an intent, - # for example with CreateIntent or - # BatchUpdateIntents, in order to make this - # intent a followup intent. - # It identifies the parent followup intent. - # Format: `projects//agent/intents/`. + # chain of followup intents. You can set this field when creating an intent, for + # example with CreateIntent or BatchUpdateIntents, in order to make this intent + # a followup intent. It identifies the parent followup intent. Format: `projects/ + # /agent/intents/`. # Corresponds to the JSON property `parentFollowupIntentName` # @return [String] attr_accessor :parent_followup_intent_name # Optional. The priority of this intent. Higher numbers represent higher - # priorities. - # - If the supplied value is unspecified or 0, the service - # translates the value to 500,000, which corresponds to the - # `Normal` priority in the console. - # - If the supplied value is negative, the intent is ignored - # in runtime detect intent requests. + # priorities. - If the supplied value is unspecified or 0, the service + # translates the value to 500,000, which corresponds to the `Normal` priority in + # the console. - If the supplied value is negative, the intent is ignored in + # runtime detect intent requests. # Corresponds to the JSON property `priority` # @return [Fixnum] attr_accessor :priority - # Optional. Indicates whether to delete all contexts in the current - # session when this intent is matched. + # Optional. Indicates whether to delete all contexts in the current session when + # this intent is matched. # Corresponds to the JSON property `resetContexts` # @return [Boolean] attr_accessor :reset_contexts alias_method :reset_contexts?, :reset_contexts - # Read-only. The unique identifier of the root intent in the chain of - # followup intents. It identifies the correct followup intents chain for - # this intent. We populate this field only in the output. - # Format: `projects//agent/intents/`. + # Read-only. The unique identifier of the root intent in the chain of followup + # intents. It identifies the correct followup intents chain for this intent. We + # populate this field only in the output. Format: `projects//agent/intents/`. # Corresponds to the JSON property `rootFollowupIntentName` # @return [String] attr_accessor :root_followup_intent_name - # Optional. The collection of examples that the agent is - # trained on. + # Optional. The collection of examples that the agent is trained on. # Corresponds to the JSON property `trainingPhrases` # @return [Array] attr_accessor :training_phrases @@ -1316,14 +1228,14 @@ module Google class GoogleCloudDialogflowV2IntentFollowupIntentInfo include Google::Apis::Core::Hashable - # The unique identifier of the followup intent. - # Format: `projects//agent/intents/`. + # The unique identifier of the followup intent. Format: `projects//agent/intents/ + # `. # Corresponds to the JSON property `followupIntentName` # @return [String] attr_accessor :followup_intent_name - # The unique identifier of the followup intent's parent. - # Format: `projects//agent/intents/`. + # The unique identifier of the followup intent's parent. Format: `projects// + # agent/intents/`. # Corresponds to the JSON property `parentFollowupIntentName` # @return [String] attr_accessor :parent_followup_intent_name @@ -1339,11 +1251,9 @@ module Google end end - # A rich response message. - # Corresponds to the intent `Response` field in the Dialogflow console. - # For more information, see - # [Rich response - # messages](https://cloud.google.com/dialogflow/docs/intents-rich-messages). + # A rich response message. Corresponds to the intent `Response` field in the + # Dialogflow console. For more information, see [Rich response messages](https:// + # cloud.google.com/dialogflow/docs/intents-rich-messages). class GoogleCloudDialogflowV2IntentMessage include Google::Apis::Core::Hashable @@ -1352,8 +1262,8 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentMessageBasicCard] attr_accessor :basic_card - # Browse Carousel Card for Actions on Google. - # https://developers.google.com/actions/assistant/responses#browsing_carousel + # Browse Carousel Card for Actions on Google. https://developers.google.com/ + # actions/assistant/responses#browsing_carousel # Corresponds to the JSON property `browseCarouselCard` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard] attr_accessor :browse_carousel_card @@ -1373,8 +1283,8 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentMessageImage] attr_accessor :image - # The suggestion chip message that allows the user to jump out to the app - # or website associated with this agent. + # The suggestion chip message that allows the user to jump out to the app or + # website associated with this agent. # Corresponds to the JSON property `linkOutSuggestion` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion] attr_accessor :link_out_suggestion @@ -1404,10 +1314,9 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentMessageQuickReplies] attr_accessor :quick_replies - # The collection of simple response candidates. - # This message in `QueryResult.fulfillment_messages` and - # `WebhookResponse.fulfillment_messages` should contain only one - # `SimpleResponse`. + # The collection of simple response candidates. This message in `QueryResult. + # fulfillment_messages` and `WebhookResponse.fulfillment_messages` should + # contain only one `SimpleResponse`. # Corresponds to the JSON property `simpleResponses` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentMessageSimpleResponses] attr_accessor :simple_responses @@ -1538,19 +1447,18 @@ module Google end end - # Browse Carousel Card for Actions on Google. - # https://developers.google.com/actions/assistant/responses#browsing_carousel + # Browse Carousel Card for Actions on Google. https://developers.google.com/ + # actions/assistant/responses#browsing_carousel class GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard include Google::Apis::Core::Hashable - # Optional. Settings for displaying the image. Applies to every image in - # items. + # Optional. Settings for displaying the image. Applies to every image in items. # Corresponds to the JSON property `imageDisplayOptions` # @return [String] attr_accessor :image_display_options - # Required. List of items in the Browse Carousel Card. Minimum of two - # items, maximum of ten. + # Required. List of items in the Browse Carousel Card. Minimum of two items, + # maximum of ten. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items @@ -1570,14 +1478,13 @@ module Google class GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem include Google::Apis::Core::Hashable - # Optional. Description of the carousel item. Maximum of four lines of - # text. + # Optional. Description of the carousel item. Maximum of four lines of text. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional. Text that appears at the bottom of the Browse Carousel - # Card. Maximum of one line of text. + # Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum + # of one line of text. # Corresponds to the JSON property `footer` # @return [String] attr_accessor :footer @@ -1620,8 +1527,8 @@ module Google # @return [String] attr_accessor :url - # Optional. Specifies the type of viewer that is used when opening - # the URL. Defaults to opening via web browser. + # Optional. Specifies the type of viewer that is used when opening the URL. + # Defaults to opening via web browser. # Corresponds to the JSON property `urlTypeHint` # @return [String] attr_accessor :url_type_hint @@ -1678,8 +1585,7 @@ module Google class GoogleCloudDialogflowV2IntentMessageCardButton include Google::Apis::Core::Hashable - # Optional. The text to send back to the Dialogflow API or a URI to - # open. + # Optional. The text to send back to the Dialogflow API or a URI to open. # Corresponds to the JSON property `postback` # @return [String] attr_accessor :postback @@ -1733,8 +1639,7 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentMessageImage] attr_accessor :image - # Additional info about the select item for when it is triggered in a - # dialog. + # Additional info about the select item for when it is triggered in a dialog. # Corresponds to the JSON property `info` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentMessageSelectItemInfo] attr_accessor :info @@ -1786,8 +1691,8 @@ module Google class GoogleCloudDialogflowV2IntentMessageImage include Google::Apis::Core::Hashable - # Optional. A text description of the image to be used for accessibility, - # e.g., screen readers. + # Optional. A text description of the image to be used for accessibility, e.g., + # screen readers. # Corresponds to the JSON property `accessibilityText` # @return [String] attr_accessor :accessibility_text @@ -1808,8 +1713,8 @@ module Google end end - # The suggestion chip message that allows the user to jump out to the app - # or website associated with this agent. + # The suggestion chip message that allows the user to jump out to the app or + # website associated with this agent. class GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion include Google::Apis::Core::Hashable @@ -1818,8 +1723,8 @@ module Google # @return [String] attr_accessor :destination_name - # Required. The URI of the app or site to open when the user taps the - # suggestion chip. + # Required. The URI of the app or site to open when the user taps the suggestion + # chip. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -1880,8 +1785,7 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentMessageImage] attr_accessor :image - # Additional info about the select item for when it is triggered in a - # dialog. + # Additional info about the select item for when it is triggered in a dialog. # Corresponds to the JSON property `info` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2IntentMessageSelectItemInfo] attr_accessor :info @@ -1997,19 +1901,18 @@ module Google end end - # Additional info about the select item for when it is triggered in a - # dialog. + # Additional info about the select item for when it is triggered in a dialog. class GoogleCloudDialogflowV2IntentMessageSelectItemInfo include Google::Apis::Core::Hashable - # Required. A unique key that will be sent back to the agent if this - # response is given. + # Required. A unique key that will be sent back to the agent if this response is + # given. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key - # Optional. A list of synonyms that can also be used to trigger this - # item in dialog. + # Optional. A list of synonyms that can also be used to trigger this item in + # dialog. # Corresponds to the JSON property `synonyms` # @return [Array] attr_accessor :synonyms @@ -2034,15 +1937,14 @@ module Google # @return [String] attr_accessor :display_text - # One of text_to_speech or ssml must be provided. Structured spoken - # response to the user in the SSML format. Mutually exclusive with - # text_to_speech. + # One of text_to_speech or ssml must be provided. Structured spoken response to + # the user in the SSML format. Mutually exclusive with text_to_speech. # Corresponds to the JSON property `ssml` # @return [String] attr_accessor :ssml - # One of text_to_speech or ssml must be provided. The plain text of the - # speech output. Mutually exclusive with ssml. + # One of text_to_speech or ssml must be provided. The plain text of the speech + # output. Mutually exclusive with ssml. # Corresponds to the JSON property `textToSpeech` # @return [String] attr_accessor :text_to_speech @@ -2059,10 +1961,9 @@ module Google end end - # The collection of simple response candidates. - # This message in `QueryResult.fulfillment_messages` and - # `WebhookResponse.fulfillment_messages` should contain only one - # `SimpleResponse`. + # The collection of simple response candidates. This message in `QueryResult. + # fulfillment_messages` and `WebhookResponse.fulfillment_messages` should + # contain only one `SimpleResponse`. class GoogleCloudDialogflowV2IntentMessageSimpleResponses include Google::Apis::Core::Hashable @@ -2081,8 +1982,8 @@ module Google end end - # The suggestion chip message that the user can tap to quickly post a reply - # to the conversation. + # The suggestion chip message that the user can tap to quickly post a reply to + # the conversation. class GoogleCloudDialogflowV2IntentMessageSuggestion include Google::Apis::Core::Hashable @@ -2237,10 +2138,9 @@ module Google class GoogleCloudDialogflowV2IntentParameter include Google::Apis::Core::Hashable - # Optional. The default value to use when the `value` yields an empty - # result. - # Default values can be extracted from contexts by using the following - # syntax: `#context_name.parameter_name`. + # Optional. The default value to use when the `value` yields an empty result. + # Default values can be extracted from contexts by using the following syntax: `# + # context_name.parameter_name`. # Corresponds to the JSON property `defaultValue` # @return [String] attr_accessor :default_value @@ -2250,9 +2150,8 @@ module Google # @return [String] attr_accessor :display_name - # Optional. The name of the entity type, prefixed with `@`, that - # describes values of the parameter. If the parameter is - # required, this must be provided. + # Optional. The name of the entity type, prefixed with `@`, that describes + # values of the parameter. If the parameter is required, this must be provided. # Corresponds to the JSON property `entityTypeDisplayName` # @return [String] attr_accessor :entity_type_display_name @@ -2263,9 +2162,8 @@ module Google attr_accessor :is_list alias_method :is_list?, :is_list - # Optional. Indicates whether the parameter is required. That is, - # whether the intent cannot be completed without collecting the parameter - # value. + # Optional. Indicates whether the parameter is required. That is, whether the + # intent cannot be completed without collecting the parameter value. # Corresponds to the JSON property `mandatory` # @return [Boolean] attr_accessor :mandatory @@ -2276,18 +2174,16 @@ module Google # @return [String] attr_accessor :name - # Optional. The collection of prompts that the agent can present to the - # user in order to collect a value for the parameter. + # Optional. The collection of prompts that the agent can present to the user in + # order to collect a value for the parameter. # Corresponds to the JSON property `prompts` # @return [Array] attr_accessor :prompts - # Optional. The definition of the parameter value. It can be: - # - a constant string, - # - a parameter value defined as `$parameter_name`, - # - an original parameter value defined as `$parameter_name.original`, - # - a parameter value from some context defined as - # `#context_name.parameter_name`. + # Optional. The definition of the parameter value. It can be: - a constant + # string, - a parameter value defined as `$parameter_name`, - an original + # parameter value defined as `$parameter_name.original`, - a parameter value + # from some context defined as `#context_name.parameter_name`. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -2318,27 +2214,25 @@ module Google # @return [String] attr_accessor :name - # Required. The ordered list of training phrase parts. - # The parts are concatenated in order to form the training phrase. - # Note: The API does not automatically annotate training phrases like the - # Dialogflow Console does. - # Note: Do not forget to include whitespace at part boundaries, - # so the training phrase is well formatted when the parts are concatenated. - # If the training phrase does not need to be annotated with parameters, - # you just need a single part with only the Part.text field set. - # If you want to annotate the training phrase, you must create multiple - # parts, where the fields of each part are populated in one of two ways: - # - `Part.text` is set to a part of the phrase that has no parameters. - # - `Part.text` is set to a part of the phrase that you want to annotate, - # and the `entity_type`, `alias`, and `user_defined` fields are all - # set. + # Required. The ordered list of training phrase parts. The parts are + # concatenated in order to form the training phrase. Note: The API does not + # automatically annotate training phrases like the Dialogflow Console does. Note: + # Do not forget to include whitespace at part boundaries, so the training + # phrase is well formatted when the parts are concatenated. If the training + # phrase does not need to be annotated with parameters, you just need a single + # part with only the Part.text field set. If you want to annotate the training + # phrase, you must create multiple parts, where the fields of each part are + # populated in one of two ways: - `Part.text` is set to a part of the phrase + # that has no parameters. - `Part.text` is set to a part of the phrase that you + # want to annotate, and the `entity_type`, `alias`, and `user_defined` fields + # are all set. # Corresponds to the JSON property `parts` # @return [Array] attr_accessor :parts - # Optional. Indicates how many times this example was added to - # the intent. Each time a developer adds an existing sample by editing an - # intent or training, this counter is increased. + # Optional. Indicates how many times this example was added to the intent. Each + # time a developer adds an existing sample by editing an intent or training, + # this counter is increased. # Corresponds to the JSON property `timesAddedCount` # @return [Fixnum] attr_accessor :times_added_count @@ -2365,15 +2259,15 @@ module Google class GoogleCloudDialogflowV2IntentTrainingPhrasePart include Google::Apis::Core::Hashable - # Optional. The parameter name for the value extracted from the - # annotated part of the example. - # This field is required for annotated parts of the training phrase. + # Optional. The parameter name for the value extracted from the annotated part + # of the example. This field is required for annotated parts of the training + # phrase. # Corresponds to the JSON property `alias` # @return [String] attr_accessor :alias - # Optional. The entity type name prefixed with `@`. - # This field is required for annotated parts of the training phrase. + # Optional. The entity type name prefixed with `@`. This field is required for + # annotated parts of the training phrase. # Corresponds to the JSON property `entityType` # @return [String] attr_accessor :entity_type @@ -2383,10 +2277,9 @@ module Google # @return [String] attr_accessor :text - # Optional. Indicates whether the text was manually annotated. - # This field is set to true when the Dialogflow Console is used to - # manually annotate the part. When creating an annotated part with the - # API, you must set this to true. + # Optional. Indicates whether the text was manually annotated. This field is set + # to true when the Dialogflow Console is used to manually annotate the part. + # When creating an annotated part with the API, you must set this to true. # Corresponds to the JSON property `userDefined` # @return [Boolean] attr_accessor :user_defined @@ -2419,9 +2312,8 @@ module Google # @return [String] attr_accessor :create_time - # Optional. The message language. - # This should be a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) - # language tag. Example: "en-US". + # Optional. The message language. This should be a [BCP-47](https://www.rfc- + # editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -2431,9 +2323,8 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2MessageAnnotation] attr_accessor :message_annotation - # The unique identifier of the message. - # Format: `projects//conversations//messages/`. + # The unique identifier of the message. Format: `projects//conversations// + # messages/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2474,9 +2365,9 @@ module Google attr_accessor :contain_entities alias_method :contain_entities?, :contain_entities - # The collection of annotated message parts ordered by their - # position in the message. You can recover the annotated message by - # concatenating [AnnotatedMessagePart.text]. + # The collection of annotated message parts ordered by their position in the + # message. You can recover the annotated message by concatenating [ + # AnnotatedMessagePart.text]. # Corresponds to the JSON property `parts` # @return [Array] attr_accessor :parts @@ -2492,36 +2383,30 @@ module Google end end - # Represents the contents of the original request that was passed to - # the `[Streaming]DetectIntent` call. + # Represents the contents of the original request that was passed to the `[ + # Streaming]DetectIntent` call. class GoogleCloudDialogflowV2OriginalDetectIntentRequest include Google::Apis::Core::Hashable # Optional. This field is set to the value of the `QueryParameters.payload` - # field passed in the request. Some integrations that query a Dialogflow - # agent may provide additional information in the payload. - # In particular, for the Dialogflow Phone Gateway integration, this field has - # the form: - # 
`
-        # "telephony": `
-        # "caller_id": "+18558363987"
-        # `
-        # `
- # Note: The caller ID field (`caller_id`) will be redacted for Standard - # Edition agents and populated with the caller ID in [E.164 - # format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. + # field passed in the request. Some integrations that query a Dialogflow agent + # may provide additional information in the payload. In particular, for the + # Dialogflow Phone Gateway integration, this field has the form: ` "telephony": ` + # "caller_id": "+18558363987" ` ` Note: The caller ID field (`caller_id`) will + # be redacted for Standard Edition agents and populated with the caller ID in [E. + # 164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload - # The source of this request, e.g., `google`, `facebook`, `slack`. It is set - # by Dialogflow-owned servers. + # The source of this request, e.g., `google`, `facebook`, `slack`. It is set by + # Dialogflow-owned servers. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source - # Optional. The version of the protocol used for this request. - # This field is AoG-specific. + # Optional. The version of the protocol used for this request. This field is AoG- + # specific. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -2547,22 +2432,19 @@ module Google # @return [String] attr_accessor :action - # This field is set to: - # - `false` if the matched intent has required parameters and not all of - # the required parameter values have been collected. - # - `true` if all required parameter values have been collected, or if the - # matched intent doesn't contain any required parameters. + # This field is set to: - `false` if the matched intent has required parameters + # and not all of the required parameter values have been collected. - `true` if + # all required parameter values have been collected, or if the matched intent + # doesn't contain any required parameters. # Corresponds to the JSON property `allRequiredParamsPresent` # @return [Boolean] attr_accessor :all_required_params_present alias_method :all_required_params_present?, :all_required_params_present - # Free-form diagnostic information for the associated detect intent request. - # The fields of this data can change without notice, so you should not write - # code that depends on its structure. - # The data may contain: - # - webhook call latency - # - webhook errors + # Free-form diagnostic information for the associated detect intent request. The + # fields of this data can change without notice, so you should not write code + # that depends on its structure. The data may contain: - webhook call latency - + # webhook errors # Corresponds to the JSON property `diagnosticInfo` # @return [Hash] attr_accessor :diagnostic_info @@ -2572,8 +2454,8 @@ module Google # @return [Array] attr_accessor :fulfillment_messages - # The text to be pronounced to the user or shown on the screen. - # Note: This is a legacy field, `fulfillment_messages` should be preferred. + # The text to be pronounced to the user or shown on the screen. Note: This is a + # legacy field, `fulfillment_messages` should be preferred. # Corresponds to the JSON property `fulfillmentText` # @return [String] attr_accessor :fulfillment_text @@ -2583,79 +2465,66 @@ module Google # complete conversation. When an end-user writes or says something, referred to # as an end-user expression or end-user input, Dialogflow matches the end-user # input to the best intent in your agent. Matching an intent is also known as - # intent classification. - # For more information, see the [intent - # guide](https://cloud.google.com/dialogflow/docs/intents-overview). + # intent classification. For more information, see the [intent guide](https:// + # cloud.google.com/dialogflow/docs/intents-overview). # Corresponds to the JSON property `intent` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2Intent] attr_accessor :intent - # The intent detection confidence. Values range from 0.0 - # (completely uncertain) to 1.0 (completely certain). - # This value is for informational purpose only and is only used to - # help match the best intent within the classification threshold. + # The intent detection confidence. Values range from 0.0 (completely uncertain) + # to 1.0 (completely certain). This value is for informational purpose only and + # is only used to help match the best intent within the classification threshold. # This value may change for the same end-user expression at any time due to a - # model retraining or change in implementation. - # If there are `multiple knowledge_answers` messages, this value is set to - # the greatest `knowledgeAnswers.match_confidence` value in the list. + # model retraining or change in implementation. If there are `multiple + # knowledge_answers` messages, this value is set to the greatest ` + # knowledgeAnswers.match_confidence` value in the list. # Corresponds to the JSON property `intentDetectionConfidence` # @return [Float] attr_accessor :intent_detection_confidence - # The language that was triggered during intent detection. - # See [Language - # Support](https://cloud.google.com/dialogflow/docs/reference/language) - # for a list of the currently supported language codes. + # The language that was triggered during intent detection. See [Language Support] + # (https://cloud.google.com/dialogflow/docs/reference/language) for a list of + # the currently supported language codes. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # The collection of output contexts. If applicable, - # `output_contexts.parameters` contains entries with name - # `.original` containing the original parameter values - # before the query. + # The collection of output contexts. If applicable, `output_contexts.parameters` + # contains entries with name `.original` containing the original parameter + # values before the query. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts - # The collection of extracted parameters. - # Depending on your protocol or client library language, this is a - # map, associative array, symbol table, dictionary, or JSON object - # composed of a collection of (MapKey, MapValue) pairs: - # - MapKey type: string - # - MapKey value: parameter name - # - MapValue type: - # - If parameter's entity type is a composite entity: map - # - Else: string or number, depending on parameter value type - # - MapValue value: - # - If parameter's entity type is a composite entity: - # map from composite entity property names to property values - # - Else: parameter value + # The collection of extracted parameters. Depending on your protocol or client + # library language, this is a map, associative array, symbol table, dictionary, + # or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey + # type: string - MapKey value: parameter name - MapValue type: - If parameter's + # entity type is a composite entity: map - Else: string or number, depending on + # parameter value type - MapValue value: - If parameter's entity type is a + # composite entity: map from composite entity property names to property values - + # Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters - # The original conversational query text: - # - If natural language text was provided as input, `query_text` contains - # a copy of the input. - # - If natural language speech audio was provided as input, `query_text` - # contains the speech recognition result. If speech recognizer produced - # multiple alternatives, a particular one is picked. - # - If automatic spell correction is enabled, `query_text` will contain the - # corrected user input. + # The original conversational query text: - If natural language text was + # provided as input, `query_text` contains a copy of the input. - If natural + # language speech audio was provided as input, `query_text` contains the speech + # recognition result. If speech recognizer produced multiple alternatives, a + # particular one is picked. - If automatic spell correction is enabled, ` + # query_text` will contain the corrected user input. # Corresponds to the JSON property `queryText` # @return [String] attr_accessor :query_text - # The result of sentiment analysis. Sentiment analysis inspects user input - # and identifies the prevailing subjective opinion, especially to determine a - # user's attitude as positive, negative, or neutral. - # For Participants.AnalyzeContent, it needs to be configured in - # DetectIntentRequest.query_params. For - # Participants.StreamingAnalyzeContent, it needs to be configured in - # StreamingDetectIntentRequest.query_params. - # And for Participants.AnalyzeContent and + # The result of sentiment analysis. Sentiment analysis inspects user input and + # identifies the prevailing subjective opinion, especially to determine a user's + # attitude as positive, negative, or neutral. For Participants.AnalyzeContent, + # it needs to be configured in DetectIntentRequest.query_params. For # Participants.StreamingAnalyzeContent, it needs to be configured in + # StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent + # and Participants.StreamingAnalyzeContent, it needs to be configured in # ConversationProfile.human_agent_assistant_config # Corresponds to the JSON property `sentimentAnalysisResult` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2SentimentAnalysisResult] @@ -2663,24 +2532,23 @@ module Google # The Speech recognition confidence between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. The default of 0.0 is a sentinel value indicating that confidence - # was not set. - # This field is not guaranteed to be accurate or set. In particular this - # field isn't set for StreamingDetectIntent since the streaming endpoint has - # separate confidence estimates per portion of the audio in + # correct. The default of 0.0 is a sentinel value indicating that confidence was + # not set. This field is not guaranteed to be accurate or set. In particular + # this field isn't set for StreamingDetectIntent since the streaming endpoint + # has separate confidence estimates per portion of the audio in # StreamingRecognitionResult. # Corresponds to the JSON property `speechRecognitionConfidence` # @return [Float] attr_accessor :speech_recognition_confidence - # If the query was fulfilled by a webhook call, this field is set to the - # value of the `payload` field returned in the webhook response. + # If the query was fulfilled by a webhook call, this field is set to the value + # of the `payload` field returned in the webhook response. # Corresponds to the JSON property `webhookPayload` # @return [Hash] attr_accessor :webhook_payload - # If the query was fulfilled by a webhook call, this field is set to the - # value of the `source` field returned in the webhook response. + # If the query was fulfilled by a webhook call, this field is set to the value + # of the `source` field returned in the webhook response. # Corresponds to the JSON property `webhookSource` # @return [String] attr_accessor :webhook_source @@ -2709,8 +2577,8 @@ module Google end end - # The sentiment, such as positive/negative feeling or association, for a unit - # of analysis, such as the query text. + # The sentiment, such as positive/negative feeling or association, for a unit of + # analysis, such as the query text. class GoogleCloudDialogflowV2Sentiment include Google::Apis::Core::Hashable @@ -2720,8 +2588,7 @@ module Google # @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 @@ -2737,21 +2604,19 @@ module Google end end - # The result of sentiment analysis. Sentiment analysis inspects user input - # and identifies the prevailing subjective opinion, especially to determine a - # user's attitude as positive, negative, or neutral. - # For Participants.AnalyzeContent, it needs to be configured in - # DetectIntentRequest.query_params. For - # Participants.StreamingAnalyzeContent, it needs to be configured in - # StreamingDetectIntentRequest.query_params. - # And for Participants.AnalyzeContent and + # The result of sentiment analysis. Sentiment analysis inspects user input and + # identifies the prevailing subjective opinion, especially to determine a user's + # attitude as positive, negative, or neutral. For Participants.AnalyzeContent, + # it needs to be configured in DetectIntentRequest.query_params. For # Participants.StreamingAnalyzeContent, it needs to be configured in + # StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent + # and Participants.StreamingAnalyzeContent, it needs to be configured in # ConversationProfile.human_agent_assistant_config class GoogleCloudDialogflowV2SentimentAnalysisResult include Google::Apis::Core::Hashable - # The sentiment, such as positive/negative feeling or association, for a unit - # of analysis, such as the query text. + # The sentiment, such as positive/negative feeling or association, for a unit of + # analysis, such as the query text. # Corresponds to the JSON property `queryTextSentiment` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2Sentiment] attr_accessor :query_text_sentiment @@ -2766,37 +2631,33 @@ module Google end end - # A session represents a conversation between a Dialogflow agent and an - # end-user. You can create special entities, called session entities, during a - # session. Session entities can extend or replace custom entity types and only - # exist during the session that they were created for. All session data, - # including session entities, is stored by Dialogflow for 20 minutes. - # For more information, see the [session entity - # guide](https://cloud.google.com/dialogflow/docs/entities-session). + # A session represents a conversation between a Dialogflow agent and an end-user. + # You can create special entities, called session entities, during a session. + # Session entities can extend or replace custom entity types and only exist + # during the session that they were created for. All session data, including + # session entities, is stored by Dialogflow for 20 minutes. For more information, + # see the [session entity guide](https://cloud.google.com/dialogflow/docs/ + # entities-session). class GoogleCloudDialogflowV2SessionEntityType include Google::Apis::Core::Hashable - # Required. The collection of entities associated with this session entity - # type. + # Required. The collection of entities associated with this session entity type. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities - # Required. Indicates whether the additional data should override or - # supplement the custom entity type definition. + # Required. Indicates whether the additional data should override or supplement + # the custom entity type definition. # Corresponds to the JSON property `entityOverrideMode` # @return [String] attr_accessor :entity_override_mode - # Required. The unique identifier of this session entity type. Format: - # `projects//agent/sessions//entityTypes/`, or `projects//agent/environments//users//sessions//entityTypes/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # `` must be the display name of an existing entity - # type in the same agent that will be overridden or supplemented. + # Required. The unique identifier of this session entity type. Format: `projects/ + # /agent/sessions//entityTypes/`, or `projects//agent/environments//users// + # sessions//entityTypes/`. If `Environment ID` is not specified, we assume + # default 'draft' environment. If `User ID` is not specified, we assume default ' + # -' user. `` must be the display name of an existing entity type in the same + # agent that will be overridden or supplemented. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2817,8 +2678,8 @@ module Google class GoogleCloudDialogflowV2WebhookRequest include Google::Apis::Core::Hashable - # Represents the contents of the original request that was passed to - # the `[Streaming]DetectIntent` call. + # Represents the contents of the original request that was passed to the `[ + # Streaming]DetectIntent` call. # Corresponds to the JSON property `originalDetectIntentRequest` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2OriginalDetectIntentRequest] attr_accessor :original_detect_intent_request @@ -2828,17 +2689,15 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2QueryResult] attr_accessor :query_result - # The unique identifier of the response. Contains the same value as - # `[Streaming]DetectIntentResponse.response_id`. + # The unique identifier of the response. Contains the same value as `[Streaming] + # DetectIntentResponse.response_id`. # Corresponds to the JSON property `responseId` # @return [String] attr_accessor :response_id - # The unique identifier of detectIntent request session. - # Can be used to identify end-user inside webhook implementation. - # Format: `projects//agent/sessions/`, or - # `projects//agent/environments//users//sessions/`. + # The unique identifier of detectIntent request session. Can be used to identify + # end-user inside webhook implementation. Format: `projects//agent/sessions/`, + # or `projects//agent/environments//users//sessions/`. # Corresponds to the JSON property `session` # @return [String] attr_accessor :session @@ -2856,79 +2715,70 @@ module Google end end - # The response message for a webhook call. - # This response is validated by the Dialogflow server. If validation fails, - # an error will be returned in the QueryResult.diagnostic_info field. - # Setting JSON fields to an empty value with the wrong type is a common error. - # To avoid this error: - # - Use `""` for empty strings - # - Use ```` or `null` for empty objects - # - Use `[]` or `null` for empty arrays - # For more information, see the - # [Protocol Buffers Language - # Guide](https://developers.google.com/protocol-buffers/docs/proto3#json). + # The response message for a webhook call. This response is validated by the + # Dialogflow server. If validation fails, an error will be returned in the + # QueryResult.diagnostic_info field. Setting JSON fields to an empty value with + # the wrong type is a common error. To avoid this error: - Use `""` for empty + # strings - Use ```` or `null` for empty objects - Use `[]` or `null` for empty + # arrays For more information, see the [Protocol Buffers Language Guide](https:// + # developers.google.com/protocol-buffers/docs/proto3#json). class GoogleCloudDialogflowV2WebhookResponse include Google::Apis::Core::Hashable # Events allow for matching intents by event name instead of the natural - # language input. For instance, input `` can trigger a personalized welcome response. - # The parameter `name` may be used by the agent in the response: - # `"Hello #welcome_event.name! What can I do for you today?"`. + # language input. For instance, input `` can trigger a personalized welcome + # response. The parameter `name` may be used by the agent in the response: `" + # Hello #welcome_event.name! What can I do for you today?"`. # Corresponds to the JSON property `followupEventInput` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2EventInput] attr_accessor :followup_event_input - # Optional. The rich response messages intended for the end-user. - # When provided, Dialogflow uses this field to populate - # QueryResult.fulfillment_messages sent to the integration or API caller. + # Optional. The rich response messages intended for the end-user. When provided, + # Dialogflow uses this field to populate QueryResult.fulfillment_messages sent + # to the integration or API caller. # Corresponds to the JSON property `fulfillmentMessages` # @return [Array] attr_accessor :fulfillment_messages - # Optional. The text response message intended for the end-user. - # It is recommended to use `fulfillment_messages.text.text[0]` instead. - # When provided, Dialogflow uses this field to populate - # QueryResult.fulfillment_text sent to the integration or API caller. + # Optional. The text response message intended for the end-user. It is + # recommended to use `fulfillment_messages.text.text[0]` instead. When provided, + # Dialogflow uses this field to populate QueryResult.fulfillment_text sent to + # the integration or API caller. # Corresponds to the JSON property `fulfillmentText` # @return [String] attr_accessor :fulfillment_text # Optional. The collection of output contexts that will overwrite currently - # active contexts for the session and reset their lifespans. - # When provided, Dialogflow uses this field to populate - # QueryResult.output_contexts sent to the integration or API caller. + # active contexts for the session and reset their lifespans. When provided, + # Dialogflow uses this field to populate QueryResult.output_contexts sent to the + # integration or API caller. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts # Optional. This field can be used to pass custom data from your webhook to the - # integration or API caller. Arbitrary JSON objects are supported. - # When provided, Dialogflow uses this field to populate - # QueryResult.webhook_payload sent to the integration or API caller. - # This field is also used by the - # [Google Assistant - # integration](https://cloud.google.com/dialogflow/docs/integrations/aog) - # for rich response messages. - # See the format definition at [Google Assistant Dialogflow webhook - # format](https://developers.google.com/assistant/actions/build/json/dialogflow- - # webhook-json) + # integration or API caller. Arbitrary JSON objects are supported. When provided, + # Dialogflow uses this field to populate QueryResult.webhook_payload sent to + # the integration or API caller. This field is also used by the [Google + # Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/ + # aog) for rich response messages. See the format definition at [Google + # Assistant Dialogflow webhook format](https://developers.google.com/assistant/ + # actions/build/json/dialogflow-webhook-json) # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload # Optional. Additional session entity types to replace or extend developer - # entity types with. The entity synonyms apply to all languages and persist - # for the session. Setting this data from a webhook overwrites - # the session entity types that have been set using `detectIntent`, - # `streamingDetectIntent` or SessionEntityType management methods. + # entity types with. The entity synonyms apply to all languages and persist for + # the session. Setting this data from a webhook overwrites the session entity + # types that have been set using `detectIntent`, `streamingDetectIntent` or + # SessionEntityType management methods. # Corresponds to the JSON property `sessionEntityTypes` # @return [Array] attr_accessor :session_entity_types - # Optional. A custom field used to identify the webhook source. - # Arbitrary strings are supported. - # When provided, Dialogflow uses this field to populate + # Optional. A custom field used to identify the webhook source. Arbitrary + # strings are supported. When provided, Dialogflow uses this field to populate # QueryResult.webhook_source sent to the integration or API caller. # Corresponds to the JSON property `source` # @return [String] @@ -2950,30 +2800,27 @@ module Google end end - # A Dialogflow agent is a virtual agent that handles conversations with your - # end-users. It is a natural language understanding module that understands the - # nuances of human language. Dialogflow translates end-user text or audio - # during a conversation to structured data that your apps and services can - # understand. You design and build a Dialogflow agent to handle the types of - # conversations required for your system. - # For more information about agents, see the - # [Agent guide](https://cloud.google.com/dialogflow/docs/agents-overview). + # A Dialogflow agent is a virtual agent that handles conversations with your end- + # users. It is a natural language understanding module that understands the + # nuances of human language. Dialogflow translates end-user text or audio during + # a conversation to structured data that your apps and services can understand. + # You design and build a Dialogflow agent to handle the types of conversations + # required for your system. For more information about agents, see the [Agent + # guide](https://cloud.google.com/dialogflow/docs/agents-overview). class GoogleCloudDialogflowV2beta1Agent include Google::Apis::Core::Hashable - # Optional. API version displayed in Dialogflow console. If not specified, - # V2 API is assumed. Clients are free to query different service endpoints - # for different API versions. However, bots connectors and webhook calls will - # follow the specified API version. + # Optional. API version displayed in Dialogflow console. If not specified, V2 + # API is assumed. Clients are free to query different service endpoints for + # different API versions. However, bots connectors and webhook calls will follow + # the specified API version. # Corresponds to the JSON property `apiVersion` # @return [String] attr_accessor :api_version - # Optional. The URI of the agent's avatar. - # Avatars are used throughout the Dialogflow console and in the self-hosted - # [Web - # Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) - # integration. + # Optional. The URI of the agent's avatar. Avatars are used throughout the + # Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/ + # dialogflow/docs/integrations/web-demo) integration. # Corresponds to the JSON property `avatarUri` # @return [String] attr_accessor :avatar_uri @@ -2981,25 +2828,24 @@ module Google # Optional. To filter out false positive results and still get variety in # matched natural language inputs for your agent, you can tune the machine # learning classification threshold. If the returned score value is less than - # the threshold value, then a fallback intent will be triggered or, if there - # are no fallback intents defined, no intent will be triggered. The score - # values range from 0.0 (completely uncertain) to 1.0 (completely certain). - # If set to 0.0, the default of 0.3 is used. + # the threshold value, then a fallback intent will be triggered or, if there are + # no fallback intents defined, no intent will be triggered. The score values + # range from 0.0 (completely uncertain) to 1.0 (completely certain). If set to 0. + # 0, the default of 0.3 is used. # Corresponds to the JSON property `classificationThreshold` # @return [Float] attr_accessor :classification_threshold - # Required. The default language of the agent as a language tag. See - # [Language - # Support](https://cloud.google.com/dialogflow/docs/reference/language) - # for a list of the currently supported language codes. This field cannot be - # set by the `Update` method. + # Required. The default language of the agent as a language tag. See [Language + # Support](https://cloud.google.com/dialogflow/docs/reference/language) for a + # list of the currently supported language codes. This field cannot be set by + # the `Update` method. # Corresponds to the JSON property `defaultLanguageCode` # @return [String] attr_accessor :default_language_code - # Optional. The description of this agent. - # The maximum length is 500 characters. If exceeded, the request is rejected. + # Optional. The description of this agent. The maximum length is 500 characters. + # If exceeded, the request is rejected. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description @@ -3020,14 +2866,13 @@ module Google # @return [String] attr_accessor :match_mode - # Required. The project of this agent. - # Format: `projects/`. + # Required. The project of this agent. Format: `projects/`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent - # Optional. The list of all languages supported by this agent (except for the - # `default_language_code`). + # Optional. The list of all languages supported by this agent (except for the ` + # default_language_code`). # Corresponds to the JSON property `supportedLanguageCodes` # @return [Array] attr_accessor :supported_language_codes @@ -3037,9 +2882,8 @@ module Google # @return [String] attr_accessor :tier - # Required. The time zone of this agent from the - # [time zone database](https://www.iana.org/time-zones), e.g., - # America/New_York, Europe/Paris. + # Required. The time zone of this agent from the [time zone database](https:// + # www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. # Corresponds to the JSON property `timeZone` # @return [String] attr_accessor :time_zone @@ -3065,11 +2909,10 @@ module Google end end - # Represents an annotated conversation dataset. - # ConversationDataset can have multiple AnnotatedConversationDataset, each of - # them represents one result from one annotation task. - # AnnotatedConversationDataset can only be generated from annotation task, - # which will be triggered by LabelConversation. + # Represents an annotated conversation dataset. ConversationDataset can have + # multiple AnnotatedConversationDataset, each of them represents one result from + # one annotation task. AnnotatedConversationDataset can only be generated from + # annotation task, which will be triggered by LabelConversation. class GoogleCloudDialogflowV2beta1AnnotatedConversationDataset include Google::Apis::Core::Hashable @@ -3084,14 +2927,14 @@ module Google # @return [String] attr_accessor :create_time - # Optional. The description of the annotated conversation dataset. - # Maximum of 10000 bytes. + # Optional. The description of the annotated conversation dataset. Maximum of + # 10000 bytes. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Required. The display name of the annotated conversation dataset. - # It's specified when user starts an annotation task. Maximum of 64 bytes. + # Required. The display name of the annotated conversation dataset. It's + # specified when user starts an annotation task. Maximum of 64 bytes. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -3101,17 +2944,16 @@ module Google # @return [Fixnum] attr_accessor :example_count - # Output only. AnnotatedConversationDataset resource name. Format: - # `projects//conversationDatasets//annotatedConversationDatasets/` + # Output only. AnnotatedConversationDataset resource name. Format: `projects// + # conversationDatasets//annotatedConversationDatasets/` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Output only. Question type name that identifies a labeling task. - # A question is a single task that a worker answers. A question type is set - # of related questions. Each question belongs to a particular question type. - # It can be used in CrowdCompute UI to filter and manage labeling tasks. + # Output only. Question type name that identifies a labeling task. A question is + # a single task that a worker answers. A question type is set of related + # questions. Each question belongs to a particular question type. It can be used + # in CrowdCompute UI to filter and manage labeling tasks. # Corresponds to the JSON property `questionTypeName` # @return [String] attr_accessor :question_type_name @@ -3172,12 +3014,10 @@ module Google # @return [Array] attr_accessor :entities - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -3197,19 +3037,16 @@ module Google class GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest include Google::Apis::Core::Hashable - # Required. The reference `values` of the entities to delete. Note that - # these are not fully-qualified names, i.e. they don't start with - # `projects/`. + # Required. The reference `values` of the entities to delete. Note that these + # are not fully-qualified names, i.e. they don't start with `projects/`. # Corresponds to the JSON property `entityValues` # @return [Array] attr_accessor :entity_values - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -3229,8 +3066,8 @@ module Google class GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest include Google::Apis::Core::Hashable - # Required. The names entity types to delete. All names must point to the - # same agent as `parent`. + # Required. The names entity types to delete. All names must point to the same + # agent as `parent`. # Corresponds to the JSON property `entityTypeNames` # @return [Array] attr_accessor :entity_type_names @@ -3274,12 +3111,10 @@ module Google # @return [Array] attr_accessor :entities - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -3310,20 +3145,17 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityTypeBatch] attr_accessor :entity_type_batch_inline - # The URI to a Google Cloud Storage file containing entity types to update - # or create. The file format can either be a serialized proto (of - # EntityBatch type) or a JSON object. Note: The URI must start with - # "gs://". + # The URI to a Google Cloud Storage file containing entity types to update or + # create. The file format can either be a serialized proto (of EntityBatch type) + # or a JSON object. Note: The URI must start with "gs://". # Corresponds to the JSON property `entityTypeBatchUri` # @return [String] attr_accessor :entity_type_batch_uri - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -3374,9 +3206,9 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentBatch] attr_accessor :intent_batch_inline - # The URI to a Google Cloud Storage file containing intents to update or - # create. The file format can either be a serialized proto (of IntentBatch - # type) or JSON object. Note: The URI must start with "gs://". + # The URI to a Google Cloud Storage file containing intents to update or create. + # The file format can either be a serialized proto (of IntentBatch type) or JSON + # object. Note: The URI must start with "gs://". # Corresponds to the JSON property `intentBatchUri` # @return [String] attr_accessor :intent_batch_uri @@ -3386,12 +3218,10 @@ module Google # @return [String] attr_accessor :intent_view - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -3437,57 +3267,47 @@ module Google # Dialogflow contexts are similar to natural language context. If a person says # to you "they are orange", you need context in order to understand what "they" # is referring to. Similarly, for Dialogflow to handle an end-user expression - # like that, it needs to be provided with context in order to correctly match - # an intent. - # Using contexts, you can control the flow of a conversation. You can configure - # contexts for an intent by setting input and output contexts, which are - # identified by string names. When an intent is matched, any configured output - # contexts for that intent become active. While any contexts are active, + # like that, it needs to be provided with context in order to correctly match an + # intent. Using contexts, you can control the flow of a conversation. You can + # configure contexts for an intent by setting input and output contexts, which + # are identified by string names. When an intent is matched, any configured + # output contexts for that intent become active. While any contexts are active, # Dialogflow is more likely to match intents that are configured with input - # contexts that correspond to the currently active contexts. - # For more information about context, see the - # [Contexts guide](https://cloud.google.com/dialogflow/docs/contexts-overview). + # contexts that correspond to the currently active contexts. For more + # information about context, see the [Contexts guide](https://cloud.google.com/ + # dialogflow/docs/contexts-overview). class GoogleCloudDialogflowV2beta1Context include Google::Apis::Core::Hashable - # Optional. The number of conversational query requests after which the - # context expires. The default is `0`. If set to `0`, the context expires - # immediately. Contexts expire automatically after 20 minutes if there - # are no matching queries. + # Optional. The number of conversational query requests after which the context + # expires. The default is `0`. If set to `0`, the context expires immediately. + # Contexts expire automatically after 20 minutes if there are no matching + # queries. # Corresponds to the JSON property `lifespanCount` # @return [Fixnum] attr_accessor :lifespan_count - # Required. The unique identifier of the context. Format: - # `projects//agent/sessions//contexts/`, - # or `projects//agent/environments//users//sessions//contexts/`. - # The `Context ID` is always converted to lowercase, may only contain - # characters in a-zA-Z0-9_-% and may be at most 250 bytes long. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # The following context names are reserved for internal use by Dialogflow. - # You should not use these contexts or create contexts with these names: - # * `__system_counters__` - # * `*_id_dialog_context` - # * `*_dialog_params_size` + # Required. The unique identifier of the context. Format: `projects//agent/ + # sessions//contexts/`, or `projects//agent/environments//users//sessions// + # contexts/`. The `Context ID` is always converted to lowercase, may only + # contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. The following context + # names are reserved for internal use by Dialogflow. You should not use these + # contexts or create contexts with these names: * `__system_counters__` * `* + # _id_dialog_context` * `*_dialog_params_size` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Optional. The collection of parameters associated with this context. - # Depending on your protocol or client library language, this is a - # map, associative array, symbol table, dictionary, or JSON object - # composed of a collection of (MapKey, MapValue) pairs: - # - MapKey type: string - # - MapKey value: parameter name - # - MapValue type: - # - If parameter's entity type is a composite entity: map - # - Else: string or number, depending on parameter value type - # - MapValue value: - # - If parameter's entity type is a composite entity: - # map from composite entity property names to property values - # - Else: parameter value + # Optional. The collection of parameters associated with this context. Depending + # on your protocol or client library language, this is a map, associative array, + # symbol table, dictionary, or JSON object composed of a collection of (MapKey, + # MapValue) pairs: - MapKey type: string - MapKey value: parameter name - + # MapValue type: - If parameter's entity type is a composite entity: map - Else: + # string or number, depending on parameter value type - MapValue value: - If + # parameter's entity type is a composite entity: map from composite entity + # property names to property values - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -3508,35 +3328,33 @@ module Google class GoogleCloudDialogflowV2beta1DetectIntentRequest include Google::Apis::Core::Hashable - # The natural language speech audio to be processed. This field - # should be populated iff `query_input` is set to an input audio config. - # A single request can contain up to 1 minute of speech audio data. + # The natural language speech audio to be processed. This field should be + # populated iff `query_input` is set to an input audio config. A single request + # can contain up to 1 minute of speech audio data. # Corresponds to the JSON property `inputAudio` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :input_audio - # Instructs the speech synthesizer how to generate the output audio content. - # If this audio config is supplied in a request, it overrides all existing - # text-to-speech settings applied to the agent. + # Instructs the speech synthesizer how to generate the output audio content. If + # this audio config is supplied in a request, it overrides all existing text-to- + # speech settings applied to the agent. # Corresponds to the JSON property `outputAudioConfig` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudioConfig] attr_accessor :output_audio_config - # Mask for output_audio_config indicating which settings in this - # request-level config should override speech synthesizer settings defined at - # agent-level. - # If unspecified or empty, output_audio_config replaces the agent-level - # config in its entirety. + # Mask for output_audio_config indicating which settings in this request-level + # config should override speech synthesizer settings defined at agent-level. If + # unspecified or empty, output_audio_config replaces the agent-level config in + # its entirety. # Corresponds to the JSON property `outputAudioConfigMask` # @return [String] attr_accessor :output_audio_config_mask - # Represents the query input. It can contain either: - # 1. An audio config which - # instructs the speech recognizer how to process the speech audio. - # 2. A conversational query in the form of text. - # 3. An event that specifies which intent to trigger. + # Represents the query input. It can contain either: 1. An audio config which + # instructs the speech recognizer how to process the speech audio. 2. A + # conversational query in the form of text. 3. An event that specifies which + # intent to trigger. # Corresponds to the JSON property `queryInput` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1QueryInput] attr_accessor :query_input @@ -3565,34 +3383,32 @@ module Google include Google::Apis::Core::Hashable # If Knowledge Connectors are enabled, there could be more than one result - # returned for a given query or event, and this field will contain all - # results except for the top one, which is captured in query_result. The - # alternative results are ordered by decreasing - # `QueryResult.intent_detection_confidence`. If Knowledge Connectors are - # disabled, this field will be empty until multiple responses for regular - # intents are supported, at which point those additional results will be - # surfaced here. + # returned for a given query or event, and this field will contain all results + # except for the top one, which is captured in query_result. The alternative + # results are ordered by decreasing `QueryResult.intent_detection_confidence`. + # If Knowledge Connectors are disabled, this field will be empty until multiple + # responses for regular intents are supported, at which point those additional + # results will be surfaced here. # Corresponds to the JSON property `alternativeQueryResults` # @return [Array] attr_accessor :alternative_query_results - # The audio data bytes encoded as specified in the request. - # Note: The output audio is generated based on the values of default platform - # text responses found in the `query_result.fulfillment_messages` field. If - # multiple default text responses exist, they will be concatenated when - # generating audio. If no default platform text responses exist, the - # generated audio content will be empty. - # In some scenarios, multiple output audio fields may be present in the - # response structure. In these cases, only the top-most-level audio output - # has content. + # The audio data bytes encoded as specified in the request. Note: The output + # audio is generated based on the values of default platform text responses + # found in the `query_result.fulfillment_messages` field. If multiple default + # text responses exist, they will be concatenated when generating audio. If no + # default platform text responses exist, the generated audio content will be + # empty. In some scenarios, multiple output audio fields may be present in the + # response structure. In these cases, only the top-most-level audio output has + # content. # Corresponds to the JSON property `outputAudio` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :output_audio - # Instructs the speech synthesizer how to generate the output audio content. - # If this audio config is supplied in a request, it overrides all existing - # text-to-speech settings applied to the agent. + # Instructs the speech synthesizer how to generate the output audio content. If + # this audio config is supplied in a request, it overrides all existing text-to- + # speech settings applied to the agent. # Corresponds to the JSON property `outputAudioConfig` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OutputAudioConfig] attr_accessor :output_audio_config @@ -3602,18 +3418,18 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1QueryResult] attr_accessor :query_result - # The unique identifier of the response. It can be used to - # locate a response in the training example set or for reporting issues. + # The unique identifier of the response. It can be used to locate a response in + # the training example set or for reporting issues. # Corresponds to the JSON property `responseId` # @return [String] attr_accessor :response_id - # 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 `webhookStatus` # @return [Google::Apis::DialogflowV2beta1::GoogleRpcStatus] attr_accessor :webhook_status @@ -3633,29 +3449,26 @@ module Google end end - # A knowledge document to be used by a KnowledgeBase. - # For more information, see the [knowledge base - # guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). - # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - # only use `projects.knowledgeBases.documents`. + # A knowledge document to be used by a KnowledgeBase. For more information, see + # the [knowledge base guide](https://cloud.google.com/dialogflow/docs/how/ + # knowledge-bases). Note: The `projects.agent.knowledgeBases.documents` resource + # is deprecated; only use `projects.knowledgeBases.documents`. class GoogleCloudDialogflowV2beta1Document include Google::Apis::Core::Hashable # The raw content of the document. This field is only permitted for - # EXTRACTIVE_QA and FAQ knowledge types. - # Note: This field is in the process of being deprecated, please use - # raw_content instead. + # EXTRACTIVE_QA and FAQ knowledge types. Note: This field is in the process of + # being deprecated, please use raw_content instead. # Corresponds to the JSON property `content` # @return [String] attr_accessor :content - # The URI where the file content is located. - # For documents stored in Google Cloud Storage, these URIs must have - # the form `gs:///`. - # NOTE: External URLs must correspond to public webpages, i.e., they must - # be indexed by Google Search. In particular, URLs for showing documents in - # Google Cloud Storage (i.e. the URL in your browser) are not supported. - # Instead use the `gs://` format URI described above. + # The URI where the file content is located. For documents stored in Google + # Cloud Storage, these URIs must have the form `gs:///`. NOTE: External URLs + # must correspond to public webpages, i.e., they must be indexed by Google + # Search. In particular, URLs for showing documents in Google Cloud Storage (i.e. + # the URL in your browser) are not supported. Instead use the `gs://` format + # URI described above. # Corresponds to the JSON property `contentUri` # @return [String] attr_accessor :content_uri @@ -3666,15 +3479,13 @@ module Google # @return [String] attr_accessor :display_name - # Optional. If true, we try to automatically reload the document every day - # (at a time picked by the system). If false or unspecified, we don't try - # to automatically reload the document. - # Currently you can only enable automatic reload for documents sourced from - # a public url, see `source` field for the source types. - # Reload status can be tracked in `latest_reload_status`. If a reload - # fails, we will keep the document unchanged. - # If a reload fails with internal errors, the system will try to reload the - # document on the next day. + # Optional. If true, we try to automatically reload the document every day (at a + # time picked by the system). If false or unspecified, we don't try to + # automatically reload the document. Currently you can only enable automatic + # reload for documents sourced from a public url, see `source` field for the + # source types. Reload status can be tracked in `latest_reload_status`. If a + # reload fails, we will keep the document unchanged. If a reload fails with + # internal errors, the system will try to reload the document on the next day. # If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the # system will not try to reload the document anymore. You need to manually # reload the document successfully by calling `ReloadDocument` and clear the @@ -3699,10 +3510,8 @@ module Google # @return [String] attr_accessor :mime_type - # Optional. The document resource name. - # The name must be empty when creating a document. - # Format: `projects//knowledgeBases//documents/`. + # Optional. The document resource name. The name must be empty when creating a + # document. Format: `projects//knowledgeBases//documents/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3736,19 +3545,18 @@ module Google class GoogleCloudDialogflowV2beta1DocumentReloadStatus 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 `status` # @return [Google::Apis::DialogflowV2beta1::GoogleRpcStatus] attr_accessor :status - # Output only. The time of a reload attempt. - # This reload may have been triggered automatically or manually and may - # not have succeeded. + # Output only. The time of a reload attempt. This reload may have been triggered + # automatically or manually and may not have succeeded. # Corresponds to the JSON property `time` # @return [String] attr_accessor :time @@ -3765,20 +3573,18 @@ module Google end # Each intent parameter has a type, called the entity type, which dictates - # exactly how data from an end-user expression is extracted. - # Dialogflow provides predefined system entities that can match many common - # types of data. For example, there are system entities for matching dates, - # times, colors, email addresses, and so on. You can also create your own - # custom entities for matching custom data. For example, you could define a - # vegetable entity that can match the types of vegetables available for - # purchase with a grocery store agent. - # For more information, see the - # [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview). + # exactly how data from an end-user expression is extracted. Dialogflow provides + # predefined system entities that can match many common types of data. For + # example, there are system entities for matching dates, times, colors, email + # addresses, and so on. You can also create your own custom entities for + # matching custom data. For example, you could define a vegetable entity that + # can match the types of vegetables available for purchase with a grocery store + # agent. For more information, see the [Entity guide](https://cloud.google.com/ + # dialogflow/docs/entities-overview). class GoogleCloudDialogflowV2beta1EntityType include Google::Apis::Core::Hashable - # Optional. Indicates whether the entity type can be automatically - # expanded. + # Optional. Indicates whether the entity type can be automatically expanded. # Corresponds to the JSON property `autoExpansionMode` # @return [String] attr_accessor :auto_expansion_mode @@ -3804,10 +3610,9 @@ module Google # @return [String] attr_accessor :kind - # The unique identifier of the entity type. - # Required for EntityTypes.UpdateEntityType and - # EntityTypes.BatchUpdateEntityTypes methods. - # Format: `projects//agent/entityTypes/`. + # The unique identifier of the entity type. Required for EntityTypes. + # UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: ` + # projects//agent/entityTypes/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -3850,23 +3655,19 @@ module Google class GoogleCloudDialogflowV2beta1EntityTypeEntity include Google::Apis::Core::Hashable - # Required. A collection of value synonyms. For example, if the entity type - # is *vegetable*, and `value` is *scallions*, a synonym could be *green - # onions*. - # For `KIND_LIST` entity types: - # * This collection must contain exactly one synonym equal to `value`. + # Required. A collection of value synonyms. For example, if the entity type is * + # vegetable*, and `value` is *scallions*, a synonym could be *green onions*. For + # `KIND_LIST` entity types: * This collection must contain exactly one synonym + # equal to `value`. # Corresponds to the JSON property `synonyms` # @return [Array] attr_accessor :synonyms - # Required. The primary value associated with this entity entry. - # For example, if the entity type is *vegetable*, the value could be - # *scallions*. - # For `KIND_MAP` entity types: - # * A reference value to be used in place of synonyms. - # For `KIND_LIST` entity types: - # * A string that can contain references to other entity types (with or - # without aliases). + # Required. The primary value associated with this entity entry. For example, if + # the entity type is *vegetable*, the value could be *scallions*. For `KIND_MAP` + # entity types: * A reference value to be used in place of synonyms. For ` + # KIND_LIST` entity types: * A string that can contain references to other + # entity types (with or without aliases). # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -3883,53 +3684,43 @@ module Google end # You can create multiple versions of your agent and publish them to separate - # environments. - # When you edit an agent, you are editing the draft agent. At any point, you - # can save the draft agent as an agent version, which is an immutable snapshot - # of your agent. - # When you save the draft agent, it is published to the default environment. - # When you create agent versions, you can publish them to custom environments. - # You can create a variety of custom environments for: - # - testing - # - development - # - production - # - etc. - # For more information, see the [versions and environments - # guide](https://cloud.google.com/dialogflow/docs/agents-versions). + # environments. When you edit an agent, you are editing the draft agent. At any + # point, you can save the draft agent as an agent version, which is an immutable + # snapshot of your agent. When you save the draft agent, it is published to the + # default environment. When you create agent versions, you can publish them to + # custom environments. You can create a variety of custom environments for: - + # testing - development - production - etc. For more information, see the [ + # versions and environments guide](https://cloud.google.com/dialogflow/docs/ + # agents-versions). class GoogleCloudDialogflowV2beta1Environment include Google::Apis::Core::Hashable - # Optional. The agent version loaded into this environment. - # Format: `projects//agent/versions/`. + # Optional. The agent version loaded into this environment. Format: `projects// + # agent/versions/`. # Corresponds to the JSON property `agentVersion` # @return [String] attr_accessor :agent_version - # Optional. The developer-provided description for this environment. - # The maximum length is 500 characters. If exceeded, the request is rejected. + # Optional. The developer-provided description for this environment. The maximum + # length is 500 characters. If exceeded, the request is rejected. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Output only. The unique identifier of this agent environment. - # Format: - # - `projects//agent/environments/` - # - `projects//locations//agent/environments/` + # Output only. The unique identifier of this agent environment. Format: - ` + # projects//agent/environments/` - `projects//locations//agent/environments/` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. The state of this environment. This field is read-only, i.e., it - # cannot be - # set by create and update methods. + # cannot be set by create and update methods. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state # Output only. The last update time of this environment. This field is read-only, - # i.e., it - # cannot be set by create and update methods. + # i.e., it cannot be set by create and update methods. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -3949,17 +3740,16 @@ module Google end # Events allow for matching intents by event name instead of the natural - # language input. For instance, input `` can trigger a personalized welcome response. - # The parameter `name` may be used by the agent in the response: - # `"Hello #welcome_event.name! What can I do for you today?"`. + # language input. For instance, input `` can trigger a personalized welcome + # response. The parameter `name` may be used by the agent in the response: `" + # Hello #welcome_event.name! What can I do for you today?"`. class GoogleCloudDialogflowV2beta1EventInput include Google::Apis::Core::Hashable - # Required. The language of this query. See [Language - # Support](https://cloud.google.com/dialogflow/docs/reference/language) - # for a list of the currently supported language codes. Note that queries in - # the same session do not necessarily need to specify the same language. + # Required. The language of this query. See [Language Support](https://cloud. + # google.com/dialogflow/docs/reference/language) for a list of the currently + # supported language codes. Note that queries in the same session do not + # necessarily need to specify the same language. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -3969,19 +3759,14 @@ module Google # @return [String] attr_accessor :name - # The collection of parameters associated with the event. - # Depending on your protocol or client library language, this is a - # map, associative array, symbol table, dictionary, or JSON object - # composed of a collection of (MapKey, MapValue) pairs: - # - MapKey type: string - # - MapKey value: parameter name - # - MapValue type: - # - If parameter's entity type is a composite entity: map - # - Else: string or number, depending on parameter value type - # - MapValue value: - # - If parameter's entity type is a composite entity: - # map from composite entity property names to property values - # - Else: parameter value + # The collection of parameters associated with the event. Depending on your + # protocol or client library language, this is a map, associative array, symbol + # table, dictionary, or JSON object composed of a collection of (MapKey, + # MapValue) pairs: - MapKey type: string - MapKey value: parameter name - + # MapValue type: - If parameter's entity type is a composite entity: map - Else: + # string or number, depending on parameter value type - MapValue value: - If + # parameter's entity type is a composite entity: map from composite entity + # property names to property values - Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters @@ -4002,11 +3787,9 @@ module Google class GoogleCloudDialogflowV2beta1ExportAgentRequest include Google::Apis::Core::Hashable - # Optional. The - # [Google Cloud Storage](https://cloud.google.com/storage/docs/) - # URI to export the agent to. - # The format of this URI must be `gs:///`. - # If left unspecified, the serialized agent is returned inline. + # Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) + # URI to export the agent to. The format of this URI must be `gs:///`. If left + # unspecified, the serialized agent is returned inline. # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri @@ -4031,8 +3814,8 @@ module Google # @return [String] attr_accessor :agent_content - # The URI to a file containing the exported agent. This field is populated - # only if `agent_uri` is specified in `ExportAgentRequest`. + # The URI to a file containing the exported agent. This field is populated only + # if `agent_uri` is specified in `ExportAgentRequest`. # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri @@ -4048,15 +3831,14 @@ module Google end end - # By default, your agent responds to a matched intent with a static response. - # As an alternative, you can provide a more dynamic response by using - # fulfillment. When you enable fulfillment for an intent, Dialogflow responds - # to that intent by calling a service that you define. For example, if an - # end-user wants to schedule a haircut on Friday, your service can check your - # database and respond to the end-user with availability information for - # Friday. - # For more information, see the [fulfillment - # guide](https://cloud.google.com/dialogflow/docs/fulfillment-overview). + # By default, your agent responds to a matched intent with a static response. As + # an alternative, you can provide a more dynamic response by using fulfillment. + # When you enable fulfillment for an intent, Dialogflow responds to that intent + # by calling a service that you define. For example, if an end-user wants to + # schedule a haircut on Friday, your service can check your database and respond + # to the end-user with availability information for Friday. For more information, + # see the [fulfillment guide](https://cloud.google.com/dialogflow/docs/ + # fulfillment-overview). class GoogleCloudDialogflowV2beta1Fulfillment include Google::Apis::Core::Hashable @@ -4077,18 +3859,17 @@ module Google # @return [Array] attr_accessor :features - # Represents configuration for a generic web service. - # Dialogflow supports two mechanisms for authentications: - # - Basic authentication with username and password. - # - Authentication with additional authentication headers. - # More information could be found at: - # https://cloud.google.com/dialogflow/docs/fulfillment-configure. + # Represents configuration for a generic web service. Dialogflow supports two + # mechanisms for authentications: - Basic authentication with username and + # password. - Authentication with additional authentication headers. More + # information could be found at: https://cloud.google.com/dialogflow/docs/ + # fulfillment-configure. # Corresponds to the JSON property `genericWebService` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1FulfillmentGenericWebService] attr_accessor :generic_web_service - # Required. The unique identifier of the fulfillment. - # Format: `projects//agent/fulfillment`. + # Required. The unique identifier of the fulfillment. Format: `projects//agent/ + # fulfillment`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -4126,12 +3907,11 @@ module Google end end - # Represents configuration for a generic web service. - # Dialogflow supports two mechanisms for authentications: - # - Basic authentication with username and password. - # - Authentication with additional authentication headers. - # More information could be found at: - # https://cloud.google.com/dialogflow/docs/fulfillment-configure. + # Represents configuration for a generic web service. Dialogflow supports two + # mechanisms for authentications: - Basic authentication with username and + # password. - Authentication with additional authentication headers. More + # information could be found at: https://cloud.google.com/dialogflow/docs/ + # fulfillment-configure. class GoogleCloudDialogflowV2beta1FulfillmentGenericWebService include Google::Apis::Core::Hashable @@ -4152,8 +3932,8 @@ module Google # @return [Hash] attr_accessor :request_headers - # Required. The fulfillment URI for receiving POST requests. - # It must use https protocol. + # Required. The fulfillment URI for receiving POST requests. It must use https + # protocol. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -4181,10 +3961,9 @@ module Google class GoogleCloudDialogflowV2beta1GcsSource include Google::Apis::Core::Hashable - # Required. The Google Cloud Storage URIs for the inputs. A URI is of the - # form: - # gs://bucket/object-prefix-or-name - # Whether a prefix or name is used depends on the use case. + # Required. The Google Cloud Storage URIs for the inputs. A URI is of the form: + # gs://bucket/object-prefix-or-name Whether a prefix or name is used depends on + # the use case. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -4209,8 +3988,8 @@ module Google # @return [String] attr_accessor :agent_content - # The URI to a Google Cloud Storage file containing the agent to import. - # Note: The URI must start with "gs://". + # The URI to a Google Cloud Storage file containing the agent to import. Note: + # The URI must start with "gs://". # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri @@ -4235,36 +4014,32 @@ module Google # @return [String] attr_accessor :audio_encoding - # If `true`, Dialogflow returns SpeechWordInfo in - # StreamingRecognitionResult with information about the recognized speech - # words, e.g. start and end time offsets. If false or unspecified, Speech - # doesn't return any word-level information. + # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult + # with information about the recognized speech words, e.g. start and end time + # offsets. If false or unspecified, Speech doesn't return any word-level + # information. # Corresponds to the JSON property `enableWordInfo` # @return [Boolean] attr_accessor :enable_word_info alias_method :enable_word_info?, :enable_word_info # Required. The language of the supplied audio. Dialogflow does not do - # translations. See [Language - # Support](https://cloud.google.com/dialogflow/docs/reference/language) - # for a list of the currently supported language codes. Note that queries in - # the same session do not necessarily need to specify the same language. + # translations. See [Language Support](https://cloud.google.com/dialogflow/docs/ + # reference/language) for a list of the currently supported language codes. Note + # that queries in the same session do not necessarily need to specify the same + # language. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # Which Speech model to select for the given request. Select the - # model best suited to your domain to get best results. If a model is not - # explicitly specified, then we auto-select a model based on the parameters - # in the InputAudioConfig. - # If enhanced speech model is enabled for the agent and an enhanced - # version of the specified model for the language does not exist, then the - # speech is recognized using the standard version of the specified model. - # Refer to - # [Cloud Speech API - # documentation](https://cloud.google.com/speech-to-text/docs/basics#select- - # model) - # for more details. + # Which Speech model to select for the given request. Select the model best + # suited to your domain to get best results. If a model is not explicitly + # specified, then we auto-select a model based on the parameters in the + # InputAudioConfig. If enhanced speech model is enabled for the agent and an + # enhanced version of the specified model for the language does not exist, then + # the speech is recognized using the standard version of the specified model. + # Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to- + # text/docs/basics#select-model) for more details. # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -4274,48 +4049,39 @@ module Google # @return [String] attr_accessor :model_variant - # A list of strings containing words and phrases that the speech - # recognizer should recognize with higher likelihood. - # See [the Cloud Speech - # documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase- - # hints) - # for more details. - # This field is deprecated. Please use [speech_contexts]() instead. If you - # specify both [phrase_hints]() and [speech_contexts](), Dialogflow will + # A list of strings containing words and phrases that the speech recognizer + # should recognize with higher likelihood. See [the Cloud Speech documentation]( + # https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more + # details. This field is deprecated. Please use [speech_contexts]() instead. If + # you specify both [phrase_hints]() and [speech_contexts](), Dialogflow will # treat the [phrase_hints]() as a single additional [SpeechContext](). # Corresponds to the JSON property `phraseHints` # @return [Array] attr_accessor :phrase_hints - # Required. Sample rate (in Hertz) of the audio content sent in the query. - # Refer to - # [Cloud Speech API - # documentation](https://cloud.google.com/speech-to-text/docs/basics) for - # more details. + # Required. Sample rate (in Hertz) of the audio content sent in the query. Refer + # to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/ + # docs/basics) for more details. # Corresponds to the JSON property `sampleRateHertz` # @return [Fixnum] attr_accessor :sample_rate_hertz - # If `false` (default), recognition does not cease until the - # client closes the stream. - # If `true`, the recognizer will detect a single spoken utterance in input - # audio. Recognition ceases when it detects the audio's voice has - # stopped or paused. In this case, once a detected intent is received, the - # client should close the stream and start a new request with a new stream as - # needed. - # Note: This setting is relevant only for streaming methods. - # Note: When specified, InputAudioConfig.single_utterance takes precedence - # over StreamingDetectIntentRequest.single_utterance. + # If `false` (default), recognition does not cease until the client closes the + # stream. If `true`, the recognizer will detect a single spoken utterance in + # input audio. Recognition ceases when it detects the audio's voice has stopped + # or paused. In this case, once a detected intent is received, the client should + # close the stream and start a new request with a new stream as needed. Note: + # This setting is relevant only for streaming methods. Note: When specified, + # InputAudioConfig.single_utterance takes precedence over + # StreamingDetectIntentRequest.single_utterance. # Corresponds to the JSON property `singleUtterance` # @return [Boolean] attr_accessor :single_utterance alias_method :single_utterance?, :single_utterance - # Context information to assist speech recognition. - # See [the Cloud Speech + # Context information to assist speech recognition. See [the Cloud Speech # documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase- - # hints) - # for more details. + # hints) for more details. # Corresponds to the JSON property `speechContexts` # @return [Array] attr_accessor :speech_contexts @@ -4343,20 +4109,19 @@ module Google # complete conversation. When an end-user writes or says something, referred to # as an end-user expression or end-user input, Dialogflow matches the end-user # input to the best intent in your agent. Matching an intent is also known as - # intent classification. - # For more information, see the [intent - # guide](https://cloud.google.com/dialogflow/docs/intents-overview). + # intent classification. For more information, see the [intent guide](https:// + # cloud.google.com/dialogflow/docs/intents-overview). class GoogleCloudDialogflowV2beta1Intent include Google::Apis::Core::Hashable - # Optional. The name of the action associated with the intent. - # Note: The action name must not contain whitespaces. + # Optional. The name of the action associated with the intent. Note: The action + # name must not contain whitespaces. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action - # Optional. The list of platforms for which the first responses will be - # copied from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). + # Optional. The list of platforms for which the first responses will be copied + # from the messages in PLATFORM_UNSPECIFIED (i.e. default platform). # Corresponds to the JSON property `defaultResponsePlatforms` # @return [Array] attr_accessor :default_response_platforms @@ -4366,31 +4131,30 @@ module Google # @return [String] attr_accessor :display_name - # Optional. Indicates that this intent ends an interaction. Some integrations - # (e.g., Actions on Google or Dialogflow phone gateway) use this information - # to close interaction with an end user. Default is false. + # Optional. Indicates that this intent ends an interaction. Some integrations (e. + # g., Actions on Google or Dialogflow phone gateway) use this information to + # close interaction with an end user. Default is false. # Corresponds to the JSON property `endInteraction` # @return [Boolean] attr_accessor :end_interaction alias_method :end_interaction?, :end_interaction - # Optional. The collection of event names that trigger the intent. - # If the collection of input contexts is not empty, all of the contexts must - # be present in the active user session for an event to trigger this intent. - # Event names are limited to 150 characters. + # Optional. The collection of event names that trigger the intent. If the + # collection of input contexts is not empty, all of the contexts must be present + # in the active user session for an event to trigger this intent. Event names + # are limited to 150 characters. # Corresponds to the JSON property `events` # @return [Array] attr_accessor :events - # Output only. Information about all followup intents that have this intent as - # a direct or indirect parent. We populate this field only in the output. + # Output only. Information about all followup intents that have this intent as a + # direct or indirect parent. We populate this field only in the output. # Corresponds to the JSON property `followupIntentInfo` # @return [Array] attr_accessor :followup_intent_info - # Optional. The list of context names required for this intent to be - # triggered. - # Format: `projects//agent/sessions/-/contexts/`. + # Optional. The list of context names required for this intent to be triggered. + # Format: `projects//agent/sessions/-/contexts/`. # Corresponds to the JSON property `inputContextNames` # @return [Array] attr_accessor :input_context_names @@ -4401,50 +4165,45 @@ module Google attr_accessor :is_fallback alias_method :is_fallback?, :is_fallback - # Optional. The collection of rich messages corresponding to the - # `Response` field in the Dialogflow console. + # Optional. The collection of rich messages corresponding to the `Response` + # field in the Dialogflow console. # Corresponds to the JSON property `messages` # @return [Array] attr_accessor :messages - # Optional. Indicates whether Machine Learning is disabled for the intent. - # Note: If `ml_disabled` setting is set to true, then this intent is not - # taken into account during inference in `ML ONLY` match mode. Also, - # auto-markup in the UI is turned off. + # Optional. Indicates whether Machine Learning is disabled for the intent. Note: + # If `ml_disabled` setting is set to true, then this intent is not taken into + # account during inference in `ML ONLY` match mode. Also, auto-markup in the UI + # is turned off. # Corresponds to the JSON property `mlDisabled` # @return [Boolean] attr_accessor :ml_disabled alias_method :ml_disabled?, :ml_disabled - # Optional. Indicates whether Machine Learning is enabled for the intent. - # Note: If `ml_enabled` setting is set to false, then this intent is not - # taken into account during inference in `ML ONLY` match mode. Also, - # auto-markup in the UI is turned off. - # DEPRECATED! Please use `ml_disabled` field instead. - # NOTE: If both `ml_enabled` and `ml_disabled` are either not set or false, - # then the default value is determined as follows: - # - Before April 15th, 2018 the default is: - # ml_enabled = false / ml_disabled = true. - # - After April 15th, 2018 the default is: - # ml_enabled = true / ml_disabled = false. + # Optional. Indicates whether Machine Learning is enabled for the intent. Note: + # If `ml_enabled` setting is set to false, then this intent is not taken into + # account during inference in `ML ONLY` match mode. Also, auto-markup in the UI + # is turned off. DEPRECATED! Please use `ml_disabled` field instead. NOTE: If + # both `ml_enabled` and `ml_disabled` are either not set or false, then the + # default value is determined as follows: - Before April 15th, 2018 the default + # is: ml_enabled = false / ml_disabled = true. - After April 15th, 2018 the + # default is: ml_enabled = true / ml_disabled = false. # Corresponds to the JSON property `mlEnabled` # @return [Boolean] attr_accessor :ml_enabled alias_method :ml_enabled?, :ml_enabled - # Optional. The unique identifier of this intent. - # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents - # methods. - # Format: `projects//agent/intents/`. + # Optional. The unique identifier of this intent. Required for Intents. + # UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/ + # intents/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Optional. The collection of contexts that are activated when the intent - # is matched. Context messages in this collection should not set the - # parameters field. Setting the `lifespan_count` to 0 will reset the context - # when the intent is matched. - # Format: `projects//agent/sessions/-/contexts/`. + # Optional. The collection of contexts that are activated when the intent is + # matched. Context messages in this collection should not set the parameters + # field. Setting the `lifespan_count` to 0 will reset the context when the + # intent is matched. Format: `projects//agent/sessions/-/contexts/`. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts @@ -4454,45 +4213,39 @@ module Google # @return [Array] attr_accessor :parameters - # Optional. The unique identifier of the parent intent in the - # chain of followup intents. You can set this field when creating an intent, - # for example with CreateIntent or - # BatchUpdateIntents, in order to make this - # intent a followup intent. - # It identifies the parent followup intent. - # Format: `projects//agent/intents/`. + # Optional. The unique identifier of the parent intent in the chain of followup + # intents. You can set this field when creating an intent, for example with + # CreateIntent or BatchUpdateIntents, in order to make this intent a followup + # intent. It identifies the parent followup intent. Format: `projects//agent/ + # intents/`. # Corresponds to the JSON property `parentFollowupIntentName` # @return [String] attr_accessor :parent_followup_intent_name # Optional. The priority of this intent. Higher numbers represent higher - # priorities. - # - If the supplied value is unspecified or 0, the service - # translates the value to 500,000, which corresponds to the - # `Normal` priority in the console. - # - If the supplied value is negative, the intent is ignored - # in runtime detect intent requests. + # priorities. - If the supplied value is unspecified or 0, the service + # translates the value to 500,000, which corresponds to the `Normal` priority in + # the console. - If the supplied value is negative, the intent is ignored in + # runtime detect intent requests. # Corresponds to the JSON property `priority` # @return [Fixnum] attr_accessor :priority - # Optional. Indicates whether to delete all contexts in the current - # session when this intent is matched. + # Optional. Indicates whether to delete all contexts in the current session when + # this intent is matched. # Corresponds to the JSON property `resetContexts` # @return [Boolean] attr_accessor :reset_contexts alias_method :reset_contexts?, :reset_contexts - # Output only. The unique identifier of the root intent in the chain of - # followup intents. It identifies the correct followup intents chain for - # this intent. - # Format: `projects//agent/intents/`. + # Output only. The unique identifier of the root intent in the chain of followup + # intents. It identifies the correct followup intents chain for this intent. + # Format: `projects//agent/intents/`. # Corresponds to the JSON property `rootFollowupIntentName` # @return [String] attr_accessor :root_followup_intent_name - # Optional. The collection of examples that the agent is - # trained on. + # Optional. The collection of examples that the agent is trained on. # Corresponds to the JSON property `trainingPhrases` # @return [Array] attr_accessor :training_phrases @@ -4554,14 +4307,14 @@ module Google class GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo include Google::Apis::Core::Hashable - # The unique identifier of the followup intent. - # Format: `projects//agent/intents/`. + # The unique identifier of the followup intent. Format: `projects//agent/intents/ + # `. # Corresponds to the JSON property `followupIntentName` # @return [String] attr_accessor :followup_intent_name - # The unique identifier of the followup intent's parent. - # Format: `projects//agent/intents/`. + # The unique identifier of the followup intent's parent. Format: `projects// + # agent/intents/`. # Corresponds to the JSON property `parentFollowupIntentName` # @return [String] attr_accessor :parent_followup_intent_name @@ -4586,8 +4339,8 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageBasicCard] attr_accessor :basic_card - # Browse Carousel Card for Actions on Google. - # https://developers.google.com/actions/assistant/responses#browsing_carousel + # Browse Carousel Card for Actions on Google. https://developers.google.com/ + # actions/assistant/responses#browsing_carousel # Corresponds to the JSON property `browseCarouselCard` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard] attr_accessor :browse_carousel_card @@ -4607,8 +4360,8 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageImage] attr_accessor :image - # The suggestion chip message that allows the user to jump out to the app - # or website associated with this agent. + # The suggestion chip message that allows the user to jump out to the app or + # website associated with this agent. # Corresponds to the JSON property `linkOutSuggestion` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion] attr_accessor :link_out_suggestion @@ -4638,20 +4391,18 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageQuickReplies] attr_accessor :quick_replies - # Carousel Rich Business Messaging (RBM) rich card. - # Rich cards allow you to respond to users with more vivid content, e.g. - # with media and suggestions. - # If you want to show a single card with more control over the layout, - # please use RbmStandaloneCard instead. + # Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to + # respond to users with more vivid content, e.g. with media and suggestions. If + # you want to show a single card with more control over the layout, please use + # RbmStandaloneCard instead. # Corresponds to the JSON property `rbmCarouselRichCard` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard] attr_accessor :rbm_carousel_rich_card - # Standalone Rich Business Messaging (RBM) rich card. - # Rich cards allow you to respond to users with more vivid content, e.g. - # with media and suggestions. - # You can group multiple rich cards into one using RbmCarouselCard but - # carousel cards will give you less control over the card layout. + # Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to + # respond to users with more vivid content, e.g. with media and suggestions. You + # can group multiple rich cards into one using RbmCarouselCard but carousel + # cards will give you less control over the card layout. # Corresponds to the JSON property `rbmStandaloneRichCard` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard] attr_accessor :rbm_standalone_rich_card @@ -4661,10 +4412,9 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmText] attr_accessor :rbm_text - # The collection of simple response candidates. - # This message in `QueryResult.fulfillment_messages` and - # `WebhookResponse.fulfillment_messages` should contain only one - # `SimpleResponse`. + # The collection of simple response candidates. This message in `QueryResult. + # fulfillment_messages` and `WebhookResponse.fulfillment_messages` should + # contain only one `SimpleResponse`. # Corresponds to the JSON property `simpleResponses` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses] attr_accessor :simple_responses @@ -4685,10 +4435,9 @@ module Google attr_accessor :telephony_play_audio # Synthesizes speech and plays back the synthesized audio to the caller in - # Telephony Gateway. - # Telephony Gateway takes the synthesizer settings from - # `DetectIntentResponse.output_audio_config` which can either be set - # at request-level or can come from the agent-level synthesizer config. + # Telephony Gateway. Telephony Gateway takes the synthesizer settings from ` + # DetectIntentResponse.output_audio_config` which can either be set at request- + # level or can come from the agent-level synthesizer config. # Corresponds to the JSON property `telephonySynthesizeSpeech` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech] attr_accessor :telephony_synthesize_speech @@ -4820,19 +4569,18 @@ module Google end end - # Browse Carousel Card for Actions on Google. - # https://developers.google.com/actions/assistant/responses#browsing_carousel + # Browse Carousel Card for Actions on Google. https://developers.google.com/ + # actions/assistant/responses#browsing_carousel class GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard include Google::Apis::Core::Hashable - # Optional. Settings for displaying the image. Applies to every image in - # items. + # Optional. Settings for displaying the image. Applies to every image in items. # Corresponds to the JSON property `imageDisplayOptions` # @return [String] attr_accessor :image_display_options - # Required. List of items in the Browse Carousel Card. Minimum of two - # items, maximum of ten. + # Required. List of items in the Browse Carousel Card. Minimum of two items, + # maximum of ten. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items @@ -4852,14 +4600,13 @@ module Google class GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem include Google::Apis::Core::Hashable - # Optional. Description of the carousel item. Maximum of four lines of - # text. + # Optional. Description of the carousel item. Maximum of four lines of text. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Optional. Text that appears at the bottom of the Browse Carousel - # Card. Maximum of one line of text. + # Optional. Text that appears at the bottom of the Browse Carousel Card. Maximum + # of one line of text. # Corresponds to the JSON property `footer` # @return [String] attr_accessor :footer @@ -4902,8 +4649,8 @@ module Google # @return [String] attr_accessor :url - # Optional. Specifies the type of viewer that is used when opening - # the URL. Defaults to opening via web browser. + # Optional. Specifies the type of viewer that is used when opening the URL. + # Defaults to opening via web browser. # Corresponds to the JSON property `urlTypeHint` # @return [String] attr_accessor :url_type_hint @@ -4960,8 +4707,7 @@ module Google class GoogleCloudDialogflowV2beta1IntentMessageCardButton include Google::Apis::Core::Hashable - # Optional. The text to send back to the Dialogflow API or a URI to - # open. + # Optional. The text to send back to the Dialogflow API or a URI to open. # Corresponds to the JSON property `postback` # @return [String] attr_accessor :postback @@ -5015,8 +4761,7 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageImage] attr_accessor :image - # Additional info about the select item for when it is triggered in a - # dialog. + # Additional info about the select item for when it is triggered in a dialog. # Corresponds to the JSON property `info` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo] attr_accessor :info @@ -5068,8 +4813,8 @@ module Google class GoogleCloudDialogflowV2beta1IntentMessageImage include Google::Apis::Core::Hashable - # A text description of the image to be used for accessibility, - # e.g., screen readers. Required if image_uri is set for CarouselSelect. + # A text description of the image to be used for accessibility, e.g., screen + # readers. Required if image_uri is set for CarouselSelect. # Corresponds to the JSON property `accessibilityText` # @return [String] attr_accessor :accessibility_text @@ -5090,8 +4835,8 @@ module Google end end - # The suggestion chip message that allows the user to jump out to the app - # or website associated with this agent. + # The suggestion chip message that allows the user to jump out to the app or + # website associated with this agent. class GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion include Google::Apis::Core::Hashable @@ -5100,8 +4845,8 @@ module Google # @return [String] attr_accessor :destination_name - # Required. The URI of the app or site to open when the user taps the - # suggestion chip. + # Required. The URI of the app or site to open when the user taps the suggestion + # chip. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -5162,8 +4907,7 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageImage] attr_accessor :image - # Additional info about the select item for when it is triggered in a - # dialog. + # Additional info about the select item for when it is triggered in a dialog. # Corresponds to the JSON property `info` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo] attr_accessor :info @@ -5283,26 +5027,16 @@ module Google class GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent include Google::Apis::Core::Hashable - # Optional. Description of the card (at most 2000 bytes). - # At least one of the title, description or media must be set. + # Optional. Description of the card (at most 2000 bytes). At least one of the + # title, description or media must be set. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Rich Business Messaging (RBM) Media displayed in Cards - # The following media-types are currently supported: - # Image Types - # * image/jpeg - # * image/jpg' - # * image/gif - # * image/png - # Video Types - # * video/h263 - # * video/m4v - # * video/mp4 - # * video/mpeg - # * video/mpeg4 - # * video/webm + # Rich Business Messaging (RBM) Media displayed in Cards The following media- + # types are currently supported: Image Types * image/jpeg * image/jpg' * image/ + # gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * + # video/mpeg4 * video/webm # Corresponds to the JSON property `media` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia] attr_accessor :media @@ -5312,8 +5046,8 @@ module Google # @return [Array] attr_accessor :suggestions - # Optional. Title of the card (at most 200 bytes). - # At least one of the title, description or media must be set. + # Optional. Title of the card (at most 200 bytes). At least one of the title, + # description or media must be set. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -5331,44 +5065,33 @@ module Google end end - # Rich Business Messaging (RBM) Media displayed in Cards - # The following media-types are currently supported: - # Image Types - # * image/jpeg - # * image/jpg' - # * image/gif - # * image/png - # Video Types - # * video/h263 - # * video/m4v - # * video/mp4 - # * video/mpeg - # * video/mpeg4 - # * video/webm + # Rich Business Messaging (RBM) Media displayed in Cards The following media- + # types are currently supported: Image Types * image/jpeg * image/jpg' * image/ + # gif * image/png Video Types * video/h263 * video/m4v * video/mp4 * video/mpeg * + # video/mpeg4 * video/webm class GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia include Google::Apis::Core::Hashable - # Required. Publicly reachable URI of the file. The RBM platform - # determines the MIME type of the file from the content-type field in - # the HTTP headers when the platform fetches the file. The content-type - # field must be present and accurate in the HTTP response from the URL. + # Required. Publicly reachable URI of the file. The RBM platform determines the + # MIME type of the file from the content-type field in the HTTP headers when the + # platform fetches the file. The content-type field must be present and accurate + # in the HTTP response from the URL. # Corresponds to the JSON property `fileUri` # @return [String] attr_accessor :file_uri - # Required for cards with vertical orientation. The height of the media - # within a rich card with a vertical layout. - # For a standalone card with horizontal layout, height is not - # customizable, and this field is ignored. + # Required for cards with vertical orientation. The height of the media within a + # rich card with a vertical layout. For a standalone card with horizontal layout, + # height is not customizable, and this field is ignored. # Corresponds to the JSON property `height` # @return [String] attr_accessor :height - # Optional. Publicly reachable URI of the thumbnail.If you don't - # provide a thumbnail URI, the RBM platform displays a blank - # placeholder thumbnail until the user's device downloads the file. - # Depending on the user's setting, the file may not download - # automatically and may require the user to tap a download button. + # Optional. Publicly reachable URI of the thumbnail.If you don't provide a + # thumbnail URI, the RBM platform displays a blank placeholder thumbnail until + # the user's device downloads the file. Depending on the user's setting, the + # file may not download automatically and may require the user to tap a download + # button. # Corresponds to the JSON property `thumbnailUri` # @return [String] attr_accessor :thumbnail_uri @@ -5385,16 +5108,15 @@ module Google end end - # Carousel Rich Business Messaging (RBM) rich card. - # Rich cards allow you to respond to users with more vivid content, e.g. - # with media and suggestions. - # If you want to show a single card with more control over the layout, - # please use RbmStandaloneCard instead. + # Carousel Rich Business Messaging (RBM) rich card. Rich cards allow you to + # respond to users with more vivid content, e.g. with media and suggestions. If + # you want to show a single card with more control over the layout, please use + # RbmStandaloneCard instead. class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard include Google::Apis::Core::Hashable - # Required. The cards in the carousel. A carousel must have at least - # 2 cards and at most 10. + # Required. The cards in the carousel. A carousel must have at least 2 cards and + # at most 10. # Corresponds to the JSON property `cardContents` # @return [Array] attr_accessor :card_contents @@ -5415,11 +5137,10 @@ module Google end end - # Standalone Rich Business Messaging (RBM) rich card. - # Rich cards allow you to respond to users with more vivid content, e.g. - # with media and suggestions. - # You can group multiple rich cards into one using RbmCarouselCard but - # carousel cards will give you less control over the card layout. + # Standalone Rich Business Messaging (RBM) rich card. Rich cards allow you to + # respond to users with more vivid content, e.g. with media and suggestions. You + # can group multiple rich cards into one using RbmCarouselCard but carousel + # cards will give you less control over the card layout. class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard include Google::Apis::Core::Hashable @@ -5433,8 +5154,8 @@ module Google # @return [String] attr_accessor :card_orientation - # Required if orientation is horizontal. - # Image preview alignment for standalone cards with horizontal layout. + # Required if orientation is horizontal. Image preview alignment for standalone + # cards with horizontal layout. # Corresponds to the JSON property `thumbnailImageAlignment` # @return [String] attr_accessor :thumbnail_image_alignment @@ -5451,34 +5172,34 @@ module Google end end - # Rich Business Messaging (RBM) suggested client-side action that the user - # can choose from the card. + # Rich Business Messaging (RBM) suggested client-side action that the user can + # choose from the card. class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction include Google::Apis::Core::Hashable - # Opens the user's default dialer app with the specified phone number - # but does not dial automatically. + # Opens the user's default dialer app with the specified phone number but does + # not dial automatically. # Corresponds to the JSON property `dial` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial] attr_accessor :dial - # Opens the user's default web browser app to the specified uri - # If the user has an app installed that is - # registered as the default handler for the URL, then this app will be - # opened instead, and its icon will be used in the suggested action UI. + # Opens the user's default web browser app to the specified uri If the user has + # an app installed that is registered as the default handler for the URL, then + # this app will be opened instead, and its icon will be used in the suggested + # action UI. # Corresponds to the JSON property `openUrl` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri] attr_accessor :open_url - # Opaque payload that the Dialogflow receives in a user event - # when the user taps the suggested action. This data will be also - # forwarded to webhook to allow performing custom business logic. + # Opaque payload that the Dialogflow receives in a user event when the user taps + # the suggested action. This data will be also forwarded to webhook to allow + # performing custom business logic. # Corresponds to the JSON property `postbackData` # @return [String] attr_accessor :postback_data - # Opens the device's location chooser so the user can pick a location - # to send back to the agent. + # Opens the device's location chooser so the user can pick a location to send + # back to the agent. # Corresponds to the JSON property `shareLocation` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation] attr_accessor :share_location @@ -5502,15 +5223,14 @@ module Google end end - # Opens the user's default dialer app with the specified phone number - # but does not dial automatically. + # Opens the user's default dialer app with the specified phone number but does + # not dial automatically. class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial include Google::Apis::Core::Hashable - # Required. The phone number to fill in the default dialer app. - # This field should be in [E.164](https://en.wikipedia.org/wiki/E.164) - # format. An example of a correctly formatted phone number: - # +15556767888. + # Required. The phone number to fill in the default dialer app. This field + # should be in [E.164](https://en.wikipedia.org/wiki/E.164) format. An example + # of a correctly formatted phone number: +15556767888. # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number @@ -5525,10 +5245,10 @@ module Google end end - # Opens the user's default web browser app to the specified uri - # If the user has an app installed that is - # registered as the default handler for the URL, then this app will be - # opened instead, and its icon will be used in the suggested action UI. + # Opens the user's default web browser app to the specified uri If the user has + # an app installed that is registered as the default handler for the URL, then + # this app will be opened instead, and its icon will be used in the suggested + # action UI. class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri include Google::Apis::Core::Hashable @@ -5547,8 +5267,8 @@ module Google end end - # Opens the device's location chooser so the user can pick a location - # to send back to the agent. + # Opens the device's location chooser so the user can pick a location to send + # back to the agent. class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation include Google::Apis::Core::Hashable @@ -5561,14 +5281,14 @@ module Google end end - # Rich Business Messaging (RBM) suggested reply that the user can click - # instead of typing in their own response. + # Rich Business Messaging (RBM) suggested reply that the user can click instead + # of typing in their own response. class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply include Google::Apis::Core::Hashable - # Opaque payload that the Dialogflow receives in a user event - # when the user taps the suggested reply. This data will be also - # forwarded to webhook to allow performing custom business logic. + # Opaque payload that the Dialogflow receives in a user event when the user taps + # the suggested reply. This data will be also forwarded to webhook to allow + # performing custom business logic. # Corresponds to the JSON property `postbackData` # @return [String] attr_accessor :postback_data @@ -5589,20 +5309,20 @@ module Google end end - # Rich Business Messaging (RBM) suggestion. Suggestions allow user to - # easily select/click a predefined response or perform an action (like - # opening a web uri). + # Rich Business Messaging (RBM) suggestion. Suggestions allow user to easily + # select/click a predefined response or perform an action (like opening a web + # uri). class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion include Google::Apis::Core::Hashable - # Rich Business Messaging (RBM) suggested client-side action that the user - # can choose from the card. + # Rich Business Messaging (RBM) suggested client-side action that the user can + # choose from the card. # Corresponds to the JSON property `action` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction] attr_accessor :action - # Rich Business Messaging (RBM) suggested reply that the user can click - # instead of typing in their own response. + # Rich Business Messaging (RBM) suggested reply that the user can click instead + # of typing in their own response. # Corresponds to the JSON property `reply` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply] attr_accessor :reply @@ -5643,19 +5363,18 @@ module Google end end - # Additional info about the select item for when it is triggered in a - # dialog. + # Additional info about the select item for when it is triggered in a dialog. class GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo include Google::Apis::Core::Hashable - # Required. A unique key that will be sent back to the agent if this - # response is given. + # Required. A unique key that will be sent back to the agent if this response is + # given. # Corresponds to the JSON property `key` # @return [String] attr_accessor :key - # Optional. A list of synonyms that can also be used to trigger this - # item in dialog. + # Optional. A list of synonyms that can also be used to trigger this item in + # dialog. # Corresponds to the JSON property `synonyms` # @return [Array] attr_accessor :synonyms @@ -5680,15 +5399,14 @@ module Google # @return [String] attr_accessor :display_text - # One of text_to_speech or ssml must be provided. Structured spoken - # response to the user in the SSML format. Mutually exclusive with - # text_to_speech. + # One of text_to_speech or ssml must be provided. Structured spoken response to + # the user in the SSML format. Mutually exclusive with text_to_speech. # Corresponds to the JSON property `ssml` # @return [String] attr_accessor :ssml - # One of text_to_speech or ssml must be provided. The plain text of the - # speech output. Mutually exclusive with ssml. + # One of text_to_speech or ssml must be provided. The plain text of the speech + # output. Mutually exclusive with ssml. # Corresponds to the JSON property `textToSpeech` # @return [String] attr_accessor :text_to_speech @@ -5705,10 +5423,9 @@ module Google end end - # The collection of simple response candidates. - # This message in `QueryResult.fulfillment_messages` and - # `WebhookResponse.fulfillment_messages` should contain only one - # `SimpleResponse`. + # The collection of simple response candidates. This message in `QueryResult. + # fulfillment_messages` and `WebhookResponse.fulfillment_messages` should + # contain only one `SimpleResponse`. class GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses include Google::Apis::Core::Hashable @@ -5727,8 +5444,8 @@ module Google end end - # The suggestion chip message that the user can tap to quickly post a reply - # to the conversation. + # The suggestion chip message that the user can tap to quickly post a reply to + # the conversation. class GoogleCloudDialogflowV2beta1IntentMessageSuggestion include Google::Apis::Core::Hashable @@ -5864,17 +5581,15 @@ module Google class GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio include Google::Apis::Core::Hashable - # Required. URI to a Google Cloud Storage object containing the audio to - # play, e.g., "gs://bucket/object". The object must contain a single - # channel (mono) of linear PCM audio (2 bytes / sample) at 8kHz. - # This object must be readable by the `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account - # where is the number of the Telephony Gateway project - # (usually the same as the Dialogflow agent project). If the Google Cloud - # Storage bucket is in the Telephony Gateway project, this permission is - # added by default when enabling the Dialogflow V2 API. - # For audio from other sources, consider using the - # `TelephonySynthesizeSpeech` message with SSML. + # Required. URI to a Google Cloud Storage object containing the audio to play, e. + # g., "gs://bucket/object". The object must contain a single channel (mono) of + # linear PCM audio (2 bytes / sample) at 8kHz. This object must be readable by + # the `service-@gcp-sa-dialogflow.iam.gserviceaccount.com` service account where + # is the number of the Telephony Gateway project (usually the same as the + # Dialogflow agent project). If the Google Cloud Storage bucket is in the + # Telephony Gateway project, this permission is added by default when enabling + # the Dialogflow V2 API. For audio from other sources, consider using the ` + # TelephonySynthesizeSpeech` message with SSML. # Corresponds to the JSON property `audioUri` # @return [String] attr_accessor :audio_uri @@ -5890,15 +5605,14 @@ module Google end # Synthesizes speech and plays back the synthesized audio to the caller in - # Telephony Gateway. - # Telephony Gateway takes the synthesizer settings from - # `DetectIntentResponse.output_audio_config` which can either be set - # at request-level or can come from the agent-level synthesizer config. + # Telephony Gateway. Telephony Gateway takes the synthesizer settings from ` + # DetectIntentResponse.output_audio_config` which can either be set at request- + # level or can come from the agent-level synthesizer config. class GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech include Google::Apis::Core::Hashable - # The SSML to be synthesized. For more information, see - # [SSML](https://developers.google.com/actions/reference/ssml). + # The SSML to be synthesized. For more information, see [SSML](https:// + # developers.google.com/actions/reference/ssml). # Corresponds to the JSON property `ssml` # @return [String] attr_accessor :ssml @@ -5923,9 +5637,9 @@ module Google class GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall include Google::Apis::Core::Hashable - # Required. The phone number to transfer the call to - # in [E.164 format](https://en.wikipedia.org/wiki/E.164). - # We currently only allow transferring to US numbers (+1xxxyyyzzzz). + # Required. The phone number to transfer the call to in [E.164 format](https:// + # en.wikipedia.org/wiki/E.164). We currently only allow transferring to US + # numbers (+1xxxyyyzzzz). # Corresponds to the JSON property `phoneNumber` # @return [String] attr_accessor :phone_number @@ -5963,10 +5677,9 @@ module Google class GoogleCloudDialogflowV2beta1IntentParameter include Google::Apis::Core::Hashable - # Optional. The default value to use when the `value` yields an empty - # result. - # Default values can be extracted from contexts by using the following - # syntax: `#context_name.parameter_name`. + # Optional. The default value to use when the `value` yields an empty result. + # Default values can be extracted from contexts by using the following syntax: `# + # context_name.parameter_name`. # Corresponds to the JSON property `defaultValue` # @return [String] attr_accessor :default_value @@ -5976,9 +5689,8 @@ module Google # @return [String] attr_accessor :display_name - # Optional. The name of the entity type, prefixed with `@`, that - # describes values of the parameter. If the parameter is - # required, this must be provided. + # Optional. The name of the entity type, prefixed with `@`, that describes + # values of the parameter. If the parameter is required, this must be provided. # Corresponds to the JSON property `entityTypeDisplayName` # @return [String] attr_accessor :entity_type_display_name @@ -5989,9 +5701,8 @@ module Google attr_accessor :is_list alias_method :is_list?, :is_list - # Optional. Indicates whether the parameter is required. That is, - # whether the intent cannot be completed without collecting the parameter - # value. + # Optional. Indicates whether the parameter is required. That is, whether the + # intent cannot be completed without collecting the parameter value. # Corresponds to the JSON property `mandatory` # @return [Boolean] attr_accessor :mandatory @@ -6002,18 +5713,16 @@ module Google # @return [String] attr_accessor :name - # Optional. The collection of prompts that the agent can present to the - # user in order to collect a value for the parameter. + # Optional. The collection of prompts that the agent can present to the user in + # order to collect a value for the parameter. # Corresponds to the JSON property `prompts` # @return [Array] attr_accessor :prompts - # Optional. The definition of the parameter value. It can be: - # - a constant string, - # - a parameter value defined as `$parameter_name`, - # - an original parameter value defined as `$parameter_name.original`, - # - a parameter value from some context defined as - # `#context_name.parameter_name`. + # Optional. The definition of the parameter value. It can be: - a constant + # string, - a parameter value defined as `$parameter_name`, - an original + # parameter value defined as `$parameter_name.original`, - a parameter value + # from some context defined as `#context_name.parameter_name`. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -6044,27 +5753,25 @@ module Google # @return [String] attr_accessor :name - # Required. The ordered list of training phrase parts. - # The parts are concatenated in order to form the training phrase. - # Note: The API does not automatically annotate training phrases like the - # Dialogflow Console does. - # Note: Do not forget to include whitespace at part boundaries, - # so the training phrase is well formatted when the parts are concatenated. - # If the training phrase does not need to be annotated with parameters, - # you just need a single part with only the Part.text field set. - # If you want to annotate the training phrase, you must create multiple - # parts, where the fields of each part are populated in one of two ways: - # - `Part.text` is set to a part of the phrase that has no parameters. - # - `Part.text` is set to a part of the phrase that you want to annotate, - # and the `entity_type`, `alias`, and `user_defined` fields are all - # set. + # Required. The ordered list of training phrase parts. The parts are + # concatenated in order to form the training phrase. Note: The API does not + # automatically annotate training phrases like the Dialogflow Console does. Note: + # Do not forget to include whitespace at part boundaries, so the training + # phrase is well formatted when the parts are concatenated. If the training + # phrase does not need to be annotated with parameters, you just need a single + # part with only the Part.text field set. If you want to annotate the training + # phrase, you must create multiple parts, where the fields of each part are + # populated in one of two ways: - `Part.text` is set to a part of the phrase + # that has no parameters. - `Part.text` is set to a part of the phrase that you + # want to annotate, and the `entity_type`, `alias`, and `user_defined` fields + # are all set. # Corresponds to the JSON property `parts` # @return [Array] attr_accessor :parts - # Optional. Indicates how many times this example was added to - # the intent. Each time a developer adds an existing sample by editing an - # intent or training, this counter is increased. + # Optional. Indicates how many times this example was added to the intent. Each + # time a developer adds an existing sample by editing an intent or training, + # this counter is increased. # Corresponds to the JSON property `timesAddedCount` # @return [Fixnum] attr_accessor :times_added_count @@ -6091,15 +5798,15 @@ module Google class GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart include Google::Apis::Core::Hashable - # Optional. The parameter name for the value extracted from the - # annotated part of the example. - # This field is required for annotated parts of the training phrase. + # Optional. The parameter name for the value extracted from the annotated part + # of the example. This field is required for annotated parts of the training + # phrase. # Corresponds to the JSON property `alias` # @return [String] attr_accessor :alias - # Optional. The entity type name prefixed with `@`. - # This field is required for annotated parts of the training phrase. + # Optional. The entity type name prefixed with `@`. This field is required for + # annotated parts of the training phrase. # Corresponds to the JSON property `entityType` # @return [String] attr_accessor :entity_type @@ -6109,10 +5816,9 @@ module Google # @return [String] attr_accessor :text - # Optional. Indicates whether the text was manually annotated. - # This field is set to true when the Dialogflow Console is used to - # manually annotate the part. When creating an annotated part with the - # API, you must set this to true. + # Optional. Indicates whether the text was manually annotated. This field is set + # to true when the Dialogflow Console is used to manually annotate the part. + # When creating an annotated part with the API, you must set this to true. # Corresponds to the JSON property `userDefined` # @return [Boolean] attr_accessor :user_defined @@ -6154,43 +5860,39 @@ module Google class GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer include Google::Apis::Core::Hashable - # The piece of text from the `source` knowledge base document that answers - # this conversational query. + # The piece of text from the `source` knowledge base document that answers this + # conversational query. # Corresponds to the JSON property `answer` # @return [String] attr_accessor :answer - # The corresponding FAQ question if the answer was extracted from a FAQ - # Document, empty otherwise. + # The corresponding FAQ question if the answer was extracted from a FAQ Document, + # empty otherwise. # Corresponds to the JSON property `faqQuestion` # @return [String] attr_accessor :faq_question - # The system's confidence score that this Knowledge answer is a good match - # for this conversational query. - # The range is from 0.0 (completely uncertain) to 1.0 (completely certain). - # Note: The confidence score is likely to vary somewhat (possibly even for - # identical requests), as the underlying model is under constant - # improvement. It may be deprecated in the future. We recommend using - # `match_confidence_level` which should be generally more stable. + # The system's confidence score that this Knowledge answer is a good match for + # this conversational query. The range is from 0.0 (completely uncertain) to 1.0 + # (completely certain). Note: The confidence score is likely to vary somewhat ( + # possibly even for identical requests), as the underlying model is under + # constant improvement. It may be deprecated in the future. We recommend using ` + # match_confidence_level` which should be generally more stable. # Corresponds to the JSON property `matchConfidence` # @return [Float] attr_accessor :match_confidence - # The system's confidence level that this knowledge answer is a good match - # for this conversational query. - # NOTE: The confidence level for a given `` pair may change - # without notice, as it depends on models that are constantly being - # improved. However, it will change less frequently than the confidence - # score below, and should be preferred for referencing the quality of an - # answer. + # The system's confidence level that this knowledge answer is a good match for + # this conversational query. NOTE: The confidence level for a given `` pair may + # change without notice, as it depends on models that are constantly being + # improved. However, it will change less frequently than the confidence score + # below, and should be preferred for referencing the quality of an answer. # Corresponds to the JSON property `matchConfidenceLevel` # @return [String] attr_accessor :match_confidence_level - # Indicates which Knowledge Document this answer was extracted from. - # Format: `projects//knowledgeBases//documents/`. + # Indicates which Knowledge Document this answer was extracted from. Format: ` + # projects//knowledgeBases//documents/`. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source @@ -6212,30 +5914,28 @@ module Google # A knowledge base represents a collection of knowledge documents that you # provide to Dialogflow. Your knowledge documents contain information that may # be useful during conversations with end-users. Some Dialogflow features use - # knowledge bases when looking for a response to an end-user input. - # For more information, see the [knowledge base - # guide](https://cloud.google.com/dialogflow/docs/how/knowledge-bases). - # Note: The `projects.agent.knowledgeBases` resource is deprecated; - # only use `projects.knowledgeBases`. + # knowledge bases when looking for a response to an end-user input. For more + # information, see the [knowledge base guide](https://cloud.google.com/ + # dialogflow/docs/how/knowledge-bases). Note: The `projects.agent.knowledgeBases` + # resource is deprecated; only use `projects.knowledgeBases`. class GoogleCloudDialogflowV2beta1KnowledgeBase include Google::Apis::Core::Hashable - # Required. The display name of the knowledge base. The name must be 1024 - # bytes or less; otherwise, the creation request fails. + # Required. The display name of the knowledge base. The name must be 1024 bytes + # or less; otherwise, the creation request fails. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Language which represents the KnowledgeBase. When the KnowledgeBase is - # created/updated, this is populated for all non en-us languages. If not - # populated, the default language en-us applies. + # Language which represents the KnowledgeBase. When the KnowledgeBase is created/ + # updated, this is populated for all non en-us languages. If not populated, the + # default language en-us applies. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # The knowledge base resource name. - # The name must be empty when creating a knowledge base. - # Format: `projects//knowledgeBases/`. + # The knowledge base resource name. The name must be empty when creating a + # knowledge base. Format: `projects//knowledgeBases/`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -6271,16 +5971,14 @@ module Google end end - # The response for - # ConversationDatasets.LabelConversation. + # The response for ConversationDatasets.LabelConversation. class GoogleCloudDialogflowV2beta1LabelConversationResponse include Google::Apis::Core::Hashable - # Represents an annotated conversation dataset. - # ConversationDataset can have multiple AnnotatedConversationDataset, each of - # them represents one result from one annotation task. - # AnnotatedConversationDataset can only be generated from annotation task, - # which will be triggered by LabelConversation. + # Represents an annotated conversation dataset. ConversationDataset can have + # multiple AnnotatedConversationDataset, each of them represents one result from + # one annotation task. AnnotatedConversationDataset can only be generated from + # annotation task, which will be triggered by LabelConversation. # Corresponds to the JSON property `annotatedConversationDataset` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1AnnotatedConversationDataset] attr_accessor :annotated_conversation_dataset @@ -6299,14 +5997,14 @@ module Google class GoogleCloudDialogflowV2beta1ListContextsResponse include Google::Apis::Core::Hashable - # The list of contexts. There will be a maximum number of items - # returned based on the page_size field in the request. + # The list of contexts. There will be a maximum number of items returned based + # on the page_size field in the request. # Corresponds to the JSON property `contexts` # @return [Array] attr_accessor :contexts - # 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 @@ -6331,8 +6029,8 @@ module Google # @return [Array] attr_accessor :documents - # 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 @@ -6358,8 +6056,8 @@ module Google # @return [Array] attr_accessor :entity_types - # 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 @@ -6385,8 +6083,8 @@ module Google # @return [Array] attr_accessor :environments - # 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 @@ -6406,14 +6104,14 @@ module Google class GoogleCloudDialogflowV2beta1ListIntentsResponse include Google::Apis::Core::Hashable - # The list of agent intents. There will be a maximum number of items - # returned based on the page_size field in the request. + # The list of agent intents. There will be a maximum number of items returned + # based on the page_size field in the request. # Corresponds to the JSON property `intents` # @return [Array] attr_accessor :intents - # 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 @@ -6438,8 +6136,8 @@ module Google # @return [Array] attr_accessor :knowledge_bases - # 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 @@ -6459,8 +6157,8 @@ module Google class GoogleCloudDialogflowV2beta1ListSessionEntityTypesResponse 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 @@ -6482,36 +6180,30 @@ module Google end end - # Represents the contents of the original request that was passed to - # the `[Streaming]DetectIntent` call. + # Represents the contents of the original request that was passed to the `[ + # Streaming]DetectIntent` call. class GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest include Google::Apis::Core::Hashable # Optional. This field is set to the value of the `QueryParameters.payload` - # field passed in the request. Some integrations that query a Dialogflow - # agent may provide additional information in the payload. - # In particular, for the Dialogflow Phone Gateway integration, this field has - # the form: - # 
`
-        # "telephony": `
-        # "caller_id": "+18558363987"
-        # `
-        # `
- # Note: The caller ID field (`caller_id`) will be redacted for Standard - # Edition agents and populated with the caller ID in [E.164 - # format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. + # field passed in the request. Some integrations that query a Dialogflow agent + # may provide additional information in the payload. In particular, for the + # Dialogflow Phone Gateway integration, this field has the form: ` "telephony": ` + # "caller_id": "+18558363987" ` ` Note: The caller ID field (`caller_id`) will + # be redacted for Standard Edition agents and populated with the caller ID in [E. + # 164 format](https://en.wikipedia.org/wiki/E.164) for Enterprise Edition agents. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload - # The source of this request, e.g., `google`, `facebook`, `slack`. It is set - # by Dialogflow-owned servers. + # The source of this request, e.g., `google`, `facebook`, `slack`. It is set by + # Dialogflow-owned servers. # Corresponds to the JSON property `source` # @return [String] attr_accessor :source - # Optional. The version of the protocol used for this request. - # This field is AoG-specific. + # Optional. The version of the protocol used for this request. This field is AoG- + # specific. # Corresponds to the JSON property `version` # @return [String] attr_accessor :version @@ -6528,9 +6220,9 @@ module Google end end - # Instructs the speech synthesizer how to generate the output audio content. - # If this audio config is supplied in a request, it overrides all existing - # text-to-speech settings applied to the agent. + # Instructs the speech synthesizer how to generate the output audio content. If + # this audio config is supplied in a request, it overrides all existing text-to- + # speech settings applied to the agent. class GoogleCloudDialogflowV2beta1OutputAudioConfig include Google::Apis::Core::Hashable @@ -6539,11 +6231,11 @@ module Google # @return [String] attr_accessor :audio_encoding - # The synthesis sample rate (in hertz) for this audio. If not - # provided, then the synthesizer will use the default sample rate based on - # the audio encoding. If this is different from the voice's natural sample - # rate, then the synthesizer will honor this request by converting to the - # desired sample rate (which might result in worse audio quality). + # The synthesis sample rate (in hertz) for this audio. If not provided, then the + # synthesizer will use the default sample rate based on the audio encoding. If + # this is different from the voice's natural sample rate, then the synthesizer + # will honor this request by converting to the desired sample rate (which might + # result in worse audio quality). # Corresponds to the JSON property `sampleRateHertz` # @return [Fixnum] attr_accessor :sample_rate_hertz @@ -6565,11 +6257,10 @@ module Google end end - # Represents the query input. It can contain either: - # 1. An audio config which - # instructs the speech recognizer how to process the speech audio. - # 2. A conversational query in the form of text. - # 3. An event that specifies which intent to trigger. + # Represents the query input. It can contain either: 1. An audio config which + # instructs the speech recognizer how to process the speech audio. 2. A + # conversational query in the form of text. 3. An event that specifies which + # intent to trigger. class GoogleCloudDialogflowV2beta1QueryInput include Google::Apis::Core::Hashable @@ -6579,10 +6270,9 @@ module Google attr_accessor :audio_config # Events allow for matching intents by event name instead of the natural - # language input. For instance, input `` can trigger a personalized welcome response. - # The parameter `name` may be used by the agent in the response: - # `"Hello #welcome_event.name! What can I do for you today?"`. + # language input. For instance, input `` can trigger a personalized welcome + # response. The parameter `name` may be used by the agent in the response: `" + # Hello #welcome_event.name! What can I do for you today?"`. # Corresponds to the JSON property `event` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EventInput] attr_accessor :event @@ -6608,39 +6298,36 @@ module Google class GoogleCloudDialogflowV2beta1QueryParameters include Google::Apis::Core::Hashable - # The collection of contexts to be activated before this query is - # executed. + # The collection of contexts to be activated before this query is executed. # Corresponds to the JSON property `contexts` # @return [Array] attr_accessor :contexts # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `geoLocation` # @return [Google::Apis::DialogflowV2beta1::GoogleTypeLatLng] attr_accessor :geo_location - # KnowledgeBases to get alternative results from. If not set, the - # KnowledgeBases enabled in the agent (through UI) will be used. - # Format: `projects//knowledgeBases/`. + # KnowledgeBases to get alternative results from. If not set, the KnowledgeBases + # enabled in the agent (through UI) will be used. Format: `projects// + # knowledgeBases/`. # Corresponds to the JSON property `knowledgeBaseNames` # @return [Array] attr_accessor :knowledge_base_names - # This field can be used to pass custom data to your webhook. - # Arbitrary JSON objects are supported. - # If supplied, the value is used to populate the - # `WebhookRequest.original_detect_intent_request.payload` - # field sent to your webhook. + # This field can be used to pass custom data to your webhook. Arbitrary JSON + # objects are supported. If supplied, the value is used to populate the ` + # WebhookRequest.original_detect_intent_request.payload` field sent to your + # webhook. # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload - # Specifies whether to delete all contexts in the current session - # before the new ones are activated. + # Specifies whether to delete all contexts in the current session before the new + # ones are activated. # Corresponds to the JSON property `resetContexts` # @return [Boolean] attr_accessor :reset_contexts @@ -6651,37 +6338,36 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig] attr_accessor :sentiment_analysis_request_config - # Additional session entity types to replace or extend developer - # entity types with. The entity synonyms apply to all languages and persist - # for the session of this query. + # Additional session entity types to replace or extend developer entity types + # with. The entity synonyms apply to all languages and persist for the session + # of this query. # Corresponds to the JSON property `sessionEntityTypes` # @return [Array] attr_accessor :session_entity_types - # For mega agent query, directly specify which sub agents to query. - # If any specified sub agent is not linked to the mega agent, an error will - # be returned. If empty, Dialogflow will decide which sub agents to query. - # If specified for a non-mega-agent query, will be silently ignored. + # For mega agent query, directly specify which sub agents to query. If any + # specified sub agent is not linked to the mega agent, an error will be returned. + # If empty, Dialogflow will decide which sub agents to query. If specified for + # a non-mega-agent query, will be silently ignored. # Corresponds to the JSON property `subAgents` # @return [Array] attr_accessor :sub_agents - # The time zone of this conversational query from the - # [time zone database](https://www.iana.org/time-zones), e.g., - # America/New_York, Europe/Paris. If not provided, the time zone specified in - # agent settings is used. + # The time zone of this conversational query from the [time zone database](https: + # //www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. If not + # provided, the time zone specified in agent settings is used. # Corresponds to the JSON property `timeZone` # @return [String] attr_accessor :time_zone - # This field can be used to pass HTTP headers for a webhook - # call. These headers will be sent to webhook alone with the headers that - # have been configured through Dialogflow web console. The headers defined - # within this field will overwrite the headers configured through Dialogflow - # console if there is a conflict. Header names are case-insensitive. - # Google's specified headers are not allowed. Including: "Host", - # "Content-Length", "Connection", "From", "User-Agent", "Accept-Encoding", - # "If-Modified-Since", "If-None-Match", "X-Forwarded-For", etc. + # This field can be used to pass HTTP headers for a webhook call. These headers + # will be sent to webhook alone with the headers that have been configured + # through Dialogflow web console. The headers defined within this field will + # overwrite the headers configured through Dialogflow console if there is a + # conflict. Header names are case-insensitive. Google's specified headers are + # not allowed. Including: "Host", "Content-Length", "Connection", "From", "User- + # Agent", "Accept-Encoding", "If-Modified-Since", "If-None-Match", "X-Forwarded- + # For", etc. # Corresponds to the JSON property `webhookHeaders` # @return [Hash] attr_accessor :webhook_headers @@ -6714,22 +6400,19 @@ module Google # @return [String] attr_accessor :action - # This field is set to: - # - `false` if the matched intent has required parameters and not all of - # the required parameter values have been collected. - # - `true` if all required parameter values have been collected, or if the - # matched intent doesn't contain any required parameters. + # This field is set to: - `false` if the matched intent has required parameters + # and not all of the required parameter values have been collected. - `true` if + # all required parameter values have been collected, or if the matched intent + # doesn't contain any required parameters. # Corresponds to the JSON property `allRequiredParamsPresent` # @return [Boolean] attr_accessor :all_required_params_present alias_method :all_required_params_present?, :all_required_params_present - # Free-form diagnostic information for the associated detect intent request. - # The fields of this data can change without notice, so you should not write - # code that depends on its structure. - # The data may contain: - # - webhook call latency - # - webhook errors + # Free-form diagnostic information for the associated detect intent request. The + # fields of this data can change without notice, so you should not write code + # that depends on its structure. The data may contain: - webhook call latency - + # webhook errors # Corresponds to the JSON property `diagnosticInfo` # @return [Hash] attr_accessor :diagnostic_info @@ -6739,8 +6422,8 @@ module Google # @return [Array] attr_accessor :fulfillment_messages - # The text to be pronounced to the user or shown on the screen. - # Note: This is a legacy field, `fulfillment_messages` should be preferred. + # The text to be pronounced to the user or shown on the screen. Note: This is a + # legacy field, `fulfillment_messages` should be preferred. # Corresponds to the JSON property `fulfillmentText` # @return [String] attr_accessor :fulfillment_text @@ -6750,21 +6433,19 @@ module Google # complete conversation. When an end-user writes or says something, referred to # as an end-user expression or end-user input, Dialogflow matches the end-user # input to the best intent in your agent. Matching an intent is also known as - # intent classification. - # For more information, see the [intent - # guide](https://cloud.google.com/dialogflow/docs/intents-overview). + # intent classification. For more information, see the [intent guide](https:// + # cloud.google.com/dialogflow/docs/intents-overview). # Corresponds to the JSON property `intent` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent] attr_accessor :intent - # The intent detection confidence. Values range from 0.0 - # (completely uncertain) to 1.0 (completely certain). - # This value is for informational purpose only and is only used to - # help match the best intent within the classification threshold. + # The intent detection confidence. Values range from 0.0 (completely uncertain) + # to 1.0 (completely certain). This value is for informational purpose only and + # is only used to help match the best intent within the classification threshold. # This value may change for the same end-user expression at any time due to a - # model retraining or change in implementation. - # If there are `multiple knowledge_answers` messages, this value is set to - # the greatest `knowledgeAnswers.match_confidence` value in the list. + # model retraining or change in implementation. If there are `multiple + # knowledge_answers` messages, this value is set to the greatest ` + # knowledgeAnswers.match_confidence` value in the list. # Corresponds to the JSON property `intentDetectionConfidence` # @return [Float] attr_accessor :intent_detection_confidence @@ -6774,60 +6455,49 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeAnswers] attr_accessor :knowledge_answers - # The language that was triggered during intent detection. - # See [Language - # Support](https://cloud.google.com/dialogflow/docs/reference/language) - # for a list of the currently supported language codes. + # The language that was triggered during intent detection. See [Language Support] + # (https://cloud.google.com/dialogflow/docs/reference/language) for a list of + # the currently supported language codes. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # The collection of output contexts. If applicable, - # `output_contexts.parameters` contains entries with name - # `.original` containing the original parameter values - # before the query. + # The collection of output contexts. If applicable, `output_contexts.parameters` + # contains entries with name `.original` containing the original parameter + # values before the query. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts - # The collection of extracted parameters. - # Depending on your protocol or client library language, this is a - # map, associative array, symbol table, dictionary, or JSON object - # composed of a collection of (MapKey, MapValue) pairs: - # - MapKey type: string - # - MapKey value: parameter name - # - MapValue type: - # - If parameter's entity type is a composite entity: map - # - Else: string or number, depending on parameter value type - # - MapValue value: - # - If parameter's entity type is a composite entity: - # map from composite entity property names to property values - # - Else: parameter value + # The collection of extracted parameters. Depending on your protocol or client + # library language, this is a map, associative array, symbol table, dictionary, + # or JSON object composed of a collection of (MapKey, MapValue) pairs: - MapKey + # type: string - MapKey value: parameter name - MapValue type: - If parameter's + # entity type is a composite entity: map - Else: string or number, depending on + # parameter value type - MapValue value: - If parameter's entity type is a + # composite entity: map from composite entity property names to property values - + # Else: parameter value # Corresponds to the JSON property `parameters` # @return [Hash] attr_accessor :parameters - # The original conversational query text: - # - If natural language text was provided as input, `query_text` contains - # a copy of the input. - # - If natural language speech audio was provided as input, `query_text` - # contains the speech recognition result. If speech recognizer produced - # multiple alternatives, a particular one is picked. - # - If automatic spell correction is enabled, `query_text` will contain the - # corrected user input. + # The original conversational query text: - If natural language text was + # provided as input, `query_text` contains a copy of the input. - If natural + # language speech audio was provided as input, `query_text` contains the speech + # recognition result. If speech recognizer produced multiple alternatives, a + # particular one is picked. - If automatic spell correction is enabled, ` + # query_text` will contain the corrected user input. # Corresponds to the JSON property `queryText` # @return [String] attr_accessor :query_text - # The result of sentiment analysis. Sentiment analysis inspects user input - # and identifies the prevailing subjective opinion, especially to determine a - # user's attitude as positive, negative, or neutral. - # For Participants.AnalyzeContent, it needs to be configured in - # DetectIntentRequest.query_params. For - # Participants.StreamingAnalyzeContent, it needs to be configured in - # StreamingDetectIntentRequest.query_params. - # And for Participants.AnalyzeContent and + # The result of sentiment analysis. Sentiment analysis inspects user input and + # identifies the prevailing subjective opinion, especially to determine a user's + # attitude as positive, negative, or neutral. For Participants.AnalyzeContent, + # it needs to be configured in DetectIntentRequest.query_params. For # Participants.StreamingAnalyzeContent, it needs to be configured in + # StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent + # and Participants.StreamingAnalyzeContent, it needs to be configured in # ConversationProfile.human_agent_assistant_config # Corresponds to the JSON property `sentimentAnalysisResult` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SentimentAnalysisResult] @@ -6835,24 +6505,23 @@ module Google # The Speech recognition confidence between 0.0 and 1.0. A higher number # indicates an estimated greater likelihood that the recognized words are - # correct. The default of 0.0 is a sentinel value indicating that confidence - # was not set. - # This field is not guaranteed to be accurate or set. In particular this - # field isn't set for StreamingDetectIntent since the streaming endpoint has - # separate confidence estimates per portion of the audio in + # correct. The default of 0.0 is a sentinel value indicating that confidence was + # not set. This field is not guaranteed to be accurate or set. In particular + # this field isn't set for StreamingDetectIntent since the streaming endpoint + # has separate confidence estimates per portion of the audio in # StreamingRecognitionResult. # Corresponds to the JSON property `speechRecognitionConfidence` # @return [Float] attr_accessor :speech_recognition_confidence - # If the query was fulfilled by a webhook call, this field is set to the - # value of the `payload` field returned in the webhook response. + # If the query was fulfilled by a webhook call, this field is set to the value + # of the `payload` field returned in the webhook response. # Corresponds to the JSON property `webhookPayload` # @return [Hash] attr_accessor :webhook_payload - # If the query was fulfilled by a webhook call, this field is set to the - # value of the `source` field returned in the webhook response. + # If the query was fulfilled by a webhook call, this field is set to the value + # of the `source` field returned in the webhook response. # Corresponds to the JSON property `webhookSource` # @return [String] attr_accessor :webhook_source @@ -6911,8 +6580,8 @@ module Google # @return [String] attr_accessor :agent_content - # The URI to a Google Cloud Storage file containing the agent to restore. - # Note: The URI must start with "gs://". + # The URI to a Google Cloud Storage file containing the agent to restore. Note: + # The URI must start with "gs://". # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri @@ -6932,14 +6601,14 @@ module Google class GoogleCloudDialogflowV2beta1SearchAgentsResponse include Google::Apis::Core::Hashable - # The list of agents. There will be a maximum number of items returned based - # on the page_size field in the request. + # The list of agents. There will be a maximum number of items returned based on + # the page_size field in the request. # Corresponds to the JSON property `agents` # @return [Array] attr_accessor :agents - # 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 @@ -6955,8 +6624,8 @@ module Google end end - # The sentiment, such as positive/negative feeling or association, for a unit - # of analysis, such as the query text. + # The sentiment, such as positive/negative feeling or association, for a unit of + # analysis, such as the query text. class GoogleCloudDialogflowV2beta1Sentiment include Google::Apis::Core::Hashable @@ -6966,8 +6635,7 @@ module Google # @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 @@ -6987,9 +6655,8 @@ module Google class GoogleCloudDialogflowV2beta1SentimentAnalysisRequestConfig include Google::Apis::Core::Hashable - # Instructs the service to perform sentiment analysis on - # `query_text`. If not provided, sentiment analysis is not performed on - # `query_text`. + # Instructs the service to perform sentiment analysis on `query_text`. If not + # provided, sentiment analysis is not performed on `query_text`. # Corresponds to the JSON property `analyzeQueryTextSentiment` # @return [Boolean] attr_accessor :analyze_query_text_sentiment @@ -7005,21 +6672,19 @@ module Google end end - # The result of sentiment analysis. Sentiment analysis inspects user input - # and identifies the prevailing subjective opinion, especially to determine a - # user's attitude as positive, negative, or neutral. - # For Participants.AnalyzeContent, it needs to be configured in - # DetectIntentRequest.query_params. For - # Participants.StreamingAnalyzeContent, it needs to be configured in - # StreamingDetectIntentRequest.query_params. - # And for Participants.AnalyzeContent and + # The result of sentiment analysis. Sentiment analysis inspects user input and + # identifies the prevailing subjective opinion, especially to determine a user's + # attitude as positive, negative, or neutral. For Participants.AnalyzeContent, + # it needs to be configured in DetectIntentRequest.query_params. For # Participants.StreamingAnalyzeContent, it needs to be configured in + # StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent + # and Participants.StreamingAnalyzeContent, it needs to be configured in # ConversationProfile.human_agent_assistant_config class GoogleCloudDialogflowV2beta1SentimentAnalysisResult include Google::Apis::Core::Hashable - # The sentiment, such as positive/negative feeling or association, for a unit - # of analysis, such as the query text. + # The sentiment, such as positive/negative feeling or association, for a unit of + # analysis, such as the query text. # Corresponds to the JSON property `queryTextSentiment` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Sentiment] attr_accessor :query_text_sentiment @@ -7034,37 +6699,33 @@ module Google end end - # A session represents a conversation between a Dialogflow agent and an - # end-user. You can create special entities, called session entities, during a - # session. Session entities can extend or replace custom entity types and only - # exist during the session that they were created for. All session data, - # including session entities, is stored by Dialogflow for 20 minutes. - # For more information, see the [session entity - # guide](https://cloud.google.com/dialogflow/docs/entities-session). + # A session represents a conversation between a Dialogflow agent and an end-user. + # You can create special entities, called session entities, during a session. + # Session entities can extend or replace custom entity types and only exist + # during the session that they were created for. All session data, including + # session entities, is stored by Dialogflow for 20 minutes. For more information, + # see the [session entity guide](https://cloud.google.com/dialogflow/docs/ + # entities-session). class GoogleCloudDialogflowV2beta1SessionEntityType include Google::Apis::Core::Hashable - # Required. The collection of entities associated with this session entity - # type. + # Required. The collection of entities associated with this session entity type. # Corresponds to the JSON property `entities` # @return [Array] attr_accessor :entities - # Required. Indicates whether the additional data should override or - # supplement the custom entity type definition. + # Required. Indicates whether the additional data should override or supplement + # the custom entity type definition. # Corresponds to the JSON property `entityOverrideMode` # @return [String] attr_accessor :entity_override_mode - # Required. The unique identifier of this session entity type. Format: - # `projects//agent/sessions//entityTypes/`, or - # `projects//agent/environments//users//sessions//entityTypes/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # `` must be the display name of an existing entity - # type in the same agent that will be overridden or supplemented. + # Required. The unique identifier of this session entity type. Format: `projects/ + # /agent/sessions//entityTypes/`, or `projects//agent/environments//users// + # sessions//entityTypes/`. If `Environment ID` is not specified, we assume + # default 'draft' environment. If `User ID` is not specified, we assume default ' + # -' user. `` must be the display name of an existing entity type in the same + # agent that will be overridden or supplemented. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -7086,27 +6747,22 @@ module Google class GoogleCloudDialogflowV2beta1SpeechContext include Google::Apis::Core::Hashable - # Optional. Boost for this context compared to other contexts: - # * If the boost is positive, Dialogflow will increase the probability that - # the phrases in this context are recognized over similar sounding phrases. - # * If the boost is unspecified or non-positive, Dialogflow will not apply - # any boost. - # Dialogflow recommends that you use boosts in the range (0, 20] and that you - # find a value that fits your use case with binary search. + # Optional. Boost for this context compared to other contexts: * If the boost is + # positive, Dialogflow will increase the probability that the phrases in this + # context are recognized over similar sounding phrases. * If the boost is + # unspecified or non-positive, Dialogflow will not apply any boost. Dialogflow + # recommends that you use boosts in the range (0, 20] and that you find a value + # that fits your use case with binary search. # Corresponds to the JSON property `boost` # @return [Float] attr_accessor :boost # Optional. A list of strings containing words and phrases that the speech - # recognizer should recognize with higher likelihood. - # This list can be used to: - # * improve accuracy for words and phrases you expect the user to say, - # e.g. typical commands for your Dialogflow agent - # * add additional words to the speech recognizer vocabulary - # * ... - # See the [Cloud Speech - # documentation](https://cloud.google.com/speech-to-text/quotas) for usage - # limits. + # recognizer should recognize with higher likelihood. This list can be used to: * + # improve accuracy for words and phrases you expect the user to say, e.g. + # typical commands for your Dialogflow agent * add additional words to the + # speech recognizer vocabulary * ... See the [Cloud Speech documentation](https:/ + # /cloud.google.com/speech-to-text/quotas) for usage limits. # Corresponds to the JSON property `phrases` # @return [Array] attr_accessor :phrases @@ -7126,15 +6782,14 @@ module Google class GoogleCloudDialogflowV2beta1SubAgent include Google::Apis::Core::Hashable - # Optional. The unique identifier (`environment name` in dialogflow console) - # of this sub-agent environment. Assumes draft environment if `environment` - # is not set. + # Optional. The unique identifier (`environment name` in dialogflow console) of + # this sub-agent environment. Assumes draft environment if `environment` is not + # set. # Corresponds to the JSON property `environment` # @return [String] attr_accessor :environment - # Required. The project of this agent. - # Format: `projects/`. + # Required. The project of this agent. Format: `projects/`. # Corresponds to the JSON property `project` # @return [String] attr_accessor :project @@ -7169,9 +6824,9 @@ module Google attr_accessor :pitch # Optional. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is the normal - # native speed supported by the specific voice. 2.0 is twice as fast, and - # 0.5 is half as fast. If unset(0.0), defaults to the native 1.0 speed. Any - # other values < 0.25 or > 4.0 will return an error. + # native speed supported by the specific voice. 2.0 is twice as fast, and 0.5 is + # half as fast. If unset(0.0), defaults to the native 1.0 speed. Any other + # values < 0.25 or > 4.0 will return an error. # Corresponds to the JSON property `speakingRate` # @return [Float] attr_accessor :speaking_rate @@ -7182,13 +6837,13 @@ module Google attr_accessor :voice # Optional. Volume gain (in dB) of the normal native volume supported by the - # specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of - # 0.0 (dB), will play at normal native signal amplitude. A value of -6.0 (dB) - # will play at approximately half the amplitude of the normal native signal - # amplitude. A value of +6.0 (dB) will play at approximately twice the - # amplitude of the normal native signal amplitude. We strongly recommend not - # to exceed +10 (dB) as there's usually no effective increase in loudness for - # any value greater than that. + # specific voice, in the range [-96.0, 16.0]. If unset, or set to a value of 0.0 + # (dB), will play at normal native signal amplitude. A value of -6.0 (dB) will + # play at approximately half the amplitude of the normal native signal amplitude. + # A value of +6.0 (dB) will play at approximately twice the amplitude of the + # normal native signal amplitude. We strongly recommend not to exceed +10 (dB) + # as there's usually no effective increase in loudness for any value greater + # than that. # Corresponds to the JSON property `volumeGainDb` # @return [Float] attr_accessor :volume_gain_db @@ -7211,16 +6866,16 @@ module Google class GoogleCloudDialogflowV2beta1TextInput include Google::Apis::Core::Hashable - # Required. The language of this conversational query. See [Language - # Support](https://cloud.google.com/dialogflow/docs/reference/language) - # for a list of the currently supported language codes. Note that queries in - # the same session do not necessarily need to specify the same language. + # Required. The language of this conversational query. See [Language Support]( + # https://cloud.google.com/dialogflow/docs/reference/language) for a list of the + # currently supported language codes. Note that queries in the same session do + # not necessarily need to specify the same language. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # Required. The UTF-8 encoded natural language text to be processed. - # Text length must not exceed 256 characters. + # Required. The UTF-8 encoded natural language text to be processed. Text length + # must not exceed 256 characters. # Corresponds to the JSON property `text` # @return [String] attr_accessor :text @@ -7253,19 +6908,13 @@ module Google class GoogleCloudDialogflowV2beta1ValidationError include Google::Apis::Core::Hashable - # The names of the entries that the error is associated with. - # Format: - # - "projects//agent", if the error is associated with the entire - # agent. - # - "projects//agent/intents/", if the error is - # associated with certain intents. - # - "projects//agent/intents//trainingPhrases/", if the - # error is associated with certain intent training phrases. - # - "projects//agent/intents//parameters/", if the error is associated with certain intent parameters. - # - "projects//agent/entities/", if the error is - # associated with certain entities. + # The names of the entries that the error is associated with. Format: - " + # projects//agent", if the error is associated with the entire agent. - " + # projects//agent/intents/", if the error is associated with certain intents. - " + # projects//agent/intents//trainingPhrases/", if the error is associated with + # certain intent training phrases. - "projects//agent/intents//parameters/", if + # the error is associated with certain intent parameters. - "projects//agent/ + # entities/", if the error is associated with certain entities. # Corresponds to the JSON property `entries` # @return [Array] attr_accessor :entries @@ -7315,18 +6964,17 @@ module Google class GoogleCloudDialogflowV2beta1VoiceSelectionParams include Google::Apis::Core::Hashable - # Optional. The name of the voice. If not set, the service will choose a - # voice based on the other parameters such as language_code and - # ssml_gender. + # Optional. The name of the voice. If not set, the service will choose a voice + # based on the other parameters such as language_code and ssml_gender. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Optional. The preferred gender of the voice. If not set, the service will - # choose a voice based on the other parameters such as language_code and - # name. Note that this is only a preference, not requirement. If a - # voice of the appropriate gender is not available, the synthesizer should - # substitute a voice with a different gender rather than failing the request. + # choose a voice based on the other parameters such as language_code and name. + # Note that this is only a preference, not requirement. If a voice of the + # appropriate gender is not available, the synthesizer should substitute a voice + # with a different gender rather than failing the request. # Corresponds to the JSON property `ssmlGender` # @return [String] attr_accessor :ssml_gender @@ -7351,8 +6999,8 @@ module Google # @return [Array] attr_accessor :alternative_query_results - # Represents the contents of the original request that was passed to - # the `[Streaming]DetectIntent` call. + # Represents the contents of the original request that was passed to the `[ + # Streaming]DetectIntent` call. # Corresponds to the JSON property `originalDetectIntentRequest` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest] attr_accessor :original_detect_intent_request @@ -7362,17 +7010,15 @@ module Google # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1QueryResult] attr_accessor :query_result - # The unique identifier of the response. Contains the same value as - # `[Streaming]DetectIntentResponse.response_id`. + # The unique identifier of the response. Contains the same value as `[Streaming] + # DetectIntentResponse.response_id`. # Corresponds to the JSON property `responseId` # @return [String] attr_accessor :response_id - # The unique identifier of detectIntent request session. - # Can be used to identify end-user inside webhook implementation. - # Format: `projects//agent/sessions/`, or - # `projects//agent/environments//users//sessions/`. + # The unique identifier of detectIntent request session. Can be used to identify + # end-user inside webhook implementation. Format: `projects//agent/sessions/`, + # or `projects//agent/environments//users//sessions/`. # Corresponds to the JSON property `session` # @return [String] attr_accessor :session @@ -7391,87 +7037,78 @@ module Google end end - # The response message for a webhook call. - # This response is validated by the Dialogflow server. If validation fails, - # an error will be returned in the QueryResult.diagnostic_info field. - # Setting JSON fields to an empty value with the wrong type is a common error. - # To avoid this error: - # - Use `""` for empty strings - # - Use ```` or `null` for empty objects - # - Use `[]` or `null` for empty arrays - # For more information, see the - # [Protocol Buffers Language - # Guide](https://developers.google.com/protocol-buffers/docs/proto3#json). + # The response message for a webhook call. This response is validated by the + # Dialogflow server. If validation fails, an error will be returned in the + # QueryResult.diagnostic_info field. Setting JSON fields to an empty value with + # the wrong type is a common error. To avoid this error: - Use `""` for empty + # strings - Use ```` or `null` for empty objects - Use `[]` or `null` for empty + # arrays For more information, see the [Protocol Buffers Language Guide](https:// + # developers.google.com/protocol-buffers/docs/proto3#json). class GoogleCloudDialogflowV2beta1WebhookResponse include Google::Apis::Core::Hashable - # Optional. Indicates that this intent ends an interaction. Some integrations - # (e.g., Actions on Google or Dialogflow phone gateway) use this information - # to close interaction with an end user. Default is false. + # Optional. Indicates that this intent ends an interaction. Some integrations (e. + # g., Actions on Google or Dialogflow phone gateway) use this information to + # close interaction with an end user. Default is false. # Corresponds to the JSON property `endInteraction` # @return [Boolean] attr_accessor :end_interaction alias_method :end_interaction?, :end_interaction # Events allow for matching intents by event name instead of the natural - # language input. For instance, input `` can trigger a personalized welcome response. - # The parameter `name` may be used by the agent in the response: - # `"Hello #welcome_event.name! What can I do for you today?"`. + # language input. For instance, input `` can trigger a personalized welcome + # response. The parameter `name` may be used by the agent in the response: `" + # Hello #welcome_event.name! What can I do for you today?"`. # Corresponds to the JSON property `followupEventInput` # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EventInput] attr_accessor :followup_event_input - # Optional. The rich response messages intended for the end-user. - # When provided, Dialogflow uses this field to populate - # QueryResult.fulfillment_messages sent to the integration or API caller. + # Optional. The rich response messages intended for the end-user. When provided, + # Dialogflow uses this field to populate QueryResult.fulfillment_messages sent + # to the integration or API caller. # Corresponds to the JSON property `fulfillmentMessages` # @return [Array] attr_accessor :fulfillment_messages - # Optional. The text response message intended for the end-user. - # It is recommended to use `fulfillment_messages.text.text[0]` instead. - # When provided, Dialogflow uses this field to populate - # QueryResult.fulfillment_text sent to the integration or API caller. + # Optional. The text response message intended for the end-user. It is + # recommended to use `fulfillment_messages.text.text[0]` instead. When provided, + # Dialogflow uses this field to populate QueryResult.fulfillment_text sent to + # the integration or API caller. # Corresponds to the JSON property `fulfillmentText` # @return [String] attr_accessor :fulfillment_text # Optional. The collection of output contexts that will overwrite currently - # active contexts for the session and reset their lifespans. - # When provided, Dialogflow uses this field to populate - # QueryResult.output_contexts sent to the integration or API caller. + # active contexts for the session and reset their lifespans. When provided, + # Dialogflow uses this field to populate QueryResult.output_contexts sent to the + # integration or API caller. # Corresponds to the JSON property `outputContexts` # @return [Array] attr_accessor :output_contexts # Optional. This field can be used to pass custom data from your webhook to the - # integration or API caller. Arbitrary JSON objects are supported. - # When provided, Dialogflow uses this field to populate - # QueryResult.webhook_payload sent to the integration or API caller. - # This field is also used by the - # [Google Assistant - # integration](https://cloud.google.com/dialogflow/docs/integrations/aog) - # for rich response messages. - # See the format definition at [Google Assistant Dialogflow webhook - # format](https://developers.google.com/assistant/actions/build/json/dialogflow- - # webhook-json) + # integration or API caller. Arbitrary JSON objects are supported. When provided, + # Dialogflow uses this field to populate QueryResult.webhook_payload sent to + # the integration or API caller. This field is also used by the [Google + # Assistant integration](https://cloud.google.com/dialogflow/docs/integrations/ + # aog) for rich response messages. See the format definition at [Google + # Assistant Dialogflow webhook format](https://developers.google.com/assistant/ + # actions/build/json/dialogflow-webhook-json) # Corresponds to the JSON property `payload` # @return [Hash] attr_accessor :payload # Optional. Additional session entity types to replace or extend developer - # entity types with. The entity synonyms apply to all languages and persist - # for the session. Setting this data from a webhook overwrites - # the session entity types that have been set using `detectIntent`, - # `streamingDetectIntent` or SessionEntityType management methods. + # entity types with. The entity synonyms apply to all languages and persist for + # the session. Setting this data from a webhook overwrites the session entity + # types that have been set using `detectIntent`, `streamingDetectIntent` or + # SessionEntityType management methods. # Corresponds to the JSON property `sessionEntityTypes` # @return [Array] attr_accessor :session_entity_types - # Optional. A custom field used to identify the webhook source. - # Arbitrary strings are supported. - # When provided, Dialogflow uses this field to populate + # Optional. A custom field used to identify the webhook source. Arbitrary + # strings are supported. When provided, Dialogflow uses this field to populate # QueryResult.webhook_source sent to the integration or API caller. # Corresponds to the JSON property `source` # @return [String] @@ -7504,8 +7141,8 @@ module Google # @return [String] attr_accessor :agent_content - # The URI to a file containing the exported agent. This field is populated - # only if `agent_uri` is specified in ExportAgentRequest. + # The URI to a file containing the exported agent. This field is populated only + # if `agent_uri` is specified in ExportAgentRequest. # Corresponds to the JSON property `agentUri` # @return [String] attr_accessor :agent_uri @@ -7551,47 +7188,45 @@ module Google class GoogleLongrunningOperation 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::DialogflowV2beta1::GoogleRpcStatus] 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 @@ -7610,13 +7245,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 @@ -7629,12 +7262,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 GoogleRpcStatus include Google::Apis::Core::Hashable @@ -7643,15 +7276,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 @@ -7670,9 +7303,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. class GoogleTypeLatLng include Google::Apis::Core::Hashable diff --git a/generated/google/apis/dialogflow_v2beta1/service.rb b/generated/google/apis/dialogflow_v2beta1/service.rb index 5a9ed39fa..6193d4475 100644 --- a/generated/google/apis/dialogflow_v2beta1/service.rb +++ b/generated/google/apis/dialogflow_v2beta1/service.rb @@ -50,8 +50,8 @@ module Google # Deletes the specified agent. # @param [String] parent - # Required. The project that the agent to delete is associated with. - # Format: `projects/`. + # Required. The project that the agent to delete is associated with. Format: ` + # projects/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -81,8 +81,8 @@ module Google # Retrieves the specified agent. # @param [String] parent - # Required. The project that the agent to fetch is associated with. - # Format: `projects/`. + # Required. The project that the agent to fetch is associated with. Format: ` + # projects/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -112,8 +112,7 @@ module Google # Creates/updates the specified agent. # @param [String] parent - # Required. The project of this agent. - # Format: `projects/`. + # Required. The project of this agent. Format: `projects/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Agent] google_cloud_dialogflow_v2beta1_agent_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -147,11 +146,10 @@ module Google execute_or_queue_command(command, &block) end - # Exports the specified agent to a ZIP file. - # Operation + # Exports the specified agent to a ZIP file. Operation # @param [String] parent - # Required. The project that the agent to export is associated with. - # Format: `projects/`. + # Required. The project that the agent to export is associated with. Format: ` + # projects/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ExportAgentRequest] google_cloud_dialogflow_v2beta1_export_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -184,8 +182,7 @@ module Google # Retrieves the fulfillment. # @param [String] name - # Required. The name of the fulfillment. - # Format: `projects//agent/fulfillment`. + # Required. The name of the fulfillment. Format: `projects//agent/fulfillment`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -213,17 +210,15 @@ module Google execute_or_queue_command(command, &block) end - # Gets agent validation result. Agent validation is performed during - # training time and is updated automatically when training is completed. + # Gets agent validation result. Agent validation is performed during training + # time and is updated automatically when training is completed. # @param [String] parent - # Required. The project that the agent is associated with. - # Format: `projects/`. + # Required. The project that the agent is associated with. Format: `projects/`. # @param [String] language_code # Optional. The language for which you want a validation result. If not - # specified, the agent's default language is used. [Many - # languages](https://cloud.google.com/dialogflow/docs/reference/language) - # are supported. Note: languages must be enabled in the agent before they can - # be used. + # specified, the agent's default language is used. [Many languages](https:// + # cloud.google.com/dialogflow/docs/reference/language) are supported. Note: + # languages must be enabled in the agent before they can be used. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -252,20 +247,18 @@ module Google execute_or_queue_command(command, &block) end - # Imports the specified agent from a ZIP file. - # Uploads new intents and entity types without deleting the existing ones. - # Intents and entity types with the same name are replaced with the new - # versions from ImportAgentRequest. After the import, the imported draft - # agent will be trained automatically (unless disabled in agent settings). - # However, once the import is done, training may not be completed yet. Please - # call TrainAgent and wait for the operation it returns in order to train - # explicitly. - # Operation - # An operation which tracks when importing is complete. It only tracks - # when the draft agent is updated not when it is done training. + # Imports the specified agent from a ZIP file. Uploads new intents and entity + # types without deleting the existing ones. Intents and entity types with the + # same name are replaced with the new versions from ImportAgentRequest. After + # the import, the imported draft agent will be trained automatically (unless + # disabled in agent settings). However, once the import is done, training may + # not be completed yet. Please call TrainAgent and wait for the operation it + # returns in order to train explicitly. Operation An operation which tracks when + # importing is complete. It only tracks when the draft agent is updated not when + # it is done training. # @param [String] parent - # Required. The project that the agent to import is associated with. - # Format: `projects/`. + # Required. The project that the agent to import is associated with. Format: ` + # projects/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ImportAgentRequest] google_cloud_dialogflow_v2beta1_import_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -296,19 +289,17 @@ module Google execute_or_queue_command(command, &block) end - # Restores the specified agent from a ZIP file. - # Replaces the current agent version with a new one. All the intents and - # entity types in the older version are deleted. After the restore, the - # restored draft agent will be trained automatically (unless disabled in - # agent settings). However, once the restore is done, training may not be - # completed yet. Please call TrainAgent and wait for the operation it - # returns in order to train explicitly. - # Operation - # An operation which tracks when restoring is complete. It only tracks - # when the draft agent is updated not when it is done training. + # Restores the specified agent from a ZIP file. Replaces the current agent + # version with a new one. All the intents and entity types in the older version + # are deleted. After the restore, the restored draft agent will be trained + # automatically (unless disabled in agent settings). However, once the restore + # is done, training may not be completed yet. Please call TrainAgent and wait + # for the operation it returns in order to train explicitly. Operation An + # operation which tracks when restoring is complete. It only tracks when the + # draft agent is updated not when it is done training. # @param [String] parent - # Required. The project that the agent to restore is associated with. - # Format: `projects/`. + # Required. The project that the agent to restore is associated with. Format: ` + # projects/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1RestoreAgentRequest] google_cloud_dialogflow_v2beta1_restore_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -339,19 +330,16 @@ module Google execute_or_queue_command(command, &block) end - # Returns the list of agents. - # Since there is at most one conversational agent per project, this method is - # useful primarily for listing all agents across projects the caller has - # access to. One can achieve that with a wildcard project collection id "-". - # Refer to [List - # Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub- - # collections). + # Returns the list of agents. Since there is at most one conversational agent + # per project, this method is useful primarily for listing all agents across + # projects the caller has access to. One can achieve that with a wildcard + # project collection id "-". Refer to [List Sub-Collections](https://cloud. + # google.com/apis/design/design_patterns#list_sub-collections). # @param [String] parent - # Required. The project to list agents from. - # Format: `projects/`. + # Required. The project to list agents from. Format: `projects/`. # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -383,11 +371,10 @@ module Google execute_or_queue_command(command, &block) end - # Trains the specified agent. - # Operation + # Trains the specified agent. Operation # @param [String] parent - # Required. The project that the agent to train is associated with. - # Format: `projects/`. + # Required. The project that the agent to train is associated with. Format: ` + # projects/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1TrainAgentRequest] google_cloud_dialogflow_v2beta1_train_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -420,8 +407,8 @@ module Google # Updates the fulfillment. # @param [String] name - # Required. The unique identifier of the fulfillment. - # Format: `projects//agent/fulfillment`. + # Required. The unique identifier of the fulfillment. Format: `projects//agent/ + # fulfillment`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment] google_cloud_dialogflow_v2beta1_fulfillment_object # @param [String] update_mask # Required. The mask to control which fields get updated. If the mask is not @@ -456,11 +443,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes entity types in the specified agent. - # Operation + # Deletes entity types in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to delete all entities types for. Format: - # `projects//agent`. + # Required. The name of the agent to delete all entities types for. Format: ` + # projects//agent`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest] google_cloud_dialogflow_v2beta1_batch_delete_entity_types_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -491,11 +477,10 @@ module Google execute_or_queue_command(command, &block) end - # Updates/Creates multiple entity types in the specified agent. - # Operation + # Updates/Creates multiple entity types in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to update or create entity types in. - # Format: `projects//agent`. + # Required. The name of the agent to update or create entity types in. Format: ` + # projects//agent`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest] google_cloud_dialogflow_v2beta1_batch_update_entity_types_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -528,16 +513,13 @@ module Google # Creates an entity type in the specified agent. # @param [String] parent - # Required. The agent to create a entity type for. - # Format: `projects//agent`. + # Required. The agent to create a entity type for. Format: `projects//agent`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType] google_cloud_dialogflow_v2beta1_entity_type_object # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -570,8 +552,8 @@ module Google # Deletes the specified entity type. # @param [String] name - # Required. The name of the entity type to delete. - # Format: `projects//agent/entityTypes/`. + # Required. The name of the entity type to delete. Format: `projects//agent/ + # entityTypes/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -601,15 +583,12 @@ module Google # Retrieves the specified entity type. # @param [String] name - # Required. The name of the entity type. - # Format: `projects//agent/entityTypes/`. + # Required. The name of the entity type. Format: `projects//agent/entityTypes/`. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -640,18 +619,15 @@ module Google # Returns the list of all entity types in the specified agent. # @param [String] parent - # Required. The agent to list all entity types from. - # Format: `projects//agent`. + # Required. The agent to list all entity types from. Format: `projects//agent`. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -686,18 +662,15 @@ module Google # Updates the specified entity type. # @param [String] name - # The unique identifier of the entity type. - # Required for EntityTypes.UpdateEntityType and - # EntityTypes.BatchUpdateEntityTypes methods. - # Format: `projects//agent/entityTypes/`. + # The unique identifier of the entity type. Required for EntityTypes. + # UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: ` + # projects//agent/entityTypes/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType] google_cloud_dialogflow_v2beta1_entity_type_object # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] update_mask # Optional. The mask to control which fields get updated. # @param [String] fields @@ -731,11 +704,10 @@ module Google execute_or_queue_command(command, &block) end - # Creates multiple new entities in the specified entity type. - # Operation + # Creates multiple new entities in the specified entity type. Operation # @param [String] parent - # Required. The name of the entity type to create entities in. Format: - # `projects//agent/entityTypes/`. + # Required. The name of the entity type to create entities in. Format: `projects/ + # /agent/entityTypes/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest] google_cloud_dialogflow_v2beta1_batch_create_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -766,11 +738,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes entities in the specified entity type. - # Operation + # Deletes entities in the specified entity type. Operation # @param [String] parent - # Required. The name of the entity type to delete entries for. Format: - # `projects//agent/entityTypes/`. + # Required. The name of the entity type to delete entries for. Format: `projects/ + # /agent/entityTypes/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest] google_cloud_dialogflow_v2beta1_batch_delete_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -801,13 +772,12 @@ module Google execute_or_queue_command(command, &block) end - # Updates or creates multiple entities in the specified entity type. This - # method does not affect entities in the entity type that aren't explicitly - # specified in the request. - # Operation + # Updates or creates multiple entities in the specified entity type. This method + # does not affect entities in the entity type that aren't explicitly specified + # in the request. Operation # @param [String] parent - # Required. The name of the entity type to update or create entities in. - # Format: `projects//agent/entityTypes/`. + # Required. The name of the entity type to update or create entities in. Format: + # `projects//agent/entityTypes/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest] google_cloud_dialogflow_v2beta1_batch_update_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -840,15 +810,11 @@ module Google # Returns the list of all non-draft environments of the specified agent. # @param [String] parent - # Required. The agent to list all environments from. - # Format: - # - `projects//agent` - # - `projects//locations//agent + # Required. The agent to list all environments from. Format: - `projects//agent` + # - `projects//locations//agent # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By default - # 100 and - # at most 1000. + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -882,11 +848,10 @@ module Google # Deletes all active contexts in the specified session. # @param [String] parent - # Required. The name of the session to delete all contexts from. Format: - # `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The name of the session to delete all contexts from. Format: ` + # projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. + # If `Environment ID` is not specified we assume default 'draft' environment. + # If `User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -914,22 +879,20 @@ module Google execute_or_queue_command(command, &block) end - # Processes a natural language query and returns structured, actionable data - # as a result. This method is not idempotent, because it may cause contexts - # and session entity types to be updated, which in turn might affect - # results of future queries. + # Processes a natural language query and returns structured, actionable data as + # a result. This method is not idempotent, because it may cause contexts and + # session entity types to be updated, which in turn might affect results of + # future queries. # @param [String] session - # Required. The name of the session this query is sent to. Format: - # `projects//agent/sessions/`, or - # `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we are using - # "-". It's up to the API caller to choose an appropriate `Session ID` and - # `User Id`. They can be a random number or some type of user and session - # identifiers (preferably hashed). The length of the `Session ID` and - # `User ID` must not exceed 36 characters. - # For more information, see the [API interactions - # guide](https://cloud.google.com/dialogflow/docs/api-overview). + # Required. The name of the session this query is sent to. Format: `projects// + # agent/sessions/`, or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we are using "-". It's up to the API caller to + # choose an appropriate `Session ID` and `User Id`. They can be a random number + # or some type of user and session identifiers (preferably hashed). The length + # of the `Session ID` and `User ID` must not exceed 36 characters. For more + # information, see the [API interactions guide](https://cloud.google.com/ + # dialogflow/docs/api-overview). # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest] google_cloud_dialogflow_v2beta1_detect_intent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -960,15 +923,13 @@ module Google execute_or_queue_command(command, &block) end - # Creates a context. - # If the specified context already exists, overrides the context. + # Creates a context. If the specified context already exists, overrides the + # context. # @param [String] parent - # Required. The session to create a context for. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume - # default '-' user. + # Required. The session to create a context for. Format: `projects//agent/ + # sessions/` or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context] google_cloud_dialogflow_v2beta1_context_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1001,12 +962,10 @@ module Google # Deletes the specified context. # @param [String] name - # Required. The name of the context to delete. Format: - # `projects//agent/sessions//contexts/` - # or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is - # not specified, we assume default 'draft' environment. If `User ID` is not - # specified, we assume default '-' user. + # Required. The name of the context to delete. Format: `projects//agent/sessions/ + # /contexts/` or `projects//agent/environments//users//sessions//contexts/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1036,12 +995,10 @@ module Google # Retrieves the specified context. # @param [String] name - # Required. The name of the context. Format: - # `projects//agent/sessions//contexts/` - # or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is - # not specified, we assume default 'draft' environment. If `User ID` is not - # specified, we assume default '-' user. + # Required. The name of the context. Format: `projects//agent/sessions//contexts/ + # ` or `projects//agent/environments//users//sessions//contexts/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1071,15 +1028,13 @@ module Google # Returns the list of all contexts in the specified session. # @param [String] parent - # Required. The session to list all contexts from. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume - # default '-' user. + # Required. The session to list all contexts from. Format: `projects//agent/ + # sessions/` or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -1113,19 +1068,15 @@ module Google # Updates the specified context. # @param [String] name - # Required. The unique identifier of the context. Format: - # `projects//agent/sessions//contexts/`, - # or `projects//agent/environments//users//sessions//contexts/`. - # The `Context ID` is always converted to lowercase, may only contain - # characters in a-zA-Z0-9_-% and may be at most 250 bytes long. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # The following context names are reserved for internal use by Dialogflow. - # You should not use these contexts or create contexts with these names: - # * `__system_counters__` - # * `*_id_dialog_context` - # * `*_dialog_params_size` + # Required. The unique identifier of the context. Format: `projects//agent/ + # sessions//contexts/`, or `projects//agent/environments//users//sessions// + # contexts/`. The `Context ID` is always converted to lowercase, may only + # contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. The following context + # names are reserved for internal use by Dialogflow. You should not use these + # contexts or create contexts with these names: * `__system_counters__` * `* + # _id_dialog_context` * `*_dialog_params_size` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context] google_cloud_dialogflow_v2beta1_context_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -1159,19 +1110,15 @@ module Google execute_or_queue_command(command, &block) end - # Creates a session entity type. - # If the specified session entity type already exists, overrides the - # session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Creates a session entity type. If the specified session entity type already + # exists, overrides the session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] parent - # Required. The session to create a session entity type for. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users// - # sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume - # default '-' user. + # Required. The session to create a session entity type for. Format: `projects// + # agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType] google_cloud_dialogflow_v2beta1_session_entity_type_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1202,16 +1149,13 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Deletes the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the entity type to delete. Format: - # `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' + # Required. The name of the entity type to delete. Format: `projects//agent/ + # sessions//entityTypes/` or `projects//agent/environments//users//sessions// + # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' # environment. If `User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1240,16 +1184,13 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Retrieves the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the session entity type. Format: - # `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' + # Required. The name of the session entity type. Format: `projects//agent/ + # sessions//entityTypes/` or `projects//agent/environments//users//sessions// + # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' # environment. If `User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1278,20 +1219,17 @@ module Google execute_or_queue_command(command, &block) end - # Returns the list of all session entity types in the specified session. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Returns the list of all session entity types in the specified session. This + # method doesn't work with Google Assistant integration. Contact Dialogflow + # support if you need to use session entities with Google Assistant integration. # @param [String] parent - # Required. The session to list all session entity types from. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users// - # sessions/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The session to list all session entity types from. Format: `projects/ + # /agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -1323,20 +1261,16 @@ module Google execute_or_queue_command(command, &block) end - # Updates the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Updates the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The unique identifier of this session entity type. Format: - # `projects//agent/sessions//entityTypes/`, or - # `projects//agent/environments//users//sessions//entityTypes/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # `` must be the display name of an existing entity - # type in the same agent that will be overridden or supplemented. + # Required. The unique identifier of this session entity type. Format: `projects/ + # /agent/sessions//entityTypes/`, or `projects//agent/environments//users// + # sessions//entityTypes/`. If `Environment ID` is not specified, we assume + # default 'draft' environment. If `User ID` is not specified, we assume default ' + # -' user. `` must be the display name of an existing entity type in the same + # agent that will be overridden or supplemented. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType] google_cloud_dialogflow_v2beta1_session_entity_type_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -1370,11 +1304,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes intents in the specified agent. - # Operation + # Deletes intents in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to delete all entities types for. Format: - # `projects//agent`. + # Required. The name of the agent to delete all entities types for. Format: ` + # projects//agent`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest] google_cloud_dialogflow_v2beta1_batch_delete_intents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1405,11 +1338,10 @@ module Google execute_or_queue_command(command, &block) end - # Updates/Creates multiple intents in the specified agent. - # Operation + # Updates/Creates multiple intents in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to update or create intents in. - # Format: `projects//agent`. + # Required. The name of the agent to update or create intents in. Format: ` + # projects//agent`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest] google_cloud_dialogflow_v2beta1_batch_update_intents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1442,18 +1374,15 @@ module Google # Creates an intent in the specified agent. # @param [String] parent - # Required. The agent to create a intent for. - # Format: `projects//agent`. + # Required. The agent to create a intent for. Format: `projects//agent`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent] google_cloud_dialogflow_v2beta1_intent_object # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1488,8 +1417,8 @@ module Google # Deletes the specified intent and its direct or indirect followup intents. # @param [String] name # Required. The name of the intent to delete. If this intent has direct or - # indirect followup intents, we also delete them. - # Format: `projects//agent/intents/`. + # indirect followup intents, we also delete them. Format: `projects//agent/ + # intents/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1519,17 +1448,14 @@ module Google # Retrieves the specified intent. # @param [String] name - # Required. The name of the intent. - # Format: `projects//agent/intents/`. + # Required. The name of the intent. Format: `projects//agent/intents/`. # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1561,20 +1487,17 @@ module Google # Returns the list of all intents in the specified agent. # @param [String] parent - # Required. The agent to list all intents from. - # Format: `projects//agent`. + # Required. The agent to list all intents from. Format: `projects//agent`. # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -1610,20 +1533,17 @@ module Google # Updates the specified intent. # @param [String] name - # Optional. The unique identifier of this intent. - # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents - # methods. - # Format: `projects//agent/intents/`. + # Optional. The unique identifier of this intent. Required for Intents. + # UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/ + # intents/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent] google_cloud_dialogflow_v2beta1_intent_object # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] update_mask # Optional. The mask to control which fields get updated. # @param [String] fields @@ -1658,12 +1578,10 @@ module Google execute_or_queue_command(command, &block) end - # Creates a knowledge base. - # Note: The `projects.agent.knowledgeBases` resource is deprecated; - # only use `projects.knowledgeBases`. + # Creates a knowledge base. Note: The `projects.agent.knowledgeBases` resource + # is deprecated; only use `projects.knowledgeBases`. # @param [String] parent - # Required. The project to create a knowledge base for. - # Format: `projects/`. + # Required. The project to create a knowledge base for. Format: `projects/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase] google_cloud_dialogflow_v2beta1_knowledge_base_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1694,15 +1612,14 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified knowledge base. - # Note: The `projects.agent.knowledgeBases` resource is deprecated; - # only use `projects.knowledgeBases`. + # Deletes the specified knowledge base. Note: The `projects.agent.knowledgeBases` + # resource is deprecated; only use `projects.knowledgeBases`. # @param [String] name - # Required. The name of the knowledge base to delete. - # Format: `projects//knowledgeBases/`. + # Required. The name of the knowledge base to delete. Format: `projects// + # knowledgeBases/`. # @param [Boolean] force - # Optional. Force deletes the knowledge base. When set to true, any documents - # in the knowledge base are also deleted. + # Optional. Force deletes the knowledge base. When set to true, any documents in + # the knowledge base are also deleted. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1731,12 +1648,11 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the specified knowledge base. - # Note: The `projects.agent.knowledgeBases` resource is deprecated; - # only use `projects.knowledgeBases`. + # Retrieves the specified knowledge base. Note: The `projects.agent. + # knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`. # @param [String] name - # Required. The name of the knowledge base to retrieve. - # Format `projects//knowledgeBases/`. + # Required. The name of the knowledge base to retrieve. Format `projects// + # knowledgeBases/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1764,15 +1680,14 @@ module Google execute_or_queue_command(command, &block) end - # Returns the list of all knowledge bases of the specified agent. - # Note: The `projects.agent.knowledgeBases` resource is deprecated; - # only use `projects.knowledgeBases`. + # Returns the list of all knowledge bases of the specified agent. Note: The ` + # projects.agent.knowledgeBases` resource is deprecated; only use `projects. + # knowledgeBases`. # @param [String] parent - # Required. The project to list of knowledge bases for. - # Format: `projects/`. + # Required. The project to list of knowledge bases for. Format: `projects/`. # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 10 and at most 100. + # Optional. The maximum number of items to return in a single page. By default + # 10 and at most 100. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -1804,18 +1719,16 @@ module Google execute_or_queue_command(command, &block) end - # Updates the specified knowledge base. - # Note: The `projects.agent.knowledgeBases` resource is deprecated; - # only use `projects.knowledgeBases`. + # Updates the specified knowledge base. Note: The `projects.agent.knowledgeBases` + # resource is deprecated; only use `projects.knowledgeBases`. # @param [String] name - # The knowledge base resource name. - # The name must be empty when creating a knowledge base. - # Format: `projects//knowledgeBases/`. + # The knowledge base resource name. The name must be empty when creating a + # knowledge base. Format: `projects//knowledgeBases/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase] google_cloud_dialogflow_v2beta1_knowledge_base_object # @param [String] update_mask - # Optional. Not specified means `update all`. - # Currently, only `display_name` can be updated, an InvalidArgument will be - # returned for attempting to update other fields. + # Optional. Not specified means `update all`. Currently, only `display_name` can + # be updated, an InvalidArgument will be returned for attempting to update other + # fields. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1846,12 +1759,11 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new document. - # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - # only use `projects.knowledgeBases.documents`. + # Creates a new document. Note: The `projects.agent.knowledgeBases.documents` + # resource is deprecated; only use `projects.knowledgeBases.documents`. # @param [String] parent - # Required. The knoweldge base to create a document for. - # Format: `projects//knowledgeBases/`. + # Required. The knoweldge base to create a document for. Format: `projects// + # knowledgeBases/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document] google_cloud_dialogflow_v2beta1_document_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1882,13 +1794,12 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified document. - # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - # only use `projects.knowledgeBases.documents`. + # Deletes the specified document. Note: The `projects.agent.knowledgeBases. + # documents` resource is deprecated; only use `projects.knowledgeBases.documents` + # . # @param [String] name - # Required. The name of the document to delete. - # Format: `projects//knowledgeBases//documents/`. + # Required. The name of the document to delete. Format: `projects// + # knowledgeBases//documents/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1916,13 +1827,12 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the specified document. - # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - # only use `projects.knowledgeBases.documents`. + # Retrieves the specified document. Note: The `projects.agent.knowledgeBases. + # documents` resource is deprecated; only use `projects.knowledgeBases.documents` + # . # @param [String] name - # Required. The name of the document to retrieve. - # Format `projects//knowledgeBases//documents/`. + # Required. The name of the document to retrieve. Format `projects// + # knowledgeBases//documents/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1950,15 +1860,15 @@ module Google execute_or_queue_command(command, &block) end - # Returns the list of all documents of the knowledge base. - # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - # only use `projects.knowledgeBases.documents`. + # Returns the list of all documents of the knowledge base. Note: The `projects. + # agent.knowledgeBases.documents` resource is deprecated; only use `projects. + # knowledgeBases.documents`. # @param [String] parent - # Required. The knowledge base to list all documents for. - # Format: `projects//knowledgeBases/`. + # Required. The knowledge base to list all documents for. Format: `projects// + # knowledgeBases/`. # @param [Fixnum] page_size - # The maximum number of items to return in a single page. By - # default 10 and at most 100. + # The maximum number of items to return in a single page. By default 10 and at + # most 100. # @param [String] page_token # The next_page_token value returned from a previous list request. # @param [String] fields @@ -1990,19 +1900,17 @@ module Google execute_or_queue_command(command, &block) end - # Updates the specified document. - # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - # only use `projects.knowledgeBases.documents`. + # Updates the specified document. Note: The `projects.agent.knowledgeBases. + # documents` resource is deprecated; only use `projects.knowledgeBases.documents` + # . # @param [String] name - # Optional. The document resource name. - # The name must be empty when creating a document. - # Format: `projects//knowledgeBases//documents/`. + # Optional. The document resource name. The name must be empty when creating a + # document. Format: `projects//knowledgeBases//documents/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document] google_cloud_dialogflow_v2beta1_document_object # @param [String] update_mask - # Optional. Not specified means `update all`. - # Currently, only `display_name` can be updated, an InvalidArgument will be - # returned for attempting to update other fields. + # Optional. Not specified means `update all`. Currently, only `display_name` can + # be updated, an InvalidArgument will be returned for attempting to update other + # fields. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2034,15 +1942,14 @@ module Google end # Reloads the specified document from its specified source, content_uri or - # content. The previously loaded content of the document will be deleted. - # Note: Even when the content of the document has not changed, there still - # may be side effects because of internal implementation changes. - # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - # only use `projects.knowledgeBases.documents`. + # content. The previously loaded content of the document will be deleted. Note: + # Even when the content of the document has not changed, there still may be side + # effects because of internal implementation changes. Note: The `projects.agent. + # knowledgeBases.documents` resource is deprecated; only use `projects. + # knowledgeBases.documents`. # @param [String] name - # Required. The name of the document to reload. - # Format: `projects//knowledgeBases//documents/` + # Required. The name of the document to reload. Format: `projects// + # knowledgeBases//documents/` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ReloadDocumentRequest] google_cloud_dialogflow_v2beta1_reload_document_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2075,11 +1982,10 @@ module Google # Deletes all active contexts in the specified session. # @param [String] parent - # Required. The name of the session to delete all contexts from. Format: - # `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The name of the session to delete all contexts from. Format: ` + # projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. + # If `Environment ID` is not specified we assume default 'draft' environment. + # If `User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2107,22 +2013,20 @@ module Google execute_or_queue_command(command, &block) end - # Processes a natural language query and returns structured, actionable data - # as a result. This method is not idempotent, because it may cause contexts - # and session entity types to be updated, which in turn might affect - # results of future queries. + # Processes a natural language query and returns structured, actionable data as + # a result. This method is not idempotent, because it may cause contexts and + # session entity types to be updated, which in turn might affect results of + # future queries. # @param [String] session - # Required. The name of the session this query is sent to. Format: - # `projects//agent/sessions/`, or - # `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we are using - # "-". It's up to the API caller to choose an appropriate `Session ID` and - # `User Id`. They can be a random number or some type of user and session - # identifiers (preferably hashed). The length of the `Session ID` and - # `User ID` must not exceed 36 characters. - # For more information, see the [API interactions - # guide](https://cloud.google.com/dialogflow/docs/api-overview). + # Required. The name of the session this query is sent to. Format: `projects// + # agent/sessions/`, or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we are using "-". It's up to the API caller to + # choose an appropriate `Session ID` and `User Id`. They can be a random number + # or some type of user and session identifiers (preferably hashed). The length + # of the `Session ID` and `User ID` must not exceed 36 characters. For more + # information, see the [API interactions guide](https://cloud.google.com/ + # dialogflow/docs/api-overview). # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest] google_cloud_dialogflow_v2beta1_detect_intent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2153,15 +2057,13 @@ module Google execute_or_queue_command(command, &block) end - # Creates a context. - # If the specified context already exists, overrides the context. + # Creates a context. If the specified context already exists, overrides the + # context. # @param [String] parent - # Required. The session to create a context for. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume - # default '-' user. + # Required. The session to create a context for. Format: `projects//agent/ + # sessions/` or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context] google_cloud_dialogflow_v2beta1_context_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2194,12 +2096,10 @@ module Google # Deletes the specified context. # @param [String] name - # Required. The name of the context to delete. Format: - # `projects//agent/sessions//contexts/` - # or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is - # not specified, we assume default 'draft' environment. If `User ID` is not - # specified, we assume default '-' user. + # Required. The name of the context to delete. Format: `projects//agent/sessions/ + # /contexts/` or `projects//agent/environments//users//sessions//contexts/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2229,12 +2129,10 @@ module Google # Retrieves the specified context. # @param [String] name - # Required. The name of the context. Format: - # `projects//agent/sessions//contexts/` - # or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is - # not specified, we assume default 'draft' environment. If `User ID` is not - # specified, we assume default '-' user. + # Required. The name of the context. Format: `projects//agent/sessions//contexts/ + # ` or `projects//agent/environments//users//sessions//contexts/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2264,15 +2162,13 @@ module Google # Returns the list of all contexts in the specified session. # @param [String] parent - # Required. The session to list all contexts from. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume - # default '-' user. + # Required. The session to list all contexts from. Format: `projects//agent/ + # sessions/` or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -2306,19 +2202,15 @@ module Google # Updates the specified context. # @param [String] name - # Required. The unique identifier of the context. Format: - # `projects//agent/sessions//contexts/`, - # or `projects//agent/environments//users//sessions//contexts/`. - # The `Context ID` is always converted to lowercase, may only contain - # characters in a-zA-Z0-9_-% and may be at most 250 bytes long. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # The following context names are reserved for internal use by Dialogflow. - # You should not use these contexts or create contexts with these names: - # * `__system_counters__` - # * `*_id_dialog_context` - # * `*_dialog_params_size` + # Required. The unique identifier of the context. Format: `projects//agent/ + # sessions//contexts/`, or `projects//agent/environments//users//sessions// + # contexts/`. The `Context ID` is always converted to lowercase, may only + # contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. The following context + # names are reserved for internal use by Dialogflow. You should not use these + # contexts or create contexts with these names: * `__system_counters__` * `* + # _id_dialog_context` * `*_dialog_params_size` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context] google_cloud_dialogflow_v2beta1_context_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -2352,19 +2244,15 @@ module Google execute_or_queue_command(command, &block) end - # Creates a session entity type. - # If the specified session entity type already exists, overrides the - # session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Creates a session entity type. If the specified session entity type already + # exists, overrides the session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] parent - # Required. The session to create a session entity type for. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users// - # sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume - # default '-' user. + # Required. The session to create a session entity type for. Format: `projects// + # agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType] google_cloud_dialogflow_v2beta1_session_entity_type_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2395,16 +2283,13 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Deletes the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the entity type to delete. Format: - # `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' + # Required. The name of the entity type to delete. Format: `projects//agent/ + # sessions//entityTypes/` or `projects//agent/environments//users//sessions// + # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' # environment. If `User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2433,16 +2318,13 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Retrieves the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the session entity type. Format: - # `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' + # Required. The name of the session entity type. Format: `projects//agent/ + # sessions//entityTypes/` or `projects//agent/environments//users//sessions// + # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' # environment. If `User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2471,20 +2353,17 @@ module Google execute_or_queue_command(command, &block) end - # Returns the list of all session entity types in the specified session. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Returns the list of all session entity types in the specified session. This + # method doesn't work with Google Assistant integration. Contact Dialogflow + # support if you need to use session entities with Google Assistant integration. # @param [String] parent - # Required. The session to list all session entity types from. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users// - # sessions/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The session to list all session entity types from. Format: `projects/ + # /agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -2516,20 +2395,16 @@ module Google execute_or_queue_command(command, &block) end - # Updates the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Updates the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The unique identifier of this session entity type. Format: - # `projects//agent/sessions//entityTypes/`, or - # `projects//agent/environments//users//sessions//entityTypes/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # `` must be the display name of an existing entity - # type in the same agent that will be overridden or supplemented. + # Required. The unique identifier of this session entity type. Format: `projects/ + # /agent/sessions//entityTypes/`, or `projects//agent/environments//users// + # sessions//entityTypes/`. If `Environment ID` is not specified, we assume + # default 'draft' environment. If `User ID` is not specified, we assume default ' + # -' user. `` must be the display name of an existing entity type in the same + # agent that will be overridden or supplemented. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType] google_cloud_dialogflow_v2beta1_session_entity_type_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -2563,12 +2438,10 @@ module Google execute_or_queue_command(command, &block) end - # Creates a knowledge base. - # Note: The `projects.agent.knowledgeBases` resource is deprecated; - # only use `projects.knowledgeBases`. + # Creates a knowledge base. Note: The `projects.agent.knowledgeBases` resource + # is deprecated; only use `projects.knowledgeBases`. # @param [String] parent - # Required. The project to create a knowledge base for. - # Format: `projects/`. + # Required. The project to create a knowledge base for. Format: `projects/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase] google_cloud_dialogflow_v2beta1_knowledge_base_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2599,15 +2472,14 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified knowledge base. - # Note: The `projects.agent.knowledgeBases` resource is deprecated; - # only use `projects.knowledgeBases`. + # Deletes the specified knowledge base. Note: The `projects.agent.knowledgeBases` + # resource is deprecated; only use `projects.knowledgeBases`. # @param [String] name - # Required. The name of the knowledge base to delete. - # Format: `projects//knowledgeBases/`. + # Required. The name of the knowledge base to delete. Format: `projects// + # knowledgeBases/`. # @param [Boolean] force - # Optional. Force deletes the knowledge base. When set to true, any documents - # in the knowledge base are also deleted. + # Optional. Force deletes the knowledge base. When set to true, any documents in + # the knowledge base are also deleted. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2636,12 +2508,11 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the specified knowledge base. - # Note: The `projects.agent.knowledgeBases` resource is deprecated; - # only use `projects.knowledgeBases`. + # Retrieves the specified knowledge base. Note: The `projects.agent. + # knowledgeBases` resource is deprecated; only use `projects.knowledgeBases`. # @param [String] name - # Required. The name of the knowledge base to retrieve. - # Format `projects//knowledgeBases/`. + # Required. The name of the knowledge base to retrieve. Format `projects// + # knowledgeBases/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2669,15 +2540,14 @@ module Google execute_or_queue_command(command, &block) end - # Returns the list of all knowledge bases of the specified agent. - # Note: The `projects.agent.knowledgeBases` resource is deprecated; - # only use `projects.knowledgeBases`. + # Returns the list of all knowledge bases of the specified agent. Note: The ` + # projects.agent.knowledgeBases` resource is deprecated; only use `projects. + # knowledgeBases`. # @param [String] parent - # Required. The project to list of knowledge bases for. - # Format: `projects/`. + # Required. The project to list of knowledge bases for. Format: `projects/`. # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 10 and at most 100. + # Optional. The maximum number of items to return in a single page. By default + # 10 and at most 100. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -2709,18 +2579,16 @@ module Google execute_or_queue_command(command, &block) end - # Updates the specified knowledge base. - # Note: The `projects.agent.knowledgeBases` resource is deprecated; - # only use `projects.knowledgeBases`. + # Updates the specified knowledge base. Note: The `projects.agent.knowledgeBases` + # resource is deprecated; only use `projects.knowledgeBases`. # @param [String] name - # The knowledge base resource name. - # The name must be empty when creating a knowledge base. - # Format: `projects//knowledgeBases/`. + # The knowledge base resource name. The name must be empty when creating a + # knowledge base. Format: `projects//knowledgeBases/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1KnowledgeBase] google_cloud_dialogflow_v2beta1_knowledge_base_object # @param [String] update_mask - # Optional. Not specified means `update all`. - # Currently, only `display_name` can be updated, an InvalidArgument will be - # returned for attempting to update other fields. + # Optional. Not specified means `update all`. Currently, only `display_name` can + # be updated, an InvalidArgument will be returned for attempting to update other + # fields. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2751,12 +2619,11 @@ module Google execute_or_queue_command(command, &block) end - # Creates a new document. - # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - # only use `projects.knowledgeBases.documents`. + # Creates a new document. Note: The `projects.agent.knowledgeBases.documents` + # resource is deprecated; only use `projects.knowledgeBases.documents`. # @param [String] parent - # Required. The knoweldge base to create a document for. - # Format: `projects//knowledgeBases/`. + # Required. The knoweldge base to create a document for. Format: `projects// + # knowledgeBases/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document] google_cloud_dialogflow_v2beta1_document_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2787,13 +2654,12 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified document. - # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - # only use `projects.knowledgeBases.documents`. + # Deletes the specified document. Note: The `projects.agent.knowledgeBases. + # documents` resource is deprecated; only use `projects.knowledgeBases.documents` + # . # @param [String] name - # Required. The name of the document to delete. - # Format: `projects//knowledgeBases//documents/`. + # Required. The name of the document to delete. Format: `projects// + # knowledgeBases//documents/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2821,13 +2687,12 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the specified document. - # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - # only use `projects.knowledgeBases.documents`. + # Retrieves the specified document. Note: The `projects.agent.knowledgeBases. + # documents` resource is deprecated; only use `projects.knowledgeBases.documents` + # . # @param [String] name - # Required. The name of the document to retrieve. - # Format `projects//knowledgeBases//documents/`. + # Required. The name of the document to retrieve. Format `projects// + # knowledgeBases//documents/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2855,15 +2720,15 @@ module Google execute_or_queue_command(command, &block) end - # Returns the list of all documents of the knowledge base. - # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - # only use `projects.knowledgeBases.documents`. + # Returns the list of all documents of the knowledge base. Note: The `projects. + # agent.knowledgeBases.documents` resource is deprecated; only use `projects. + # knowledgeBases.documents`. # @param [String] parent - # Required. The knowledge base to list all documents for. - # Format: `projects//knowledgeBases/`. + # Required. The knowledge base to list all documents for. Format: `projects// + # knowledgeBases/`. # @param [Fixnum] page_size - # The maximum number of items to return in a single page. By - # default 10 and at most 100. + # The maximum number of items to return in a single page. By default 10 and at + # most 100. # @param [String] page_token # The next_page_token value returned from a previous list request. # @param [String] fields @@ -2895,19 +2760,17 @@ module Google execute_or_queue_command(command, &block) end - # Updates the specified document. - # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - # only use `projects.knowledgeBases.documents`. + # Updates the specified document. Note: The `projects.agent.knowledgeBases. + # documents` resource is deprecated; only use `projects.knowledgeBases.documents` + # . # @param [String] name - # Optional. The document resource name. - # The name must be empty when creating a document. - # Format: `projects//knowledgeBases//documents/`. + # Optional. The document resource name. The name must be empty when creating a + # document. Format: `projects//knowledgeBases//documents/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Document] google_cloud_dialogflow_v2beta1_document_object # @param [String] update_mask - # Optional. Not specified means `update all`. - # Currently, only `display_name` can be updated, an InvalidArgument will be - # returned for attempting to update other fields. + # Optional. Not specified means `update all`. Currently, only `display_name` can + # be updated, an InvalidArgument will be returned for attempting to update other + # fields. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2939,15 +2802,14 @@ module Google end # Reloads the specified document from its specified source, content_uri or - # content. The previously loaded content of the document will be deleted. - # Note: Even when the content of the document has not changed, there still - # may be side effects because of internal implementation changes. - # Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; - # only use `projects.knowledgeBases.documents`. + # content. The previously loaded content of the document will be deleted. Note: + # Even when the content of the document has not changed, there still may be side + # effects because of internal implementation changes. Note: The `projects.agent. + # knowledgeBases.documents` resource is deprecated; only use `projects. + # knowledgeBases.documents`. # @param [String] name - # Required. The name of the document to reload. - # Format: `projects//knowledgeBases//documents/` + # Required. The name of the document to reload. Format: `projects// + # knowledgeBases//documents/` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ReloadDocumentRequest] google_cloud_dialogflow_v2beta1_reload_document_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2980,8 +2842,8 @@ module Google # Deletes the specified agent. # @param [String] parent - # Required. The project that the agent to delete is associated with. - # Format: `projects/`. + # Required. The project that the agent to delete is associated with. Format: ` + # projects/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3011,8 +2873,8 @@ module Google # Retrieves the specified agent. # @param [String] parent - # Required. The project that the agent to fetch is associated with. - # Format: `projects/`. + # Required. The project that the agent to fetch is associated with. Format: ` + # projects/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3042,8 +2904,7 @@ module Google # Creates/updates the specified agent. # @param [String] parent - # Required. The project of this agent. - # Format: `projects/`. + # Required. The project of this agent. Format: `projects/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Agent] google_cloud_dialogflow_v2beta1_agent_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -3077,11 +2938,10 @@ module Google execute_or_queue_command(command, &block) end - # Exports the specified agent to a ZIP file. - # Operation + # Exports the specified agent to a ZIP file. Operation # @param [String] parent - # Required. The project that the agent to export is associated with. - # Format: `projects/`. + # Required. The project that the agent to export is associated with. Format: ` + # projects/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ExportAgentRequest] google_cloud_dialogflow_v2beta1_export_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3114,8 +2974,7 @@ module Google # Retrieves the fulfillment. # @param [String] name - # Required. The name of the fulfillment. - # Format: `projects//agent/fulfillment`. + # Required. The name of the fulfillment. Format: `projects//agent/fulfillment`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3143,20 +3002,18 @@ module Google execute_or_queue_command(command, &block) end - # Imports the specified agent from a ZIP file. - # Uploads new intents and entity types without deleting the existing ones. - # Intents and entity types with the same name are replaced with the new - # versions from ImportAgentRequest. After the import, the imported draft - # agent will be trained automatically (unless disabled in agent settings). - # However, once the import is done, training may not be completed yet. Please - # call TrainAgent and wait for the operation it returns in order to train - # explicitly. - # Operation - # An operation which tracks when importing is complete. It only tracks - # when the draft agent is updated not when it is done training. + # Imports the specified agent from a ZIP file. Uploads new intents and entity + # types without deleting the existing ones. Intents and entity types with the + # same name are replaced with the new versions from ImportAgentRequest. After + # the import, the imported draft agent will be trained automatically (unless + # disabled in agent settings). However, once the import is done, training may + # not be completed yet. Please call TrainAgent and wait for the operation it + # returns in order to train explicitly. Operation An operation which tracks when + # importing is complete. It only tracks when the draft agent is updated not when + # it is done training. # @param [String] parent - # Required. The project that the agent to import is associated with. - # Format: `projects/`. + # Required. The project that the agent to import is associated with. Format: ` + # projects/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ImportAgentRequest] google_cloud_dialogflow_v2beta1_import_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3187,19 +3044,17 @@ module Google execute_or_queue_command(command, &block) end - # Restores the specified agent from a ZIP file. - # Replaces the current agent version with a new one. All the intents and - # entity types in the older version are deleted. After the restore, the - # restored draft agent will be trained automatically (unless disabled in - # agent settings). However, once the restore is done, training may not be - # completed yet. Please call TrainAgent and wait for the operation it - # returns in order to train explicitly. - # Operation - # An operation which tracks when restoring is complete. It only tracks - # when the draft agent is updated not when it is done training. + # Restores the specified agent from a ZIP file. Replaces the current agent + # version with a new one. All the intents and entity types in the older version + # are deleted. After the restore, the restored draft agent will be trained + # automatically (unless disabled in agent settings). However, once the restore + # is done, training may not be completed yet. Please call TrainAgent and wait + # for the operation it returns in order to train explicitly. Operation An + # operation which tracks when restoring is complete. It only tracks when the + # draft agent is updated not when it is done training. # @param [String] parent - # Required. The project that the agent to restore is associated with. - # Format: `projects/`. + # Required. The project that the agent to restore is associated with. Format: ` + # projects/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1RestoreAgentRequest] google_cloud_dialogflow_v2beta1_restore_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3230,19 +3085,16 @@ module Google execute_or_queue_command(command, &block) end - # Returns the list of agents. - # Since there is at most one conversational agent per project, this method is - # useful primarily for listing all agents across projects the caller has - # access to. One can achieve that with a wildcard project collection id "-". - # Refer to [List - # Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub- - # collections). + # Returns the list of agents. Since there is at most one conversational agent + # per project, this method is useful primarily for listing all agents across + # projects the caller has access to. One can achieve that with a wildcard + # project collection id "-". Refer to [List Sub-Collections](https://cloud. + # google.com/apis/design/design_patterns#list_sub-collections). # @param [String] parent - # Required. The project to list agents from. - # Format: `projects/`. + # Required. The project to list agents from. Format: `projects/`. # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -3274,11 +3126,10 @@ module Google execute_or_queue_command(command, &block) end - # Trains the specified agent. - # Operation + # Trains the specified agent. Operation # @param [String] parent - # Required. The project that the agent to train is associated with. - # Format: `projects/`. + # Required. The project that the agent to train is associated with. Format: ` + # projects/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1TrainAgentRequest] google_cloud_dialogflow_v2beta1_train_agent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3311,8 +3162,8 @@ module Google # Updates the fulfillment. # @param [String] name - # Required. The unique identifier of the fulfillment. - # Format: `projects//agent/fulfillment`. + # Required. The unique identifier of the fulfillment. Format: `projects//agent/ + # fulfillment`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Fulfillment] google_cloud_dialogflow_v2beta1_fulfillment_object # @param [String] update_mask # Required. The mask to control which fields get updated. If the mask is not @@ -3347,11 +3198,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes entity types in the specified agent. - # Operation + # Deletes entity types in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to delete all entities types for. Format: - # `projects//agent`. + # Required. The name of the agent to delete all entities types for. Format: ` + # projects//agent`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteEntityTypesRequest] google_cloud_dialogflow_v2beta1_batch_delete_entity_types_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3382,11 +3232,10 @@ module Google execute_or_queue_command(command, &block) end - # Updates/Creates multiple entity types in the specified agent. - # Operation + # Updates/Creates multiple entity types in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to update or create entity types in. - # Format: `projects//agent`. + # Required. The name of the agent to update or create entity types in. Format: ` + # projects//agent`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesRequest] google_cloud_dialogflow_v2beta1_batch_update_entity_types_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3419,16 +3268,13 @@ module Google # Creates an entity type in the specified agent. # @param [String] parent - # Required. The agent to create a entity type for. - # Format: `projects//agent`. + # Required. The agent to create a entity type for. Format: `projects//agent`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType] google_cloud_dialogflow_v2beta1_entity_type_object # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3461,8 +3307,8 @@ module Google # Deletes the specified entity type. # @param [String] name - # Required. The name of the entity type to delete. - # Format: `projects//agent/entityTypes/`. + # Required. The name of the entity type to delete. Format: `projects//agent/ + # entityTypes/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3492,15 +3338,12 @@ module Google # Retrieves the specified entity type. # @param [String] name - # Required. The name of the entity type. - # Format: `projects//agent/entityTypes/`. + # Required. The name of the entity type. Format: `projects//agent/entityTypes/`. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3531,18 +3374,15 @@ module Google # Returns the list of all entity types in the specified agent. # @param [String] parent - # Required. The agent to list all entity types from. - # Format: `projects//agent`. + # Required. The agent to list all entity types from. Format: `projects//agent`. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -3577,18 +3417,15 @@ module Google # Updates the specified entity type. # @param [String] name - # The unique identifier of the entity type. - # Required for EntityTypes.UpdateEntityType and - # EntityTypes.BatchUpdateEntityTypes methods. - # Format: `projects//agent/entityTypes/`. + # The unique identifier of the entity type. Required for EntityTypes. + # UpdateEntityType and EntityTypes.BatchUpdateEntityTypes methods. Format: ` + # projects//agent/entityTypes/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EntityType] google_cloud_dialogflow_v2beta1_entity_type_object # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] update_mask # Optional. The mask to control which fields get updated. # @param [String] fields @@ -3622,11 +3459,10 @@ module Google execute_or_queue_command(command, &block) end - # Creates multiple new entities in the specified entity type. - # Operation + # Creates multiple new entities in the specified entity type. Operation # @param [String] parent - # Required. The name of the entity type to create entities in. Format: - # `projects//agent/entityTypes/`. + # Required. The name of the entity type to create entities in. Format: `projects/ + # /agent/entityTypes/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchCreateEntitiesRequest] google_cloud_dialogflow_v2beta1_batch_create_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3657,11 +3493,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes entities in the specified entity type. - # Operation + # Deletes entities in the specified entity type. Operation # @param [String] parent - # Required. The name of the entity type to delete entries for. Format: - # `projects//agent/entityTypes/`. + # Required. The name of the entity type to delete entries for. Format: `projects/ + # /agent/entityTypes/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteEntitiesRequest] google_cloud_dialogflow_v2beta1_batch_delete_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3692,13 +3527,12 @@ module Google execute_or_queue_command(command, &block) end - # Updates or creates multiple entities in the specified entity type. This - # method does not affect entities in the entity type that aren't explicitly - # specified in the request. - # Operation + # Updates or creates multiple entities in the specified entity type. This method + # does not affect entities in the entity type that aren't explicitly specified + # in the request. Operation # @param [String] parent - # Required. The name of the entity type to update or create entities in. - # Format: `projects//agent/entityTypes/`. + # Required. The name of the entity type to update or create entities in. Format: + # `projects//agent/entityTypes/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateEntitiesRequest] google_cloud_dialogflow_v2beta1_batch_update_entities_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3731,15 +3565,11 @@ module Google # Returns the list of all non-draft environments of the specified agent. # @param [String] parent - # Required. The agent to list all environments from. - # Format: - # - `projects//agent` - # - `projects//locations//agent + # Required. The agent to list all environments from. Format: - `projects//agent` + # - `projects//locations//agent # @param [Fixnum] page_size # Optional. The maximum number of items to return in a single page. By default - # 100 and - # at most 1000. + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -3773,11 +3603,10 @@ module Google # Deletes all active contexts in the specified session. # @param [String] parent - # Required. The name of the session to delete all contexts from. Format: - # `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The name of the session to delete all contexts from. Format: ` + # projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. + # If `Environment ID` is not specified we assume default 'draft' environment. + # If `User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3805,22 +3634,20 @@ module Google execute_or_queue_command(command, &block) end - # Processes a natural language query and returns structured, actionable data - # as a result. This method is not idempotent, because it may cause contexts - # and session entity types to be updated, which in turn might affect - # results of future queries. + # Processes a natural language query and returns structured, actionable data as + # a result. This method is not idempotent, because it may cause contexts and + # session entity types to be updated, which in turn might affect results of + # future queries. # @param [String] session - # Required. The name of the session this query is sent to. Format: - # `projects//agent/sessions/`, or - # `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we are using - # "-". It's up to the API caller to choose an appropriate `Session ID` and - # `User Id`. They can be a random number or some type of user and session - # identifiers (preferably hashed). The length of the `Session ID` and - # `User ID` must not exceed 36 characters. - # For more information, see the [API interactions - # guide](https://cloud.google.com/dialogflow/docs/api-overview). + # Required. The name of the session this query is sent to. Format: `projects// + # agent/sessions/`, or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we are using "-". It's up to the API caller to + # choose an appropriate `Session ID` and `User Id`. They can be a random number + # or some type of user and session identifiers (preferably hashed). The length + # of the `Session ID` and `User ID` must not exceed 36 characters. For more + # information, see the [API interactions guide](https://cloud.google.com/ + # dialogflow/docs/api-overview). # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest] google_cloud_dialogflow_v2beta1_detect_intent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3851,15 +3678,13 @@ module Google execute_or_queue_command(command, &block) end - # Creates a context. - # If the specified context already exists, overrides the context. + # Creates a context. If the specified context already exists, overrides the + # context. # @param [String] parent - # Required. The session to create a context for. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume - # default '-' user. + # Required. The session to create a context for. Format: `projects//agent/ + # sessions/` or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context] google_cloud_dialogflow_v2beta1_context_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -3892,12 +3717,10 @@ module Google # Deletes the specified context. # @param [String] name - # Required. The name of the context to delete. Format: - # `projects//agent/sessions//contexts/` - # or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is - # not specified, we assume default 'draft' environment. If `User ID` is not - # specified, we assume default '-' user. + # Required. The name of the context to delete. Format: `projects//agent/sessions/ + # /contexts/` or `projects//agent/environments//users//sessions//contexts/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3927,12 +3750,10 @@ module Google # Retrieves the specified context. # @param [String] name - # Required. The name of the context. Format: - # `projects//agent/sessions//contexts/` - # or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is - # not specified, we assume default 'draft' environment. If `User ID` is not - # specified, we assume default '-' user. + # Required. The name of the context. Format: `projects//agent/sessions//contexts/ + # ` or `projects//agent/environments//users//sessions//contexts/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -3962,15 +3783,13 @@ module Google # Returns the list of all contexts in the specified session. # @param [String] parent - # Required. The session to list all contexts from. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume - # default '-' user. + # Required. The session to list all contexts from. Format: `projects//agent/ + # sessions/` or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -4004,19 +3823,15 @@ module Google # Updates the specified context. # @param [String] name - # Required. The unique identifier of the context. Format: - # `projects//agent/sessions//contexts/`, - # or `projects//agent/environments//users//sessions//contexts/`. - # The `Context ID` is always converted to lowercase, may only contain - # characters in a-zA-Z0-9_-% and may be at most 250 bytes long. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # The following context names are reserved for internal use by Dialogflow. - # You should not use these contexts or create contexts with these names: - # * `__system_counters__` - # * `*_id_dialog_context` - # * `*_dialog_params_size` + # Required. The unique identifier of the context. Format: `projects//agent/ + # sessions//contexts/`, or `projects//agent/environments//users//sessions// + # contexts/`. The `Context ID` is always converted to lowercase, may only + # contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. The following context + # names are reserved for internal use by Dialogflow. You should not use these + # contexts or create contexts with these names: * `__system_counters__` * `* + # _id_dialog_context` * `*_dialog_params_size` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context] google_cloud_dialogflow_v2beta1_context_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -4050,19 +3865,15 @@ module Google execute_or_queue_command(command, &block) end - # Creates a session entity type. - # If the specified session entity type already exists, overrides the - # session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Creates a session entity type. If the specified session entity type already + # exists, overrides the session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] parent - # Required. The session to create a session entity type for. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users// - # sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume - # default '-' user. + # Required. The session to create a session entity type for. Format: `projects// + # agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType] google_cloud_dialogflow_v2beta1_session_entity_type_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4093,16 +3904,13 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Deletes the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the entity type to delete. Format: - # `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' + # Required. The name of the entity type to delete. Format: `projects//agent/ + # sessions//entityTypes/` or `projects//agent/environments//users//sessions// + # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' # environment. If `User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4131,16 +3939,13 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Retrieves the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the session entity type. Format: - # `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' + # Required. The name of the session entity type. Format: `projects//agent/ + # sessions//entityTypes/` or `projects//agent/environments//users//sessions// + # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' # environment. If `User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4169,20 +3974,17 @@ module Google execute_or_queue_command(command, &block) end - # Returns the list of all session entity types in the specified session. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Returns the list of all session entity types in the specified session. This + # method doesn't work with Google Assistant integration. Contact Dialogflow + # support if you need to use session entities with Google Assistant integration. # @param [String] parent - # Required. The session to list all session entity types from. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users// - # sessions/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The session to list all session entity types from. Format: `projects/ + # /agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -4214,20 +4016,16 @@ module Google execute_or_queue_command(command, &block) end - # Updates the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Updates the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The unique identifier of this session entity type. Format: - # `projects//agent/sessions//entityTypes/`, or - # `projects//agent/environments//users//sessions//entityTypes/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # `` must be the display name of an existing entity - # type in the same agent that will be overridden or supplemented. + # Required. The unique identifier of this session entity type. Format: `projects/ + # /agent/sessions//entityTypes/`, or `projects//agent/environments//users// + # sessions//entityTypes/`. If `Environment ID` is not specified, we assume + # default 'draft' environment. If `User ID` is not specified, we assume default ' + # -' user. `` must be the display name of an existing entity type in the same + # agent that will be overridden or supplemented. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType] google_cloud_dialogflow_v2beta1_session_entity_type_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -4261,11 +4059,10 @@ module Google execute_or_queue_command(command, &block) end - # Deletes intents in the specified agent. - # Operation + # Deletes intents in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to delete all entities types for. Format: - # `projects//agent`. + # Required. The name of the agent to delete all entities types for. Format: ` + # projects//agent`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchDeleteIntentsRequest] google_cloud_dialogflow_v2beta1_batch_delete_intents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4296,11 +4093,10 @@ module Google execute_or_queue_command(command, &block) end - # Updates/Creates multiple intents in the specified agent. - # Operation + # Updates/Creates multiple intents in the specified agent. Operation # @param [String] parent - # Required. The name of the agent to update or create intents in. - # Format: `projects//agent`. + # Required. The name of the agent to update or create intents in. Format: ` + # projects//agent`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1BatchUpdateIntentsRequest] google_cloud_dialogflow_v2beta1_batch_update_intents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4333,18 +4129,15 @@ module Google # Creates an intent in the specified agent. # @param [String] parent - # Required. The agent to create a intent for. - # Format: `projects//agent`. + # Required. The agent to create a intent for. Format: `projects//agent`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent] google_cloud_dialogflow_v2beta1_intent_object # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4379,8 +4172,8 @@ module Google # Deletes the specified intent and its direct or indirect followup intents. # @param [String] name # Required. The name of the intent to delete. If this intent has direct or - # indirect followup intents, we also delete them. - # Format: `projects//agent/intents/`. + # indirect followup intents, we also delete them. Format: `projects//agent/ + # intents/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4410,17 +4203,14 @@ module Google # Retrieves the specified intent. # @param [String] name - # Required. The name of the intent. - # Format: `projects//agent/intents/`. + # Required. The name of the intent. Format: `projects//agent/intents/`. # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4452,20 +4242,17 @@ module Google # Returns the list of all intents in the specified agent. # @param [String] parent - # Required. The agent to list all intents from. - # Format: `projects//agent`. + # Required. The agent to list all intents from. Format: `projects//agent`. # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -4501,20 +4288,17 @@ module Google # Updates the specified intent. # @param [String] name - # Optional. The unique identifier of this intent. - # Required for Intents.UpdateIntent and Intents.BatchUpdateIntents - # methods. - # Format: `projects//agent/intents/`. + # Optional. The unique identifier of this intent. Required for Intents. + # UpdateIntent and Intents.BatchUpdateIntents methods. Format: `projects//agent/ + # intents/`. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Intent] google_cloud_dialogflow_v2beta1_intent_object # @param [String] intent_view # Optional. The resource view to apply to the returned intent. # @param [String] language_code - # Optional. The language used to access language-specific data. - # If not specified, the agent's default language is used. - # For more information, see - # [Multilingual intent and entity - # data](https://cloud.google.com/dialogflow/docs/agents-multilingual#intent- - # entity). + # Optional. The language used to access language-specific data. If not specified, + # the agent's default language is used. For more information, see [Multilingual + # intent and entity data](https://cloud.google.com/dialogflow/docs/agents- + # multilingual#intent-entity). # @param [String] update_mask # Optional. The mask to control which fields get updated. # @param [String] fields @@ -4551,11 +4335,10 @@ module Google # Deletes all active contexts in the specified session. # @param [String] parent - # Required. The name of the session to delete all contexts from. Format: - # `projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The name of the session to delete all contexts from. Format: ` + # projects//agent/sessions/` or `projects//agent/environments//users//sessions/`. + # If `Environment ID` is not specified we assume default 'draft' environment. + # If `User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4583,22 +4366,20 @@ module Google execute_or_queue_command(command, &block) end - # Processes a natural language query and returns structured, actionable data - # as a result. This method is not idempotent, because it may cause contexts - # and session entity types to be updated, which in turn might affect - # results of future queries. + # Processes a natural language query and returns structured, actionable data as + # a result. This method is not idempotent, because it may cause contexts and + # session entity types to be updated, which in turn might affect results of + # future queries. # @param [String] session - # Required. The name of the session this query is sent to. Format: - # `projects//agent/sessions/`, or - # `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we are using - # "-". It's up to the API caller to choose an appropriate `Session ID` and - # `User Id`. They can be a random number or some type of user and session - # identifiers (preferably hashed). The length of the `Session ID` and - # `User ID` must not exceed 36 characters. - # For more information, see the [API interactions - # guide](https://cloud.google.com/dialogflow/docs/api-overview). + # Required. The name of the session this query is sent to. Format: `projects// + # agent/sessions/`, or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we are using "-". It's up to the API caller to + # choose an appropriate `Session ID` and `User Id`. They can be a random number + # or some type of user and session identifiers (preferably hashed). The length + # of the `Session ID` and `User ID` must not exceed 36 characters. For more + # information, see the [API interactions guide](https://cloud.google.com/ + # dialogflow/docs/api-overview). # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1DetectIntentRequest] google_cloud_dialogflow_v2beta1_detect_intent_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4629,15 +4410,13 @@ module Google execute_or_queue_command(command, &block) end - # Creates a context. - # If the specified context already exists, overrides the context. + # Creates a context. If the specified context already exists, overrides the + # context. # @param [String] parent - # Required. The session to create a context for. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume - # default '-' user. + # Required. The session to create a context for. Format: `projects//agent/ + # sessions/` or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context] google_cloud_dialogflow_v2beta1_context_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4670,12 +4449,10 @@ module Google # Deletes the specified context. # @param [String] name - # Required. The name of the context to delete. Format: - # `projects//agent/sessions//contexts/` - # or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is - # not specified, we assume default 'draft' environment. If `User ID` is not - # specified, we assume default '-' user. + # Required. The name of the context to delete. Format: `projects//agent/sessions/ + # /contexts/` or `projects//agent/environments//users//sessions//contexts/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4705,12 +4482,10 @@ module Google # Retrieves the specified context. # @param [String] name - # Required. The name of the context. Format: - # `projects//agent/sessions//contexts/` - # or `projects//agent/environments//users//sessions//contexts/`. If `Environment ID` is - # not specified, we assume default 'draft' environment. If `User ID` is not - # specified, we assume default '-' user. + # Required. The name of the context. Format: `projects//agent/sessions//contexts/ + # ` or `projects//agent/environments//users//sessions//contexts/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -4740,15 +4515,13 @@ module Google # Returns the list of all contexts in the specified session. # @param [String] parent - # Required. The session to list all contexts from. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users//sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume - # default '-' user. + # Required. The session to list all contexts from. Format: `projects//agent/ + # sessions/` or `projects//agent/environments//users//sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -4782,19 +4555,15 @@ module Google # Updates the specified context. # @param [String] name - # Required. The unique identifier of the context. Format: - # `projects//agent/sessions//contexts/`, - # or `projects//agent/environments//users//sessions//contexts/`. - # The `Context ID` is always converted to lowercase, may only contain - # characters in a-zA-Z0-9_-% and may be at most 250 bytes long. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # The following context names are reserved for internal use by Dialogflow. - # You should not use these contexts or create contexts with these names: - # * `__system_counters__` - # * `*_id_dialog_context` - # * `*_dialog_params_size` + # Required. The unique identifier of the context. Format: `projects//agent/ + # sessions//contexts/`, or `projects//agent/environments//users//sessions// + # contexts/`. The `Context ID` is always converted to lowercase, may only + # contain characters in a-zA-Z0-9_-% and may be at most 250 bytes long. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. The following context + # names are reserved for internal use by Dialogflow. You should not use these + # contexts or create contexts with these names: * `__system_counters__` * `* + # _id_dialog_context` * `*_dialog_params_size` # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Context] google_cloud_dialogflow_v2beta1_context_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -4828,19 +4597,15 @@ module Google execute_or_queue_command(command, &block) end - # Creates a session entity type. - # If the specified session entity type already exists, overrides the - # session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Creates a session entity type. If the specified session entity type already + # exists, overrides the session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] parent - # Required. The session to create a session entity type for. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users// - # sessions/`. If `Environment ID` is not specified, we assume - # default 'draft' environment. If `User ID` is not specified, we assume - # default '-' user. + # Required. The session to create a session entity type for. Format: `projects// + # agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType] google_cloud_dialogflow_v2beta1_session_entity_type_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4871,16 +4636,13 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Deletes the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the entity type to delete. Format: - # `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' + # Required. The name of the entity type to delete. Format: `projects//agent/ + # sessions//entityTypes/` or `projects//agent/environments//users//sessions// + # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' # environment. If `User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4909,16 +4671,13 @@ module Google execute_or_queue_command(command, &block) end - # Retrieves the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Retrieves the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The name of the session entity type. Format: - # `projects//agent/sessions//entityTypes/` or `projects//agent/environments//users//sessions//entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' + # Required. The name of the session entity type. Format: `projects//agent/ + # sessions//entityTypes/` or `projects//agent/environments//users//sessions// + # entityTypes/`. If `Environment ID` is not specified, we assume default 'draft' # environment. If `User ID` is not specified, we assume default '-' user. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -4947,20 +4706,17 @@ module Google execute_or_queue_command(command, &block) end - # Returns the list of all session entity types in the specified session. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Returns the list of all session entity types in the specified session. This + # method doesn't work with Google Assistant integration. Contact Dialogflow + # support if you need to use session entities with Google Assistant integration. # @param [String] parent - # Required. The session to list all session entity types from. - # Format: `projects//agent/sessions/` or - # `projects//agent/environments//users// - # sessions/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. + # Required. The session to list all session entity types from. Format: `projects/ + # /agent/sessions/` or `projects//agent/environments//users// sessions/`. If ` + # Environment ID` is not specified, we assume default 'draft' environment. If ` + # User ID` is not specified, we assume default '-' user. # @param [Fixnum] page_size - # Optional. The maximum number of items to return in a single page. By - # default 100 and at most 1000. + # Optional. The maximum number of items to return in a single page. By default + # 100 and at most 1000. # @param [String] page_token # Optional. The next_page_token value returned from a previous list request. # @param [String] fields @@ -4992,20 +4748,16 @@ module Google execute_or_queue_command(command, &block) end - # Updates the specified session entity type. - # This method doesn't work with Google Assistant integration. - # Contact Dialogflow support if you need to use session entities - # with Google Assistant integration. + # Updates the specified session entity type. This method doesn't work with + # Google Assistant integration. Contact Dialogflow support if you need to use + # session entities with Google Assistant integration. # @param [String] name - # Required. The unique identifier of this session entity type. Format: - # `projects//agent/sessions//entityTypes/`, or - # `projects//agent/environments//users//sessions//entityTypes/`. - # If `Environment ID` is not specified, we assume default 'draft' - # environment. If `User ID` is not specified, we assume default '-' user. - # `` must be the display name of an existing entity - # type in the same agent that will be overridden or supplemented. + # Required. The unique identifier of this session entity type. Format: `projects/ + # /agent/sessions//entityTypes/`, or `projects//agent/environments//users// + # sessions//entityTypes/`. If `Environment ID` is not specified, we assume + # default 'draft' environment. If `User ID` is not specified, we assume default ' + # -' user. `` must be the display name of an existing entity type in the same + # agent that will be overridden or supplemented. # @param [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SessionEntityType] google_cloud_dialogflow_v2beta1_session_entity_type_object # @param [String] update_mask # Optional. The mask to control which fields get updated. @@ -5039,15 +4791,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. @@ -5078,9 +4828,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 @@ -5110,15 +4859,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 @@ -5157,15 +4905,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. @@ -5196,9 +4942,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 @@ -5228,15 +4973,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/driveactivity_v2.rb b/generated/google/apis/driveactivity_v2.rb index 001590b8c..523064f26 100644 --- a/generated/google/apis/driveactivity_v2.rb +++ b/generated/google/apis/driveactivity_v2.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/drive/activity/ module DriveactivityV2 VERSION = 'V2' - REVISION = '20200428' + REVISION = '20200801' # View and add to the activity record of files in your Google Drive AUTH_DRIVE_ACTIVITY = 'https://www.googleapis.com/auth/drive.activity' diff --git a/generated/google/apis/driveactivity_v2/classes.rb b/generated/google/apis/driveactivity_v2/classes.rb index 25c1c86c7..2be17d4cb 100644 --- a/generated/google/apis/driveactivity_v2/classes.rb +++ b/generated/google/apis/driveactivity_v2/classes.rb @@ -313,16 +313,16 @@ module Google # How the individual activities are consolidated. A set of activities may be # consolidated into one combined activity if they are related in some way, such # as one actor performing the same action on multiple targets, or multiple - # actors performing the same action on a single target. The strategy defines - # the rules for which activities are related. + # actors performing the same action on a single target. The strategy defines the + # rules for which activities are related. class ConsolidationStrategy include Google::Apis::Core::Hashable # A strategy which consolidates activities using the grouping rules from the - # legacy V1 Activity API. Similar actions occurring within a window of time - # can be grouped across multiple targets (such as moving a set of files at - # once) or multiple actors (such as several users editing the same item). - # Grouping rules for this strategy are specific to each type of action. + # legacy V1 Activity API. Similar actions occurring within a window of time can + # be grouped across multiple targets (such as moving a set of files at once) or + # multiple actors (such as several users editing the same item). Grouping rules + # for this strategy are specific to each type of action. # Corresponds to the JSON property `legacy` # @return [Google::Apis::DriveactivityV2::Legacy] attr_accessor :legacy @@ -473,9 +473,8 @@ module Google class Drive include Google::Apis::Core::Hashable - # The resource name of the shared drive. The format is - # "COLLECTION_ID/DRIVE_ID". Clients should not assume a specific collection - # ID for this resource name. + # The resource name of the shared drive. The format is "COLLECTION_ID/DRIVE_ID". + # Clients should not assume a specific collection ID for this resource name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -502,12 +501,12 @@ module Google end end - # A single Drive activity comprising one or more Actions by one or more - # Actors on one or more Targets. Some Action groupings occur spontaneously, - # such as moving an item into a shared folder triggering a permission change. - # Other groupings of related Actions, such as multiple Actors editing one item - # or moving multiple files into a new folder, are controlled by the selection - # of a ConsolidationStrategy in the QueryDriveActivityRequest. + # A single Drive activity comprising one or more Actions by one or more Actors + # on one or more Targets. Some Action groupings occur spontaneously, such as + # moving an item into a shared folder triggering a permission change. Other + # groupings of related Actions, such as multiple Actors editing one item or + # moving multiple files into a new folder, are controlled by the selection of a + # ConsolidationStrategy in the QueryDriveActivityRequest. class DriveActivity include Google::Apis::Core::Hashable @@ -527,8 +526,7 @@ module Google attr_accessor :primary_action_detail # All Google Drive objects this activity is about (e.g. file, folder, drive). - # This represents the state of the target immediately after the actions - # occurred. + # This represents the state of the target immediately after the actions occurred. # Corresponds to the JSON property `targets` # @return [Array] attr_accessor :targets @@ -614,8 +612,8 @@ module Google # @return [Google::Apis::DriveactivityV2::Folder] attr_accessor :folder - # The MIME type of the Drive item. See - # https://developers.google.com/drive/v3/web/mime-types. + # The MIME type of the Drive item. See https://developers.google.com/drive/v3/ + # web/mime-types. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -705,9 +703,8 @@ module Google class DriveReference include Google::Apis::Core::Hashable - # The resource name of the shared drive. The format is - # "COLLECTION_ID/DRIVE_ID". Clients should not assume a specific collection - # ID for this resource name. + # The resource name of the shared drive. The format is "COLLECTION_ID/DRIVE_ID". + # Clients should not assume a specific collection ID for this resource name. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -759,22 +756,22 @@ module Google include Google::Apis::Core::Hashable # The comment in the discussion thread. This identifier is an opaque string - # compatible with the Drive API; see - # https://developers.google.com/drive/v3/reference/comments/get + # compatible with the Drive API; see https://developers.google.com/drive/v3/ + # reference/comments/get # Corresponds to the JSON property `legacyCommentId` # @return [String] attr_accessor :legacy_comment_id # The discussion thread to which the comment was added. This identifier is an - # opaque string compatible with the Drive API and references the first - # comment in a discussion; see - # https://developers.google.com/drive/v3/reference/comments/get + # opaque string compatible with the Drive API and references the first comment + # in a discussion; see https://developers.google.com/drive/v3/reference/comments/ + # get # Corresponds to the JSON property `legacyDiscussionId` # @return [String] attr_accessor :legacy_discussion_id - # The link to the discussion thread containing this comment, for example, - # "https://docs.google.com/DOCUMENT_ID/edit?disco=THREAD_ID". + # The link to the discussion thread containing this comment, for example, "https: + # //docs.google.com/DOCUMENT_ID/edit?disco=THREAD_ID". # Corresponds to the JSON property `linkToDiscussion` # @return [String] attr_accessor :link_to_discussion @@ -871,9 +868,9 @@ module Google attr_accessor :is_current_user alias_method :is_current_user?, :is_current_user - # The identifier for this user that can be used with the People API to get - # more information. The format is "people/ACCOUNT_ID". See - # https://developers.google.com/people/. + # The identifier for this user that can be used with the People API to get more + # information. The format is "people/ACCOUNT_ID". See https://developers.google. + # com/people/. # Corresponds to the JSON property `personName` # @return [String] attr_accessor :person_name @@ -890,10 +887,10 @@ module Google end # A strategy which consolidates activities using the grouping rules from the - # legacy V1 Activity API. Similar actions occurring within a window of time - # can be grouped across multiple targets (such as moving a set of files at - # once) or multiple actors (such as several users editing the same item). - # Grouping rules for this strategy are specific to each type of action. + # legacy V1 Activity API. Similar actions occurring within a window of time can + # be grouped across multiple targets (such as moving a set of files at once) or + # multiple actors (such as several users editing the same item). Grouping rules + # for this strategy are specific to each type of action. class Legacy include Google::Apis::Core::Hashable @@ -1020,10 +1017,8 @@ module Google # @return [Google::Apis::DriveactivityV2::Group] attr_accessor :group - # Indicates the - # Google Drive permissions - # role. The role determines a user's ability to read, write, and - # comment on items. + # Indicates the Google Drive permissions role. The role determines a user's + # ability to read, write, and comment on items. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -1096,8 +1091,8 @@ module Google class QueryDriveActivityRequest include Google::Apis::Core::Hashable - # Return activities for this Drive folder and all children and descendants. - # The format is "items/ITEM_ID". + # Return activities for this Drive folder and all children and descendants. The + # format is "items/ITEM_ID". # Corresponds to the JSON property `ancestorName` # @return [String] attr_accessor :ancestor_name @@ -1105,50 +1100,42 @@ module Google # How the individual activities are consolidated. A set of activities may be # consolidated into one combined activity if they are related in some way, such # as one actor performing the same action on multiple targets, or multiple - # actors performing the same action on a single target. The strategy defines - # the rules for which activities are related. + # actors performing the same action on a single target. The strategy defines the + # rules for which activities are related. # Corresponds to the JSON property `consolidationStrategy` # @return [Google::Apis::DriveactivityV2::ConsolidationStrategy] attr_accessor :consolidation_strategy # The filtering for items returned from this query request. The format of the - # filter string is a sequence of expressions, joined by an optional "AND", - # where each expression is of the form "field operator value". - # Supported fields: - # - time: Uses numerical operators on date values either in - # terms of milliseconds since Jan 1, 1970 or in RFC 3339 format. - # Examples: - # - time > 1452409200000 AND time <= 1492812924310 - # - time >= "2016-01-10T01:02:03-05:00" - # - detail.action_detail_case: Uses the "has" operator (:) and - # either a singular value or a list of allowed action types enclosed in - # parentheses. - # Examples: - # - detail.action_detail_case: RENAME - # - detail.action_detail_case:(CREATE EDIT) - # - -detail.action_detail_case:MOVE + # filter string is a sequence of expressions, joined by an optional "AND", where + # each expression is of the form "field operator value". Supported fields: - + # time: Uses numerical operators on date values either in terms of milliseconds + # since Jan 1, 1970 or in RFC 3339 format. Examples: - time > 1452409200000 AND + # time <= 1492812924310 - time >= "2016-01-10T01:02:03-05:00" - detail. + # action_detail_case: Uses the "has" operator (:) and either a singular value or + # a list of allowed action types enclosed in parentheses. Examples: - detail. + # action_detail_case: RENAME - detail.action_detail_case:(CREATE EDIT) - -detail. + # action_detail_case:MOVE # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter - # Return activities for this Drive item. The format is - # "items/ITEM_ID". + # Return activities for this Drive item. The format is "items/ITEM_ID". # Corresponds to the JSON property `itemName` # @return [String] attr_accessor :item_name # The miminum number of activities desired in the response; the server will # attempt to return at least this quanitity. The server may also return fewer - # activities if it has a partial response ready before the request times out. - # If not set, a default value is used. + # activities if it has a partial response ready before the request times out. If + # not set, a default value is used. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size # The token identifying which page of results to return. Set this to the - # next_page_token value returned from a previous query to obtain the - # following page of results. If not set, the first page of results will be - # returned. + # next_page_token value returned from a previous query to obtain the following + # page of results. If not set, the first page of results will be returned. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token @@ -1177,8 +1164,8 @@ module Google # @return [Array] attr_accessor :activities - # 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 diff --git a/generated/google/apis/firebase_v1beta1.rb b/generated/google/apis/firebase_v1beta1.rb index a3f65a768..b2e1d2a4b 100644 --- a/generated/google/apis/firebase_v1beta1.rb +++ b/generated/google/apis/firebase_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://firebase.google.com module FirebaseV1beta1 VERSION = 'V1beta1' - REVISION = '20200727' + 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/firebase_v1beta1/classes.rb b/generated/google/apis/firebase_v1beta1/classes.rb index f64010c31..43ce310a4 100644 --- a/generated/google/apis/firebase_v1beta1/classes.rb +++ b/generated/google/apis/firebase_v1beta1/classes.rb @@ -26,34 +26,29 @@ module Google class AddFirebaseRequest include Google::Apis::Core::Hashable - # Deprecated. Instead, to set a Project's default GCP resource location, - # call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) - # after you add Firebase resources to the GCP `Project`. - # The ID of the Project's default GCP resource location. The location - # must be one of the available [GCP resource + # Deprecated. Instead, to set a Project's default GCP resource location, call [` + # FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add + # Firebase resources to the GCP `Project`. The ID of the Project's default GCP + # resource location. The location must be one of the available [GCP resource # locations](https://firebase.google.com/docs/projects/locations). # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id - # Deprecated. Instead, to link a Project with a Google Analytics - # account, call - # [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) - # after you add Firebase resources to the GCP `Project`. - # The region code (CLDR) that the account will use for Google Analytics - # data - #
For example: US, GB, or DE - # In Java, use `com.google.i18n.identifiers.RegionCode`. + # Deprecated. Instead, to link a Project with a Google Analytics account, call [` + # AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) after you add + # Firebase resources to the GCP `Project`. The region code (CLDR) that the + # account will use for Google Analytics data For example: US, GB, or DE In Java, + # use `com.google.i18n.identifiers.RegionCode`. # Corresponds to the JSON property `regionCode` # @return [String] attr_accessor :region_code - # Deprecated. Instead, to link a Project with a Google Analytics - # account, call - # [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) - # after you add Firebase resources to the GCP `Project`. - # The time zone that the account will use for Google Analytics data. - #
For example: America/Los_Angeles or Africa/Abidjan + # Deprecated. Instead, to link a Project with a Google Analytics account, call [` + # AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) after you add + # Firebase resources to the GCP `Project`. The time zone that the account will + # use for Google Analytics data. For example: America/Los_Angeles or Africa/ + # Abidjan # Corresponds to the JSON property `timeZone` # @return [String] attr_accessor :time_zone @@ -74,18 +69,16 @@ module Google class AddGoogleAnalyticsRequest include Google::Apis::Core::Hashable - # The ID for the existing - # [Google Analytics account](http://www.google.com/analytics/) that you - # want to link with the `FirebaseProject`. - # Specifying this field will provision a new Google Analytics - # property in your Google Analytics account and associate the new property - # with the `FirebaseProject`. + # The ID for the existing [Google Analytics account](http://www.google.com/ + # analytics/) that you want to link with the `FirebaseProject`. Specifying this + # field will provision a new Google Analytics property in your Google Analytics + # account and associate the new property with the `FirebaseProject`. # Corresponds to the JSON property `analyticsAccountId` # @return [String] attr_accessor :analytics_account_id - # The ID for the existing Google Analytics property that you want to - # associate with the `FirebaseProject`. + # The ID for the existing Google Analytics property that you want to associate + # with the `FirebaseProject`. # Corresponds to the JSON property `analyticsPropertyId` # @return [String] attr_accessor :analytics_property_id @@ -110,22 +103,20 @@ module Google # @return [String] attr_accessor :database_url - # The ID of the Project's default GCP resource location. The location is one - # of the available - # [GCP resource - # locations](https://firebase.google.com/docs/projects/locations). - # This field is omitted if the default GCP resource location has not been - # finalized yet. To set a Project's default GCP resource location, - # call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) - # after you add Firebase resources to the Project. + # The ID of the Project's default GCP resource location. The location is one of + # the available [GCP resource locations](https://firebase.google.com/docs/ + # projects/locations). This field is omitted if the default GCP resource + # location has not been finalized yet. To set a Project's default GCP resource + # location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/ + # finalize) after you add Firebase resources to the Project. # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id - # Immutable. A user-assigned unique identifier for the `FirebaseProject`. - # This identifier may appear in URLs or names for some Firebase resources - # associated with the Project, but it should generally be treated as a - # convenience alias to reference the Project. + # Immutable. A user-assigned unique identifier for the `FirebaseProject`. This + # identifier may appear in URLs or names for some Firebase resources associated + # with the Project, but it should generally be treated as a convenience alias to + # reference the Project. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id @@ -157,13 +148,11 @@ module Google # @return [Google::Apis::FirebaseV1beta1::AnalyticsProperty] attr_accessor :analytics_property - #
    - #
  • For `AndroidApps` and `IosApps`: a map of `app` to `streamId` for each - # Firebase App in the specified `FirebaseProject`. Each `app` and - # `streamId` appears only once. - #
  • For `WebApps`: a map of `app` to `streamId` and `measurementId` for - # each `WebApp` in the specified `FirebaseProject`. Each `app`, `streamId`, - # and `measurementId` appears only once. + # - For `AndroidApps` and `IosApps`: a map of `app` to `streamId` for each + # Firebase App in the specified `FirebaseProject`. Each `app` and `streamId` + # appears only once. - For `WebApps`: a map of `app` to `streamId` and ` + # measurementId` for each `WebApp` in the specified `FirebaseProject`. Each `app` + # , `streamId`, and `measurementId` appears only once. # Corresponds to the JSON property `streamMappings` # @return [Array] attr_accessor :stream_mappings @@ -190,12 +179,11 @@ module Google attr_accessor :display_name # The globally unique, Google-assigned identifier of the Google Analytics - # property associated with the specified `FirebaseProject`. - # If you called - # [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) to link - # the `FirebaseProject` with a Google Analytics account, the value in this - # `id` field is the same as the ID of the property either specified or - # provisioned with that call to `AddGoogleAnalytics`. + # property associated with the specified `FirebaseProject`. If you called [` + # AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) to link the ` + # FirebaseProject` with a Google Analytics account, the value in this `id` field + # is the same as the ID of the property either specified or provisioned with + # that call to `AddGoogleAnalytics`. # Corresponds to the JSON property `id` # @return [String] attr_accessor :id @@ -215,9 +203,8 @@ module Google class AndroidApp include Google::Apis::Core::Hashable - # Immutable. The globally unique, Firebase-assigned identifier for the - # `AndroidApp`. - # This identifier should be treated as an opaque token, as the data + # Immutable. The globally unique, Firebase-assigned identifier for the ` + # AndroidApp`. This identifier should be treated as an opaque token, as the data # format is not specified. # Corresponds to the JSON property `appId` # @return [String] @@ -228,20 +215,15 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the AndroidApp, in the format: - # projects/PROJECT_IDENTIFIER/androidApps/APP_ID - # * PROJECT_IDENTIFIER: the parent Project's - # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) - # ***(recommended)*** - # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). - # Learn more about using project identifiers in - # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). - #
    Note that the value for PROJECT_IDENTIFIER in any - # response body will be the `ProjectId`. - # * APP_ID: the globally unique, Firebase-assigned identifier - # for the App - # (see [`appId`](../projects.androidApps#AndroidApp.FIELDS.app_id)). + # The resource name of the AndroidApp, in the format: projects/ + # PROJECT_IDENTIFIER/androidApps/APP_ID * PROJECT_IDENTIFIER: the parent Project' + # s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***( + # recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS. + # project_id). Learn more about using project identifiers in Google's [AIP 2510 + # standard](https://google.aip.dev/cloud/2510). Note that the value for + # PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the + # globally unique, Firebase-assigned identifier for the App (see [`appId`](../ + # projects.androidApps#AndroidApp.FIELDS.app_id)). # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -252,8 +234,8 @@ module Google # @return [String] attr_accessor :package_name - # Immutable. A user-assigned unique identifier of the parent - # FirebaseProject for the `AndroidApp`. + # Immutable. A user-assigned unique identifier of the parent FirebaseProject for + # the `AndroidApp`. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id @@ -282,9 +264,8 @@ module Google # @return [String] attr_accessor :config_file_contents - # The filename that the configuration artifact for the `AndroidApp` is - # typically saved as. - #
    For example: `google-services.json` + # The filename that the configuration artifact for the `AndroidApp` is typically + # saved as. For example: `google-services.json` # Corresponds to the JSON property `configFilename` # @return [String] attr_accessor :config_filename @@ -304,50 +285,41 @@ module Google class DefaultResources include Google::Apis::Core::Hashable - # The default Firebase Hosting site name, in the format: - # PROJECT_ID - # Though rare, your `projectId` might already be used as the name for an - # existing Hosting site in another project (learn more about creating - # non-default, - # [additional sites](https://firebase.google.com/docs/hosting/multisites)). - # In these cases, your `projectId` is appended with a hyphen then five - # alphanumeric characters to create your default Hosting site name. For - # example, if your `projectId` is `myproject123`, your default Hosting site - # name might be: - # `myproject123-a5c16` + # The default Firebase Hosting site name, in the format: PROJECT_ID Though rare, + # your `projectId` might already be used as the name for an existing Hosting + # site in another project (learn more about creating non-default, [additional + # sites](https://firebase.google.com/docs/hosting/multisites)). In these cases, + # your `projectId` is appended with a hyphen then five alphanumeric characters + # to create your default Hosting site name. For example, if your `projectId` is ` + # myproject123`, your default Hosting site name might be: `myproject123-a5c16` # Corresponds to the JSON property `hostingSite` # @return [String] attr_accessor :hosting_site - # The ID of the Project's default GCP resource location. The location is one - # of the available - # [GCP resource - # locations](https://firebase.google.com/docs/projects/locations). - # This field is omitted if the default GCP resource location has not been - # finalized yet. To set a Project's default GCP resource location, - # call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) - # after you add Firebase resources to the Project. + # The ID of the Project's default GCP resource location. The location is one of + # the available [GCP resource locations](https://firebase.google.com/docs/ + # projects/locations). This field is omitted if the default GCP resource + # location has not been finalized yet. To set a Project's default GCP resource + # location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/ + # finalize) after you add Firebase resources to the Project. # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id # The default Firebase Realtime Database instance name, in the format: - # PROJECT_ID - # Though rare, your `projectId` might already be used as the name for an - # existing Realtime Database instance in another project (learn more about - # [database - # sharding](https://firebase.google.com/docs/database/usage/sharding)). In - # these cases, your `projectId` is appended with a hyphen then five - # alphanumeric characters to create your default Realtime Database instance - # name. For example, if your `projectId` is `myproject123`, your default - # database instance name might be: - # `myproject123-a5c16` + # PROJECT_ID Though rare, your `projectId` might already be used as the name for + # an existing Realtime Database instance in another project (learn more about [ + # database sharding](https://firebase.google.com/docs/database/usage/sharding)). + # In these cases, your `projectId` is appended with a hyphen then five + # alphanumeric characters to create your default Realtime Database instance name. + # For example, if your `projectId` is `myproject123`, your default database + # instance name might be: `myproject123-a5c16` # Corresponds to the JSON property `realtimeDatabaseInstance` # @return [String] attr_accessor :realtime_database_instance # The default Cloud Storage for Firebase storage bucket, in the format: - # PROJECT_ID.appspot.com + # PROJECT_ID.appspot.com # Corresponds to the JSON property `storageBucket` # @return [String] attr_accessor :storage_bucket @@ -365,13 +337,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 @@ -389,8 +359,8 @@ module Google include Google::Apis::Core::Hashable # The ID of the Project's default GCP resource location. The location must be - # one of the available [GCP resource - # locations](https://firebase.google.com/docs/projects/locations). + # one of the available [GCP resource locations](https://firebase.google.com/docs/ + # projects/locations). # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id @@ -409,10 +379,9 @@ module Google class FirebaseAppInfo include Google::Apis::Core::Hashable - # Immutable. The globally unique, Firebase-assigned identifier for the - # `WebApp`. - # This identifier should be treated as an opaque token, as the data - # format is not specified. + # Immutable. The globally unique, Firebase-assigned identifier for the `WebApp`. + # This identifier should be treated as an opaque token, as the data format is + # not specified. # Corresponds to the JSON property `appId` # @return [String] attr_accessor :app_id @@ -422,12 +391,9 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the Firebase App, in the format: - # projects/PROJECT_ID/iosApps/APP_ID - # or - # projects/PROJECT_ID/androidApps/APP_ID - # or - # projects/PROJECT_ID/webApps/APP_ID + # The resource name of the Firebase App, in the format: projects/PROJECT_ID / + # iosApps/APP_ID or projects/PROJECT_ID/androidApps/APP_ID or projects/ + # PROJECT_ID/webApps/APP_ID # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -453,17 +419,13 @@ module Google # A `FirebaseProject` is the top-level Firebase entity. It is the container for # Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime # Database, Cloud Firestore, Cloud Storage buckets), and other Firebase and - # Google Cloud Platform (GCP) resources. - # You create a `FirebaseProject` by calling - # AddFirebase - # and specifying an *existing* - # [GCP - # `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/ - # projects). - # This adds Firebase resources to the existing GCP `Project`. - # Since a FirebaseProject is actually also a GCP `Project`, a - # `FirebaseProject` has the same underlying GCP identifiers (`projectNumber` - # and `projectId`). This allows for easy interop with Google APIs. + # Google Cloud Platform (GCP) resources. You create a `FirebaseProject` by + # calling AddFirebase and specifying an *existing* [GCP `Project`](https://cloud. + # google.com/resource-manager/reference/rest/v1/projects). This adds Firebase + # resources to the existing GCP `Project`. Since a FirebaseProject is actually + # also a GCP `Project`, a `FirebaseProject` has the same underlying GCP + # identifiers (`projectNumber` and `projectId`). This allows for easy interop + # with Google APIs. class FirebaseProject include Google::Apis::Core::Hashable @@ -472,32 +434,28 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the Project, in the format: - # projects/PROJECT_IDENTIFIER - # PROJECT_IDENTIFIER: the Project's - # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) - # ***(recommended)*** - # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). - #
    Learn more about using project identifiers in - # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). - #
    Note that the value for PROJECT_IDENTIFIER in any - # response body will be the `ProjectId`. + # The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER + # PROJECT_IDENTIFIER: the Project's [`ProjectNumber`](../projects# + # FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`] + # (../projects#FirebaseProject.FIELDS.project_id). Learn more about using + # project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/ + # cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body + # will be the `ProjectId`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Immutable. A user-assigned unique identifier for the Project. - # This identifier may appear in URLs or names for some Firebase resources - # associated with the Project, but it should generally be treated as a - # convenience alias to reference the Project. + # Immutable. A user-assigned unique identifier for the Project. This identifier + # may appear in URLs or names for some Firebase resources associated with the + # Project, but it should generally be treated as a convenience alias to + # reference the Project. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id - # Immutable. The globally unique, Google-assigned canonical identifier for - # the Project. - # Use this identifier when configuring integrations and/or - # making API calls to Firebase or third-party services. + # Immutable. The globally unique, Google-assigned canonical identifier for the + # Project. Use this identifier when configuring integrations and/or making API + # calls to Firebase or third-party services. # Corresponds to the JSON property `projectNumber` # @return [Fixnum] attr_accessor :project_number @@ -507,9 +465,8 @@ module Google # @return [Google::Apis::FirebaseV1beta1::DefaultResources] attr_accessor :resources - # Output only. The lifecycle state of the Project. - # Updates to the state must be performed via - # com.google.cloudresourcemanager.v1.Projects.DeleteProject and + # Output only. The lifecycle state of the Project. Updates to the state must be + # performed via com.google.cloudresourcemanager.v1.Projects.DeleteProject and # com.google.cloudresourcemanager.v1.Projects.UndeleteProject # Corresponds to the JSON property `state` # @return [String] @@ -534,16 +491,15 @@ module Google class IosApp include Google::Apis::Core::Hashable - # Immutable. The globally unique, Firebase-assigned identifier for the - # `IosApp`. - # This identifier should be treated as an opaque token, as the data - # format is not specified. + # Immutable. The globally unique, Firebase-assigned identifier for the `IosApp`. + # This identifier should be treated as an opaque token, as the data format is + # not specified. # Corresponds to the JSON property `appId` # @return [String] attr_accessor :app_id - # The automatically generated Apple ID assigned to the iOS app by Apple in - # the iOS App Store. + # The automatically generated Apple ID assigned to the iOS app by Apple in the + # iOS App Store. # Corresponds to the JSON property `appStoreId` # @return [String] attr_accessor :app_store_id @@ -559,24 +515,21 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the IosApp, in the format: - # projects/PROJECT_IDENTIFIER/iosApps/APP_ID - # * PROJECT_IDENTIFIER: the parent Project's - # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) - # ***(recommended)*** - # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). - # Learn more about using project identifiers in - # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). - #
    Note that the value for PROJECT_IDENTIFIER in any - # response body will be the `ProjectId`. - # * APP_ID: the globally unique, Firebase-assigned identifier - # for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)). + # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER / + # iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../ + # projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [` + # ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about + # using project identifiers in Google's [AIP 2510 standard](https://google.aip. + # dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response + # body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned + # identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id) + # ). # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Immutable. A user-assigned unique identifier of the parent - # FirebaseProject for the `IosApp`. + # Immutable. A user-assigned unique identifier of the parent FirebaseProject for + # the `IosApp`. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id @@ -607,8 +560,7 @@ module Google attr_accessor :config_file_contents # The filename that the configuration artifact for the `IosApp` is typically - # saved as. - #
    For example: `GoogleService-Info.plist` + # saved as. For example: `GoogleService-Info.plist` # Corresponds to the JSON property `configFilename` # @return [String] attr_accessor :config_filename @@ -633,12 +585,11 @@ module Google # @return [Array] attr_accessor :apps - # If the result list is too large to fit in a single response, then a token - # is returned. If the string is empty, then this response is the last page of - # results. - # This token can be used in a subsequent call to `ListAndroidApps` to - # find the next group of Apps. - # Page tokens are short-lived and should not be persisted. + # If the result list is too large to fit in a single response, then a token is + # returned. If the string is empty, then this response is the last page of + # results. This token can be used in a subsequent call to `ListAndroidApps` to + # find the next group of Apps. Page tokens are short-lived and should not be + # persisted. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -663,12 +614,11 @@ module Google # @return [Array] attr_accessor :locations - # If the result list is too large to fit in a single response, then a token - # is returned. If the string is empty, then this response is the last page of - # results and all available locations have been listed. - # This token can be used in a subsequent call to - # `ListAvailableLocations` to find more locations. - # Page tokens are short-lived and should not be persisted. + # If the result list is too large to fit in a single response, then a token is + # returned. If the string is empty, then this response is the last page of + # results and all available locations have been listed. This token can be used + # in a subsequent call to `ListAvailableLocations` to find more locations. Page + # tokens are short-lived and should not be persisted. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -688,12 +638,11 @@ module Google class ListAvailableProjectsResponse include Google::Apis::Core::Hashable - # If the result list is too large to fit in a single response, then a token - # is returned. If the string is empty, then this response is the last page of - # results. - # This token can be used in a subsequent calls to `ListAvailableProjects` - # to find the next group of Projects. - # Page tokens are short-lived and should not be persisted. + # If the result list is too large to fit in a single response, then a token is + # returned. If the string is empty, then this response is the last page of + # results. This token can be used in a subsequent calls to ` + # ListAvailableProjects` to find the next group of Projects. Page tokens are + # short-lived and should not be persisted. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -718,12 +667,11 @@ module Google class ListFirebaseProjectsResponse include Google::Apis::Core::Hashable - # If the result list is too large to fit in a single response, then a token - # is returned. If the string is empty, then this response is the last page of - # results. - # This token can be used in a subsequent calls to `ListFirebaseProjects` - # to find the next group of Projects. - # Page tokens are short-lived and should not be persisted. + # If the result list is too large to fit in a single response, then a token is + # returned. If the string is empty, then this response is the last page of + # results. This token can be used in a subsequent calls to `ListFirebaseProjects` + # to find the next group of Projects. Page tokens are short-lived and should + # not be persisted. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -753,12 +701,11 @@ module Google # @return [Array] attr_accessor :apps - # If the result list is too large to fit in a single response, then a token - # is returned. If the string is empty, then this response is the last page of - # results. - # This token can be used in a subsequent call to `ListIosApps` to find - # the next group of Apps. - # Page tokens are short-lived and should not be persisted. + # If the result list is too large to fit in a single response, then a token is + # returned. If the string is empty, then this response is the last page of + # results. This token can be used in a subsequent call to `ListIosApps` to find + # the next group of Apps. Page tokens are short-lived and should not be + # persisted. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -802,12 +749,11 @@ module Google # @return [Array] attr_accessor :apps - # If the result list is too large to fit in a single response, then a token - # is returned. If the string is empty, then this response is the last page of - # results. - # This token can be used in a subsequent call to `ListWebApps` to find - # the next group of Apps. - # Page tokens are short-lived and should not be persisted. + # If the result list is too large to fit in a single response, then a token is + # returned. If the string is empty, then this response is the last page of + # results. This token can be used in a subsequent call to `ListWebApps` to find + # the next group of Apps. Page tokens are short-lived and should not be + # persisted. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -833,16 +779,14 @@ module Google attr_accessor :features # The ID of the GCP resource location. It will be one of the available [GCP - # resource - # locations](https://firebase.google.com/docs/projects/locations#types). + # resource locations](https://firebase.google.com/docs/projects/locations#types). # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id - # Indicates whether the GCP resource location is a [regional or - # multi-regional - # location](https://firebase.google.com/docs/projects/locations#types) - # for data replication. + # Indicates whether the GCP resource location is a [regional or multi-regional + # location](https://firebase.google.com/docs/projects/locations#types) for data + # replication. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -877,47 +821,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::FirebaseV1beta1::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 @@ -945,25 +887,21 @@ module Google # @return [String] attr_accessor :display_name - # The ID of the Project's default GCP resource location. The location is one - # of the available - # [GCP resource - # locations](https://firebase.google.com/docs/projects/locations). - # Not all Projects will have this field populated. If it is not populated, it - # means that the Project does not yet have a default GCP resource location. - # To set a Project's default GCP resource location, call - # [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you - # add Firebase resources to the Project. + # The ID of the Project's default GCP resource location. The location is one of + # the available [GCP resource locations](https://firebase.google.com/docs/ + # projects/locations). Not all Projects will have this field populated. If it is + # not populated, it means that the Project does not yet have a default GCP + # resource location. To set a Project's default GCP resource location, call [` + # FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add + # Firebase resources to the Project. # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id # The resource name of the GCP `Project` to which Firebase resources can be - # added, in the format: - # projects/PROJECT_IDENTIFIER - # Refer to the `FirebaseProject` - # [`name`](../projects#FirebaseProject.FIELDS.name) field for details - # about PROJECT_IDENTIFIER values. + # added, in the format: projects/PROJECT_IDENTIFIER Refer to the ` + # FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for + # details about PROJECT_IDENTIFIER values. # Corresponds to the JSON property `project` # @return [String] attr_accessor :project @@ -985,16 +923,11 @@ module Google include Google::Apis::Core::Hashable # Optional. The ID of the Google Analytics property associated with the - # specified `FirebaseProject`. - #
      - #
    • If not set, then the Google Analytics property that is currently - # associated with the specified `FirebaseProject` is removed. - #
      • - #
    • If set, and the specified `FirebaseProject` is currently associated - # with a *different* Google Analytics property, then the response - # is a `412 Precondition Failed` error. - #
      • - #
    + # specified `FirebaseProject`. - If not set, then the Google Analytics property + # that is currently associated with the specified `FirebaseProject` is removed. - + # If set, and the specified `FirebaseProject` is currently associated with a * + # different* Google Analytics property, then the response is a `412 Precondition + # Failed` error. # Corresponds to the JSON property `analyticsPropertyId` # @return [String] attr_accessor :analytics_property_id @@ -1018,11 +951,10 @@ module Google # @return [Array] attr_accessor :apps - # If the result list is too large to fit in a single response, then a token - # is returned. - # This token can be used in a subsequent calls to `SearchFirebaseApps` - # to find the next group of Apps. - # Page tokens are short-lived and should not be persisted. + # If the result list is too large to fit in a single response, then a token is + # returned. This token can be used in a subsequent calls to `SearchFirebaseApps` + # to find the next group of Apps. Page tokens are short-lived and should not be + # persisted. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -1047,23 +979,17 @@ module Google # @return [String] attr_accessor :cert_type - # The resource name of the ShaCertificate for the AndroidApp, - # in the format: - # projects/PROJECT_IDENTIFIER/androidApps/APP_ID/sha/ - # SHA_HASH - # * PROJECT_IDENTIFIER: the parent Project's - # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) - # ***(recommended)*** - # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). - # Learn more about using project identifiers in - # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). - #
    Note that the value for PROJECT_IDENTIFIER in any - # response body will be the `ProjectId`. - # * APP_ID: the globally unique, Firebase-assigned identifier - # for the App - # (see [`appId`](../projects.androidApps#AndroidApp.FIELDS.app_id)). - # * SHA_HASH: the certificate hash for the App (see - # [`shaHash`](../projects.androidApps.sha#ShaCertificate.FIELDS.sha_hash)). + # The resource name of the ShaCertificate for the AndroidApp, in the format: + # projects/PROJECT_IDENTIFIER/androidApps/APP_ID/sha/SHA_HASH * + # PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects# + # FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`] + # (../projects#FirebaseProject.FIELDS.project_id). Learn more about using + # project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/ + # cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body + # will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned + # identifier for the App (see [`appId`](../projects.androidApps#AndroidApp. + # FIELDS.app_id)). * SHA_HASH: the certificate hash for the App (see [`shaHash`]( + # ../projects.androidApps.sha#ShaCertificate.FIELDS.sha_hash)). # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1085,12 +1011,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 @@ -1099,15 +1025,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 @@ -1128,8 +1054,8 @@ module Google class StatusProto include Google::Apis::Core::Hashable - # The canonical error code (see codes.proto) that most closely - # corresponds to this status. May be missing. + # The canonical error code (see codes.proto) that most closely corresponds to + # this status. May be missing. # Corresponds to the JSON property `canonicalCode` # @return [Fixnum] attr_accessor :canonical_code @@ -1150,23 +1076,19 @@ module Google # @return [Google::Apis::FirebaseV1beta1::MessageSet] attr_accessor :message_set - # Message that groups a protocol type_id (as defined by MessageSet), - # with an encoded message of that type. Its use is similar to - # MessageSet, except it represents a single (type, encoded message) - # instead of a set. - # To embed "proto" inside "typed_msg": - # MyProtoMessage proto; - # TypedMessage typed_msg; - # typed_msg.set_type_id(proto2::bridge::GetTypeId(proto)); - # proto.AppendToCord(typed_msg.mutable_message()); - # Error handling is omitted from the sample code above. GetTypeId() will return - # 0 for messages that don't have a TypeId specified. + # Message that groups a protocol type_id (as defined by MessageSet), with an + # encoded message of that type. Its use is similar to MessageSet, except it + # represents a single (type, encoded message) instead of a set. To embed "proto" + # inside "typed_msg": MyProtoMessage proto; TypedMessage typed_msg; typed_msg. + # set_type_id(proto2::bridge::GetTypeId(proto)); proto.AppendToCord(typed_msg. + # mutable_message()); Error handling is omitted from the sample code above. + # GetTypeId() will return 0 for messages that don't have a TypeId specified. # Corresponds to the JSON property `payload` # @return [Google::Apis::FirebaseV1beta1::TypedMessage] attr_accessor :payload - # The following are usually only present when code != 0 - # Space to which this status belongs + # The following are usually only present when code != 0 Space to which this + # status belongs # Corresponds to the JSON property `space` # @return [String] attr_accessor :space @@ -1190,37 +1112,28 @@ module Google class StreamMapping include Google::Apis::Core::Hashable - # The resource name of the Firebase App associated with the - # Google Analytics data stream, in the format: - # projects/PROJECT_IDENTIFIER/androidApps/APP_ID - # or - # projects/PROJECT_IDENTIFIER/iosApps/APP_ID - # or - # projects/PROJECT_IDENTIFIER/webApps/APP_ID - # Refer to the `FirebaseProject` - # [`name`](../projects#FirebaseProject.FIELDS.name) field for details - # about PROJECT_IDENTIFIER values. + # The resource name of the Firebase App associated with the Google Analytics + # data stream, in the format: projects/PROJECT_IDENTIFIER/androidApps/APP_ID or + # projects/PROJECT_IDENTIFIER/iosApps/APP_ID or projects/PROJECT_IDENTIFIER / + # webApps/APP_ID Refer to the `FirebaseProject` [`name`](../projects# + # FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. # Corresponds to the JSON property `app` # @return [String] attr_accessor :app - # Applicable for Firebase Web Apps only. - # The unique Google-assigned identifier of the Google Analytics web - # stream associated with the Firebase Web App. Firebase SDKs use this ID to - # interact with Google Analytics APIs. - # Learn more about this ID and Google Analytics web streams in the - # [Analytics - # documentation](https://support.google.com/analytics/topic/9303475). + # Applicable for Firebase Web Apps only. The unique Google-assigned identifier + # of the Google Analytics web stream associated with the Firebase Web App. + # Firebase SDKs use this ID to interact with Google Analytics APIs. Learn more + # about this ID and Google Analytics web streams in the [Analytics documentation] + # (https://support.google.com/analytics/topic/9303475). # Corresponds to the JSON property `measurementId` # @return [String] attr_accessor :measurement_id # The unique Google-assigned identifier of the Google Analytics data stream - # associated with the Firebase App. - # Learn more about Google Analytics data streams in the - # [Analytics - # documentation](https://support.google.com/analytics/answer/9303323). + # associated with the Firebase App. Learn more about Google Analytics data + # streams in the [Analytics documentation](https://support.google.com/analytics/ + # answer/9303323). # Corresponds to the JSON property `streamId` # @return [Fixnum] attr_accessor :stream_id @@ -1237,17 +1150,13 @@ module Google end end - # Message that groups a protocol type_id (as defined by MessageSet), - # with an encoded message of that type. Its use is similar to - # MessageSet, except it represents a single (type, encoded message) - # instead of a set. - # To embed "proto" inside "typed_msg": - # MyProtoMessage proto; - # TypedMessage typed_msg; - # typed_msg.set_type_id(proto2::bridge::GetTypeId(proto)); - # proto.AppendToCord(typed_msg.mutable_message()); - # Error handling is omitted from the sample code above. GetTypeId() will return - # 0 for messages that don't have a TypeId specified. + # Message that groups a protocol type_id (as defined by MessageSet), with an + # encoded message of that type. Its use is similar to MessageSet, except it + # represents a single (type, encoded message) instead of a set. To embed "proto" + # inside "typed_msg": MyProtoMessage proto; TypedMessage typed_msg; typed_msg. + # set_type_id(proto2::bridge::GetTypeId(proto)); proto.AppendToCord(typed_msg. + # mutable_message()); Error handling is omitted from the sample code above. + # GetTypeId() will return 0 for messages that don't have a TypeId specified. class TypedMessage include Google::Apis::Core::Hashable @@ -1277,10 +1186,9 @@ module Google class WebApp include Google::Apis::Core::Hashable - # Immutable. The globally unique, Firebase-assigned identifier for the - # `WebApp`. - # This identifier should be treated as an opaque token, as the data - # format is not specified. + # Immutable. The globally unique, Firebase-assigned identifier for the `WebApp`. + # This identifier should be treated as an opaque token, as the data format is + # not specified. # Corresponds to the JSON property `appId` # @return [String] attr_accessor :app_id @@ -1295,24 +1203,21 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the WebApp, in the format: - # projects/PROJECT_IDENTIFIER/webApps/APP_ID - # * PROJECT_IDENTIFIER: the parent Project's - # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) - # ***(recommended)*** - # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). - # Learn more about using project identifiers in - # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). - #
    Note that the value for PROJECT_IDENTIFIER in any - # response body will be the `ProjectId`. - # * APP_ID: the globally unique, Firebase-assigned identifier - # for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)). + # The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER / + # webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../ + # projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [` + # ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about + # using project identifiers in Google's [AIP 2510 standard](https://google.aip. + # dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response + # body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned + # identifier for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id) + # ). # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Immutable. A user-assigned unique identifier of the parent - # FirebaseProject for the `WebApp`. + # Immutable. A user-assigned unique identifier of the parent FirebaseProject for + # the `WebApp`. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id @@ -1340,14 +1245,13 @@ module Google # @return [String] attr_accessor :api_key - # Immutable. The globally unique, Firebase-assigned identifier for the - # `WebApp`. + # Immutable. The globally unique, Firebase-assigned identifier for the `WebApp`. # Corresponds to the JSON property `appId` # @return [String] attr_accessor :app_id # The domain Firebase Auth configures for OAuth redirects, in the format: - # PROJECT_ID.firebaseapp.com + # PROJECT_ID.firebaseapp.com # Corresponds to the JSON property `authDomain` # @return [String] attr_accessor :auth_domain @@ -1357,20 +1261,24 @@ module Google # @return [String] attr_accessor :database_url - # The ID of the Project's default GCP resource location. The location is one - # of the available - # [GCP resource - # locations](https://firebase.google.com/docs/projects/locations). - # This field is omitted if the default GCP resource location has not been - # finalized yet. To set a Project's default GCP resource location, - # call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) - # after you add Firebase resources to the Project. + # The ID of the Project's default GCP resource location. The location is one of + # the available [GCP resource locations](https://firebase.google.com/docs/ + # projects/locations). This field is omitted if the default GCP resource + # location has not been finalized yet. To set a Project's default GCP resource + # location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/ + # finalize) after you add Firebase resources to the Project. # Corresponds to the JSON property `locationId` # @return [String] attr_accessor :location_id - # This field will no longer be provided here. Instead, use - # `GetAnalyticsDetails` + # The unique Google-assigned identifier of the Google Analytics web stream + # associated with the Firebase Web App. Firebase SDKs use this ID to interact + # with Google Analytics APIs. This field is only present if the App is linked to + # a web stream in a Google Analytics App + Web property. Learn more about this + # ID and Google Analytics web streams in the [Analytics documentation](https:// + # support.google.com/analytics/topic/9303475). To generate a `measurementId` and + # link the Web App with a Google Analytics web stream, call [`AddGoogleAnalytics` + # ](../../v1beta1/projects/addGoogleAnalytics). # Corresponds to the JSON property `measurementId` # @return [String] attr_accessor :measurement_id diff --git a/generated/google/apis/firebase_v1beta1/service.rb b/generated/google/apis/firebase_v1beta1/service.rb index f53beefe9..cddb5397c 100644 --- a/generated/google/apis/firebase_v1beta1/service.rb +++ b/generated/google/apis/firebase_v1beta1/service.rb @@ -48,30 +48,21 @@ module Google @batch_path = 'batch' end - # Lists each [Google Cloud Platform (GCP) `Project`] - # (https://cloud.google.com/resource-manager/reference/rest/v1/projects) - # that can have Firebase resources added to it. - # A Project will only be listed if: - #
      - #
    • The caller has sufficient - # [Google IAM](https://cloud.google.com/iam) permissions to call - # AddFirebase. - #
      • - #
    • The Project is not already a FirebaseProject. - #
      • - #
    • The Project is not in an Organization which has policies - # that prevent Firebase resources from being added. - #
      • - #
    + # Lists each [Google Cloud Platform (GCP) `Project`] (https://cloud.google.com/ + # resource-manager/reference/rest/v1/projects) that can have Firebase resources + # added to it. A Project will only be listed if: - The caller has sufficient [ + # Google IAM](https://cloud.google.com/iam) permissions to call AddFirebase. - + # The Project is not already a FirebaseProject. - The Project is not in an + # Organization which has policies that prevent Firebase resources from being + # added. # @param [Fixnum] page_size - # The maximum number of Projects to return in the response. - # The server may return fewer than this value at its discretion. - # If no value is specified (or too large a value is specified), the server - # will impose its own limit. - # This value cannot be negative. + # The maximum number of Projects to return in the response. The server may + # return fewer than this value at its discretion. If no value is specified (or + # too large a value is specified), the server will impose its own limit. This + # value cannot be negative. # @param [String] page_token - # Token returned from a previous call to `ListAvailableProjects` - # indicating where in the set of Projects to resume listing. + # Token returned from a previous call to `ListAvailableProjects` indicating + # where in the set of Projects to resume listing. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -100,9 +91,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 @@ -132,46 +122,35 @@ module Google execute_or_queue_command(command, &block) end - # Adds Firebase resources to the specified existing - # [Google Cloud Platform (GCP) `Project`] - # (https://cloud.google.com/resource-manager/reference/rest/v1/projects). - # Since a FirebaseProject is actually also a GCP `Project`, a - # `FirebaseProject` has the same underlying GCP identifiers (`projectNumber` - # and `projectId`). This allows for easy interop with Google APIs. - # The result of this call is an [`Operation`](../../v1beta1/operations). - # Poll the `Operation` to track the provisioning process by calling - # GetOperation until - # [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When - # `done` is `true`, the `Operation` has either succeeded or failed. If the - # `Operation` succeeded, its - # [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to - # a FirebaseProject; if the `Operation` failed, its - # [`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a - # google.rpc.Status. The `Operation` is automatically deleted after - # completion, so there is no need to call - # DeleteOperation. - # This method does not modify any billing account information on the - # underlying GCP `Project`. - # To call `AddFirebase`, a project member or service account must have - # the following permissions (the IAM roles of Editor and Owner contain these - # permissions): - # `firebase.projects.update`, `resourcemanager.projects.get`, - # `serviceusage.services.enable`, and `serviceusage.services.get`. + # Adds Firebase resources to the specified existing [Google Cloud Platform (GCP) + # `Project`] (https://cloud.google.com/resource-manager/reference/rest/v1/ + # projects). Since a FirebaseProject is actually also a GCP `Project`, a ` + # FirebaseProject` has the same underlying GCP identifiers (`projectNumber` and ` + # projectId`). This allows for easy interop with Google APIs. The result of this + # call is an [`Operation`](../../v1beta1/operations). Poll the `Operation` to + # track the provisioning process by calling GetOperation until [`done`](../../ + # v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` is `true`, + # the `Operation` has either succeeded or failed. If the `Operation` succeeded, + # its [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to + # a FirebaseProject; if the `Operation` failed, its [`error`](../../v1beta1/ + # operations#Operation.FIELDS.error) is set to a google.rpc.Status. The ` + # Operation` is automatically deleted after completion, so there is no need to + # call DeleteOperation. This method does not modify any billing account + # information on the underlying GCP `Project`. To call `AddFirebase`, a project + # member or service account must have the following permissions (the IAM roles + # of Editor and Owner contain these permissions): `firebase.projects.update`, ` + # resourcemanager.projects.get`, `serviceusage.services.enable`, and ` + # serviceusage.services.get`. # @param [String] project # The resource name of the GCP `Project` to which Firebase resources will be - # added, in the format: - # projects/PROJECT_IDENTIFIER - # Refer to the `FirebaseProject` - # [`name`](../projects#FirebaseProject.FIELDS.name) field for details - # about PROJECT_IDENTIFIER values. - # After calling `AddFirebase`, the unique Project identifiers ( - # [`projectNumber`](https://cloud.google.com/resource-manager/reference/rest/v1/ - # projects#Project.FIELDS.project_number) - # and + # added, in the format: projects/PROJECT_IDENTIFIER Refer to the ` + # FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for + # details about PROJECT_IDENTIFIER values. After calling `AddFirebase`, the + # unique Project identifiers ( [`projectNumber`](https://cloud.google.com/ + # resource-manager/reference/rest/v1/projects#Project.FIELDS.project_number) and # [`projectId`](https://cloud.google.com/resource-manager/reference/rest/v1/ - # projects#Project.FIELDS.project_id)) - # of the underlying GCP `Project` are also the identifiers of the - # FirebaseProject. + # projects#Project.FIELDS.project_id)) of the underlying GCP `Project` are also + # the identifiers of the FirebaseProject. # @param [Google::Apis::FirebaseV1beta1::AddFirebaseRequest] add_firebase_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -202,61 +181,43 @@ module Google execute_or_queue_command(command, &block) end - # Links the specified FirebaseProject with an existing - # [Google Analytics account](http://www.google.com/analytics/). - # Using this call, you can either: - #
      - #
    • Specify an `analyticsAccountId` to provision a new Google Analytics - # property within the specified account and associate the new property with - # the `FirebaseProject`. - #
    • Specify an existing `analyticsPropertyId` to associate the property - # with the `FirebaseProject`. - #
    - # Note that when you call `AddGoogleAnalytics`: - #
      - #
    1. The first check determines if any existing data streams in the - # Google Analytics property correspond to any existing Firebase Apps in the - # `FirebaseProject` (based on the `packageName` or `bundleId` associated - # with the data stream). Then, as applicable, the data streams and apps are - # linked. Note that this auto-linking only applies to `AndroidApps` and - # `IosApps`. - #
    2. If no corresponding data streams are found for the Firebase Apps, new - # data streams are provisioned in the Google Analytics property for each of - # the Firebase Apps. Note that a new data stream is always provisioned for - # a Web App even if it was previously associated with a data stream in the - # Analytics property. - #
    - # Learn more about the hierarchy and structure of Google Analytics - # accounts in the - # [Analytics - # documentation](https://support.google.com/analytics/answer/9303323). - # The result of this call is an [`Operation`](../../v1beta1/operations). - # Poll the `Operation` to track the provisioning process by calling - # GetOperation until - # [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When - # `done` is `true`, the `Operation` has either succeeded or failed. If the - # `Operation` succeeded, its - # [`response`](../../v1beta1/operations#Operation.FIELDS.response) is set to - # an AnalyticsDetails; if the `Operation` failed, its - # [`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a - # google.rpc.Status. - # To call `AddGoogleAnalytics`, a project member must be an Owner for - # the existing `FirebaseProject` and have the - # [`Edit` permission](https://support.google.com/analytics/answer/2884495) - # for the Google Analytics account. - # If the `FirebaseProject` already has Google Analytics enabled, and you - # call `AddGoogleAnalytics` using an `analyticsPropertyId` that's different - # from the currently associated property, then the call will fail. Analytics - # may have already been enabled in the Firebase console or by specifying - # `timeZone` and `regionCode` in the call to - # [`AddFirebase`](../../v1beta1/projects/addFirebase). + # Links the specified FirebaseProject with an existing [Google Analytics account] + # (http://www.google.com/analytics/). Using this call, you can either: - Specify + # an `analyticsAccountId` to provision a new Google Analytics property within + # the specified account and associate the new property with the `FirebaseProject` + # . - Specify an existing `analyticsPropertyId` to associate the property with + # the `FirebaseProject`. Note that when you call `AddGoogleAnalytics`: 1. The + # first check determines if any existing data streams in the Google Analytics + # property correspond to any existing Firebase Apps in the `FirebaseProject` ( + # based on the `packageName` or `bundleId` associated with the data stream). + # Then, as applicable, the data streams and apps are linked. Note that this auto- + # linking only applies to `AndroidApps` and `IosApps`. 2. If no corresponding + # data streams are found for the Firebase Apps, new data streams are provisioned + # in the Google Analytics property for each of the Firebase Apps. Note that a + # new data stream is always provisioned for a Web App even if it was previously + # associated with a data stream in the Analytics property. Learn more about the + # hierarchy and structure of Google Analytics accounts in the [Analytics + # documentation](https://support.google.com/analytics/answer/9303323). The + # result of this call is an [`Operation`](../../v1beta1/operations). Poll the ` + # Operation` to track the provisioning process by calling GetOperation until [` + # done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When `done` + # is `true`, the `Operation` has either succeeded or failed. If the `Operation` + # succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) + # is set to an AnalyticsDetails; if the `Operation` failed, its [`error`](../../ + # v1beta1/operations#Operation.FIELDS.error) is set to a google.rpc.Status. To + # call `AddGoogleAnalytics`, a project member must be an Owner for the existing ` + # FirebaseProject` and have the [`Edit` permission](https://support.google.com/ + # analytics/answer/2884495) for the Google Analytics account. If the ` + # FirebaseProject` already has Google Analytics enabled, and you call ` + # AddGoogleAnalytics` using an `analyticsPropertyId` that's different from the + # currently associated property, then the call will fail. Analytics may have + # already been enabled in the Firebase console or by specifying `timeZone` and ` + # regionCode` in the call to [`AddFirebase`](../../v1beta1/projects/addFirebase). # @param [String] parent # The resource name of the FirebaseProject to link to an existing Google - # Analytics account, in the format: - # projects/PROJECT_IDENTIFIER - # Refer to the `FirebaseProject` - # [`name`](../projects#FirebaseProject.FIELDS.name) field for details - # about PROJECT_IDENTIFIER values. + # Analytics account, in the format: projects/PROJECT_IDENTIFIER Refer to the ` + # FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for + # details about PROJECT_IDENTIFIER values. # @param [Google::Apis::FirebaseV1beta1::AddGoogleAnalyticsRequest] add_google_analytics_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -289,11 +250,9 @@ module Google # Gets the specified FirebaseProject. # @param [String] name - # The resource name of the FirebaseProject, in the format: - # projects/PROJECT_IDENTIFIER - # Refer to the `FirebaseProject` - # [`name`](../projects#FirebaseProject.FIELDS.name) field for details - # about PROJECT_IDENTIFIER values. + # The resource name of the FirebaseProject, in the format: projects/ + # PROJECT_IDENTIFIER Refer to the `FirebaseProject` [`name`](../projects# + # FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -321,19 +280,15 @@ module Google execute_or_queue_command(command, &block) end - # Gets the configuration artifact associated with the specified - # FirebaseProject, which can be used by servers to simplify - # initialization. - # Typically, this configuration is used with the Firebase Admin SDK - # [initializeApp](https://firebase.google.com/docs/admin/setup# - # initialize_the_sdk) - # command. + # Gets the configuration artifact associated with the specified FirebaseProject, + # which can be used by servers to simplify initialization. Typically, this + # configuration is used with the Firebase Admin SDK [initializeApp](https:// + # firebase.google.com/docs/admin/setup#initialize_the_sdk) command. # @param [String] name - # The resource name of the FirebaseProject, in the format: - # projects/PROJECT_IDENTIFIER/adminSdkConfig - # Refer to the `FirebaseProject` - # [`name`](../projects#FirebaseProject.FIELDS.name) field for details - # about PROJECT_IDENTIFIER values. + # The resource name of the FirebaseProject, in the format: projects/ + # PROJECT_IDENTIFIER/adminSdkConfig Refer to the `FirebaseProject` [`name`](../ + # projects#FirebaseProject.FIELDS.name) field for details about + # PROJECT_IDENTIFIER values. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -362,15 +317,13 @@ module Google end # Gets the Google Analytics details currently associated with the specified - # FirebaseProject. - # If the `FirebaseProject` is not yet linked to Google Analytics, then - # the response to `GetAnalyticsDetails` is `NOT_FOUND`. + # FirebaseProject. If the `FirebaseProject` is not yet linked to Google + # Analytics, then the response to `GetAnalyticsDetails` is `NOT_FOUND`. # @param [String] name - # The resource name of the FirebaseProject, in the format: - # projects/PROJECT_IDENTIFIER/analyticsDetails - # Refer to the `FirebaseProject` - # [`name`](../projects#FirebaseProject.FIELDS.name) field for details - # about PROJECT_IDENTIFIER values. + # The resource name of the FirebaseProject, in the format: projects/ + # PROJECT_IDENTIFIER/analyticsDetails Refer to the `FirebaseProject` [`name`](../ + # projects#FirebaseProject.FIELDS.name) field for details about + # PROJECT_IDENTIFIER values. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -398,26 +351,22 @@ module Google execute_or_queue_command(command, &block) end - # Lists each FirebaseProject accessible to the caller. - # The elements are returned in no particular order, but they will be a - # consistent view of the Projects when additional requests are made with a - # `pageToken`. - # This method is eventually consistent with Project mutations, which - # means newly provisioned Projects and recent modifications to existing - # Projects might not be reflected in the set of Projects. The list will - # include only ACTIVE Projects. - # Use - # GetFirebaseProject - # for consistent reads as well as for additional Project details. + # Lists each FirebaseProject accessible to the caller. The elements are returned + # in no particular order, but they will be a consistent view of the Projects + # when additional requests are made with a `pageToken`. This method is + # eventually consistent with Project mutations, which means newly provisioned + # Projects and recent modifications to existing Projects might not be reflected + # in the set of Projects. The list will include only ACTIVE Projects. Use + # GetFirebaseProject for consistent reads as well as for additional Project + # details. # @param [Fixnum] page_size - # The maximum number of Projects to return in the response. - # The server may return fewer than this at its discretion. - # If no value is specified (or too large a value is specified), the server - # will impose its own limit. - # This value cannot be negative. + # The maximum number of Projects to return in the response. The server may + # return fewer than this at its discretion. If no value is specified (or too + # large a value is specified), the server will impose its own limit. This value + # cannot be negative. # @param [String] page_token - # Token returned from a previous call to `ListFirebaseProjects` indicating - # where in the set of Projects to resume listing. + # Token returned from a previous call to `ListFirebaseProjects` indicating where + # in the set of Projects to resume listing. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -446,24 +395,20 @@ module Google execute_or_queue_command(command, &block) end - # Updates the attributes of the specified FirebaseProject. - # All [query parameters](#query-parameters) are required. + # Updates the attributes of the specified FirebaseProject. All [query parameters] + # (#query-parameters) are required. # @param [String] name - # The resource name of the Project, in the format: - # projects/PROJECT_IDENTIFIER - # PROJECT_IDENTIFIER: the Project's - # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) - # ***(recommended)*** - # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). - #
    Learn more about using project identifiers in - # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). - #
    Note that the value for PROJECT_IDENTIFIER in any - # response body will be the `ProjectId`. + # The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER + # PROJECT_IDENTIFIER: the Project's [`ProjectNumber`](../projects# + # FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`] + # (../projects#FirebaseProject.FIELDS.project_id). Learn more about using + # project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/ + # cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body + # will be the `ProjectId`. # @param [Google::Apis::FirebaseV1beta1::FirebaseProject] firebase_project_object # @param [String] update_mask - # Specifies which fields to update. - # If this list is empty, then no state will be updated. - # Note that the fields `name`, `projectId`, and `projectNumber` are all + # Specifies which fields to update. If this list is empty, then no state will be + # updated. Note that the fields `name`, `projectId`, and `projectNumber` are all # immutable. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -495,27 +440,21 @@ module Google execute_or_queue_command(command, &block) end - # Unlinks the specified FirebaseProject from its Google Analytics - # account. - # This call removes the association of the specified `FirebaseProject` - # with its current Google Analytics property. However, this call does not - # delete the Google Analytics resources, such as the Google Analytics - # property or any data streams. - # These resources may be re-associated later to the `FirebaseProject` by - # calling - # [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) and - # specifying the same `analyticsPropertyId`. For Android Apps and iOS Apps, - # this call re-links data streams with their corresponding apps. However, - # for Web Apps, this call provisions a *new* data stream for each Web App. - # To call `RemoveAnalytics`, a project member must be an Owner for - # the `FirebaseProject`. + # Unlinks the specified FirebaseProject from its Google Analytics account. This + # call removes the association of the specified `FirebaseProject` with its + # current Google Analytics property. However, this call does not delete the + # Google Analytics resources, such as the Google Analytics property or any data + # streams. These resources may be re-associated later to the `FirebaseProject` + # by calling [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) + # and specifying the same `analyticsPropertyId`. For Android Apps and iOS Apps, + # this call re-links data streams with their corresponding apps. However, for + # Web Apps, this call provisions a *new* data stream for each Web App. To call ` + # RemoveAnalytics`, a project member must be an Owner for the `FirebaseProject`. # @param [String] parent - # The resource name of the FirebaseProject to unlink from its Google - # Analytics account, in the format: - # projects/PROJECT_IDENTIFIER - # Refer to the `FirebaseProject` - # [`name`](../projects#FirebaseProject.FIELDS.name) field for details - # about PROJECT_IDENTIFIER values. + # The resource name of the FirebaseProject to unlink from its Google Analytics + # account, in the format: projects/PROJECT_IDENTIFIER Refer to the ` + # FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for + # details about PROJECT_IDENTIFIER values. # @param [Google::Apis::FirebaseV1beta1::RemoveAnalyticsRequest] remove_analytics_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -546,25 +485,22 @@ module Google execute_or_queue_command(command, &block) end - # Lists all available Apps for the specified FirebaseProject. - # This is a convenience method. Typically, interaction with an App should - # be done using the platform-specific service, but some tool use-cases - # require a summary of all known Apps (such as for App selector interfaces). + # Lists all available Apps for the specified FirebaseProject. This is a + # convenience method. Typically, interaction with an App should be done using + # the platform-specific service, but some tool use-cases require a summary of + # all known Apps (such as for App selector interfaces). # @param [String] parent - # The parent FirebaseProject for which to list Apps, in the format: - # projects/PROJECT_IDENTIFIER - # Refer to the `FirebaseProject` - # [`name`](../projects#FirebaseProject.FIELDS.name) field for details - # about PROJECT_IDENTIFIER values. + # The parent FirebaseProject for which to list Apps, in the format: projects/ + # PROJECT_IDENTIFIER Refer to the `FirebaseProject` [`name`](../projects# + # FirebaseProject.FIELDS.name) field for details about PROJECT_IDENTIFIER values. # @param [Fixnum] page_size - # The maximum number of Apps to return in the response. - # The server may return fewer than this value at its discretion. - # If no value is specified (or too large a value is specified), then the - # server will impose its own limit. - # This value cannot be negative. + # The maximum number of Apps to return in the response. The server may return + # fewer than this value at its discretion. If no value is specified (or too + # large a value is specified), then the server will impose its own limit. This + # value cannot be negative. # @param [String] page_token - # Token returned from a previous call to `SearchFirebaseApps` indicating - # where in the set of Apps to resume listing. + # Token returned from a previous call to `SearchFirebaseApps` indicating where + # in the set of Apps to resume listing. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -594,18 +530,15 @@ module Google execute_or_queue_command(command, &block) end - # Requests the creation of a new AndroidApp in the specified - # FirebaseProject. - # The result of this call is an `Operation` which can be used to track - # the provisioning process. The `Operation` is automatically deleted after + # Requests the creation of a new AndroidApp in the specified FirebaseProject. + # The result of this call is an `Operation` which can be used to track the + # provisioning process. The `Operation` is automatically deleted after # completion, so there is no need to call `DeleteOperation`. # @param [String] parent # The resource name of the parent FirebaseProject in which to create an - # AndroidApp, in the format: - # projects/PROJECT_IDENTIFIER/androidApps - # Refer to the `FirebaseProject` - # [`name`](../projects#FirebaseProject.FIELDS.name) field for details - # about PROJECT_IDENTIFIER values. + # AndroidApp, in the format: projects/PROJECT_IDENTIFIER/androidApps Refer to + # the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field + # for details about PROJECT_IDENTIFIER values. # @param [Google::Apis::FirebaseV1beta1::AndroidApp] android_app_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -638,17 +571,12 @@ module Google # Gets the specified AndroidApp. # @param [String] name - # The resource name of the AndroidApp, in the format: - # projects/PROJECT_IDENTIFIER/androidApps/APP_ID - #
    - # Since an APP_ID is a unique identifier, the Unique Resource - # from Sub-Collection access pattern may be used here, in the format: - # projects/-/androidApps/APP_ID - #
    - # Refer to the `AndroidApp` - # [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details - # about PROJECT_IDENTIFIER and APP_ID values. + # The resource name of the AndroidApp, in the format: projects/ + # PROJECT_IDENTIFIER/androidApps/APP_ID Since an APP_ID is a unique identifier, + # the Unique Resource from Sub-Collection access pattern may be used here, in + # the format: projects/-/androidApps/APP_ID Refer to the `AndroidApp` [`name`](.. + # /projects.androidApps#AndroidApp.FIELDS.name) field for details about + # PROJECT_IDENTIFIER and APP_ID values. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -676,21 +604,14 @@ module Google execute_or_queue_command(command, &block) end - # Gets the configuration artifact associated with the specified - # AndroidApp. + # Gets the configuration artifact associated with the specified AndroidApp. # @param [String] name - # The resource name of the AndroidApp configuration to download, in the - # format: - # projects/PROJECT_IDENTIFIER/androidApps/APP_ID/ - # config - #
    - # Since an APP_ID is a unique identifier, the Unique Resource - # from Sub-Collection access pattern may be used here, in the format: - # projects/-/androidApps/APP_ID - #
    - # Refer to the `AndroidApp` - # [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details - # about PROJECT_IDENTIFIER and APP_ID values. + # The resource name of the AndroidApp configuration to download, in the format: + # projects/PROJECT_IDENTIFIER/androidApps/APP_ID/config Since an APP_ID is a + # unique identifier, the Unique Resource from Sub-Collection access pattern may + # be used here, in the format: projects/-/androidApps/APP_ID Refer to the ` + # AndroidApp` [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for + # details about PROJECT_IDENTIFIER and APP_ID values. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -718,26 +639,21 @@ module Google execute_or_queue_command(command, &block) end - # Lists each AndroidApp associated with the specified - # FirebaseProject. - # The elements are returned in no particular order, but will be a - # consistent view of the Apps when additional requests are made with a - # `pageToken`. + # Lists each AndroidApp associated with the specified FirebaseProject. The + # elements are returned in no particular order, but will be a consistent view of + # the Apps when additional requests are made with a `pageToken`. # @param [String] parent # The resource name of the parent FirebaseProject for which to list each - # associated AndroidApp, in the format: - # projects/PROJECT_IDENTIFIER/androidApps - # Refer to the `FirebaseProject` - # [`name`](../projects#FirebaseProject.FIELDS.name) field for details - # about PROJECT_IDENTIFIER values. + # associated AndroidApp, in the format: projects/PROJECT_IDENTIFIER /androidApps + # Refer to the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS. + # name) field for details about PROJECT_IDENTIFIER values. # @param [Fixnum] page_size - # The maximum number of Apps to return in the response. - # The server may return fewer than this at its discretion. - # If no value is specified (or too large a value is specified), then the - # server will impose its own limit. + # The maximum number of Apps to return in the response. The server may return + # fewer than this at its discretion. If no value is specified (or too large a + # value is specified), then the server will impose its own limit. # @param [String] page_token - # Token returned from a previous call to `ListAndroidApps` indicating where - # in the set of Apps to resume listing. + # Token returned from a previous call to `ListAndroidApps` indicating where in + # the set of Apps to resume listing. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -769,25 +685,19 @@ module Google # Updates the attributes of the specified AndroidApp. # @param [String] name - # The resource name of the AndroidApp, in the format: - # projects/PROJECT_IDENTIFIER/androidApps/APP_ID - # * PROJECT_IDENTIFIER: the parent Project's - # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) - # ***(recommended)*** - # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). - # Learn more about using project identifiers in - # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). - #
    Note that the value for PROJECT_IDENTIFIER in any - # response body will be the `ProjectId`. - # * APP_ID: the globally unique, Firebase-assigned identifier - # for the App - # (see [`appId`](../projects.androidApps#AndroidApp.FIELDS.app_id)). + # The resource name of the AndroidApp, in the format: projects/ + # PROJECT_IDENTIFIER/androidApps/APP_ID * PROJECT_IDENTIFIER: the parent Project' + # s [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***( + # recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS. + # project_id). Learn more about using project identifiers in Google's [AIP 2510 + # standard](https://google.aip.dev/cloud/2510). Note that the value for + # PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_ID: the + # globally unique, Firebase-assigned identifier for the App (see [`appId`](../ + # projects.androidApps#AndroidApp.FIELDS.app_id)). # @param [Google::Apis::FirebaseV1beta1::AndroidApp] android_app_object # @param [String] update_mask - # Specifies which fields to update. - # Note that the fields `name`, `app_id`, `project_id`, and `package_name` - # are all immutable. + # Specifies which fields to update. Note that the fields `name`, `app_id`, ` + # project_id`, and `package_name` are all immutable. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -820,18 +730,12 @@ module Google # Adds a ShaCertificate to the specified AndroidApp. # @param [String] parent - # The resource name of the parent AndroidApp to which to add a - # ShaCertificate, in the format: - # projects/PROJECT_IDENTIFIER/androidApps/APP_ID - #
    - # Since an APP_ID is a unique identifier, the Unique Resource - # from Sub-Collection access pattern may be used here, in the format: - # projects/-/androidApps/APP_ID - #
    - # Refer to the `AndroidApp` - # [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details - # about PROJECT_IDENTIFIER and APP_ID values. + # The resource name of the parent AndroidApp to which to add a ShaCertificate, + # in the format: projects/PROJECT_IDENTIFIER/androidApps/ APP_ID Since an APP_ID + # is a unique identifier, the Unique Resource from Sub-Collection access pattern + # may be used here, in the format: projects/-/androidApps/APP_ID Refer to the ` + # AndroidApp` [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for + # details about PROJECT_IDENTIFIER and APP_ID values. # @param [Google::Apis::FirebaseV1beta1::ShaCertificate] sha_certificate_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -864,17 +768,14 @@ module Google # Removes a ShaCertificate from the specified AndroidApp. # @param [String] name - # The resource name of the ShaCertificate to remove from the parent - # AndroidApp, in the format: - # projects/PROJECT_IDENTIFIER/androidApps/APP_ID/sha/ - # SHA_HASH - # Refer to the `ShaCertificate` - # [`name`](../projects.androidApps.sha#ShaCertificate.FIELDS.name) field for - # details about PROJECT_IDENTIFIER, APP_ID, and - # SHA_HASH values. - # You can obtain the full resource name of the `ShaCertificate` from the - # response of [`ListShaCertificates`](../projects.androidApps.sha/list) or - # the original [`CreateShaCertificate`](../projects.androidApps.sha/create). + # The resource name of the ShaCertificate to remove from the parent AndroidApp, + # in the format: projects/PROJECT_IDENTIFIER/androidApps/APP_ID /sha/SHA_HASH + # Refer to the `ShaCertificate` [`name`](../projects.androidApps.sha# + # ShaCertificate.FIELDS.name) field for details about PROJECT_IDENTIFIER, APP_ID, + # and SHA_HASH values. You can obtain the full resource name of the ` + # ShaCertificate` from the response of [`ListShaCertificates`](../projects. + # androidApps.sha/list) or the original [`CreateShaCertificate`](../projects. + # androidApps.sha/create). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -904,18 +805,13 @@ module Google # Lists the SHA-1 and SHA-256 certificates for the specified AndroidApp. # @param [String] parent - # The resource name of the parent AndroidApp for which to list each - # associated ShaCertificate, in the format: - # projects/PROJECT_IDENTIFIER/androidApps/APP_ID - #
    - # Since an APP_ID is a unique identifier, the Unique Resource - # from Sub-Collection access pattern may be used here, in the format: - # projects/-/androidApps/APP_ID - #
    - # Refer to the `AndroidApp` - # [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details - # about PROJECT_IDENTIFIER and APP_ID values. + # The resource name of the parent AndroidApp for which to list each associated + # ShaCertificate, in the format: projects/PROJECT_IDENTIFIER /androidApps/APP_ID + # Since an APP_ID is a unique identifier, the Unique Resource from Sub- + # Collection access pattern may be used here, in the format: projects/-/ + # androidApps/APP_ID Refer to the `AndroidApp` [`name`](../projects.androidApps# + # AndroidApp.FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID + # values. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -943,41 +839,32 @@ module Google execute_or_queue_command(command, &block) end - # Lists the valid Google Cloud Platform (GCP) resource locations for - # the specified Project (including a FirebaseProject). - # One of these locations can be selected as the Project's [_default_ GCP - # resource location](https://firebase.google.com/docs/projects/locations), - # which is the geographical location where the Project's resources, such as - # Cloud Firestore, will be provisioned by default. However, if the default - # GCP resource location has already been set for the Project, then this - # setting cannot be changed. - # This call checks for any possible - # [location - # restrictions](https://cloud.google.com/resource-manager/docs/organization- - # policy/defining-locations) - # for the specified Project and, thus, might return a subset of all possible - # GCP resource locations. To list all GCP resource locations (regardless of - # any restrictions), call the endpoint without specifying a unique project - # identifier (that is, - # `/v1beta1/`parent=projects/-`/listAvailableLocations`). - # To call `ListAvailableLocations` with a specified project, a member must be - # at minimum a Viewer of the Project. Calls without a specified project do - # not require any specific project permissions. + # Lists the valid Google Cloud Platform (GCP) resource locations for the + # specified Project (including a FirebaseProject). One of these locations can be + # selected as the Project's [_default_ GCP resource location](https://firebase. + # google.com/docs/projects/locations), which is the geographical location where + # the Project's resources, such as Cloud Firestore, will be provisioned by + # default. However, if the default GCP resource location has already been set + # for the Project, then this setting cannot be changed. This call checks for any + # possible [location restrictions](https://cloud.google.com/resource-manager/ + # docs/organization-policy/defining-locations) for the specified Project and, + # thus, might return a subset of all possible GCP resource locations. To list + # all GCP resource locations (regardless of any restrictions), call the endpoint + # without specifying a unique project identifier (that is, `/v1beta1/`parent= + # projects/-`/listAvailableLocations`). To call `ListAvailableLocations` with a + # specified project, a member must be at minimum a Viewer of the Project. Calls + # without a specified project do not require any specific project permissions. # @param [String] parent - # The FirebaseProject for which to list GCP resource locations, - # in the format: - # projects/PROJECT_IDENTIFIER - # Refer to the `FirebaseProject` - # [`name`](../projects#FirebaseProject.FIELDS.name) field for details - # about PROJECT_IDENTIFIER values. - # If no unique project identifier is specified (that is, `projects/-`), - # the returned list does not take into account org-specific or - # project-specific location restrictions. + # The FirebaseProject for which to list GCP resource locations, in the format: + # projects/PROJECT_IDENTIFIER Refer to the `FirebaseProject` [`name`](../ + # projects#FirebaseProject.FIELDS.name) field for details about + # PROJECT_IDENTIFIER values. If no unique project identifier is specified (that + # is, `projects/-`), the returned list does not take into account org-specific + # or project-specific location restrictions. # @param [Fixnum] page_size - # The maximum number of locations to return in the response. - # The server may return fewer than this value at its discretion. - # If no value is specified (or too large a value is specified), then the - # server will impose its own limit. + # The maximum number of locations to return in the response. The server may + # return fewer than this value at its discretion. If no value is specified (or + # too large a value is specified), then the server will impose its own limit. # This value cannot be negative. # @param [String] page_token # Token returned from a previous call to `ListAvailableLocations` indicating @@ -1012,47 +899,35 @@ module Google end # Sets the default Google Cloud Platform (GCP) resource location for the - # specified FirebaseProject. - # This method creates an App Engine application with a - # [default Cloud Storage - # bucket](https://cloud.google.com/appengine/docs/standard/python/ - # googlecloudstorageclient/setting-up-cloud-storage# - # activating_a_cloud_storage_bucket), - # located in the specified - # [`locationId`](#body.request_body.FIELDS.location_id). - # This location must be one of the available - # [GCP resource - # locations](https://firebase.google.com/docs/projects/locations). - # After the default GCP resource location is finalized, or if it was - # already set, it cannot be changed. The default GCP resource location for - # the specified `FirebaseProject` might already be set because either the - # underlying GCP `Project` already has an App Engine application or - # `FinalizeDefaultLocation` was previously called with a specified - # `locationId`. Any new calls to `FinalizeDefaultLocation` with a - # *different* specified `locationId` will return a 409 error. - # The result of this call is an [`Operation`](../../v1beta1/operations), - # which can be used to track the provisioning process. The - # [`response`](../../v1beta1/operations#Operation.FIELDS.response) type of - # the `Operation` is google.protobuf.Empty. - # The `Operation` can be polled by its `name` using - # GetOperation until `done` is - # true. When `done` is true, the `Operation` has either succeeded or failed. - # If the `Operation` has succeeded, its - # [`response`](../../v1beta1/operations#Operation.FIELDS.response) will be - # set to a google.protobuf.Empty; if the `Operation` has failed, its - # `error` will be set to a google.rpc.Status. The `Operation` is - # automatically deleted after completion, so there is no need to call - # DeleteOperation. - # All fields listed in the [request body](#request-body) are required. - # To call `FinalizeDefaultLocation`, a member must be an Owner - # of the Project. + # specified FirebaseProject. This method creates an App Engine application with + # a [default Cloud Storage bucket](https://cloud.google.com/appengine/docs/ + # standard/python/googlecloudstorageclient/setting-up-cloud-storage# + # activating_a_cloud_storage_bucket), located in the specified [`locationId`](# + # body.request_body.FIELDS.location_id). This location must be one of the + # available [GCP resource locations](https://firebase.google.com/docs/projects/ + # locations). After the default GCP resource location is finalized, or if it was + # already set, it cannot be changed. The default GCP resource location for the + # specified `FirebaseProject` might already be set because either the underlying + # GCP `Project` already has an App Engine application or ` + # FinalizeDefaultLocation` was previously called with a specified `locationId`. + # Any new calls to `FinalizeDefaultLocation` with a *different* specified ` + # locationId` will return a 409 error. The result of this call is an [`Operation` + # ](../../v1beta1/operations), which can be used to track the provisioning + # process. The [`response`](../../v1beta1/operations#Operation.FIELDS.response) + # type of the `Operation` is google.protobuf.Empty. The `Operation` can be + # polled by its `name` using GetOperation until `done` is true. When `done` is + # true, the `Operation` has either succeeded or failed. If the `Operation` has + # succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) + # will be set to a google.protobuf.Empty; if the `Operation` has failed, its ` + # error` will be set to a google.rpc.Status. The `Operation` is automatically + # deleted after completion, so there is no need to call DeleteOperation. All + # fields listed in the [request body](#request-body) are required. To call ` + # FinalizeDefaultLocation`, a member must be an Owner of the Project. # @param [String] parent - # The resource name of the FirebaseProject for which the default GCP - # resource location will be set, in the format: - # projects/PROJECT_IDENTIFIER - # Refer to the `FirebaseProject` - # [`name`](../projects#FirebaseProject.FIELDS.name) field for details - # about PROJECT_IDENTIFIER values. + # The resource name of the FirebaseProject for which the default GCP resource + # location will be set, in the format: projects/PROJECT_IDENTIFIER Refer to the ` + # FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for + # details about PROJECT_IDENTIFIER values. # @param [Google::Apis::FirebaseV1beta1::FinalizeDefaultLocationRequest] finalize_default_location_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1083,18 +958,15 @@ module Google execute_or_queue_command(command, &block) end - # Requests the creation of a new IosApp in the specified - # FirebaseProject. - # The result of this call is an `Operation` which can be used to track - # the provisioning process. The `Operation` is automatically deleted after + # Requests the creation of a new IosApp in the specified FirebaseProject. The + # result of this call is an `Operation` which can be used to track the + # provisioning process. The `Operation` is automatically deleted after # completion, so there is no need to call `DeleteOperation`. # @param [String] parent - # The resource name of the parent FirebaseProject in which to create an - # IosApp, in the format: - # projects/PROJECT_IDENTIFIER/iosApps - # Refer to the `FirebaseProject` - # [`name`](../projects#FirebaseProject.FIELDS.name) field for details - # about PROJECT_IDENTIFIER values. + # The resource name of the parent FirebaseProject in which to create an IosApp, + # in the format: projects/PROJECT_IDENTIFIER/iosApps Refer to the ` + # FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for + # details about PROJECT_IDENTIFIER values. # @param [Google::Apis::FirebaseV1beta1::IosApp] ios_app_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1127,16 +999,11 @@ module Google # Gets the specified IosApp. # @param [String] name - # The resource name of the IosApp, in the format: - # projects/PROJECT_IDENTIFIER/iosApps/APP_ID - #
    - # Since an APP_ID is a unique identifier, the Unique Resource - # from Sub-Collection access pattern may be used here, in the format: - # projects/-/iosApps/APP_ID - #
    - # Refer to the `IosApp` - # [`name`](../projects.iosApps#IosApp.FIELDS.name) field for details - # about PROJECT_IDENTIFIER and APP_ID values. + # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER / + # iosApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource + # from Sub-Collection access pattern may be used here, in the format: projects/-/ + # iosApps/APP_ID Refer to the `IosApp` [`name`](../projects.iosApps#IosApp. + # FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1167,16 +1034,11 @@ module Google # Gets the configuration artifact associated with the specified IosApp. # @param [String] name # The resource name of the App configuration to download, in the format: - # projects/PROJECT_IDENTIFIER/iosApps/APP_ID/config - #
    - # Since an APP_ID is a unique identifier, the Unique Resource - # from Sub-Collection access pattern may be used here, in the format: - # projects/-/iosApps/APP_ID - #
    - # Refer to the `IosApp` - # [`name`](../projects.iosApps#IosApp.FIELDS.name) field for details - # about PROJECT_IDENTIFIER and APP_ID values. + # projects/PROJECT_IDENTIFIER/iosApps/APP_ID/config Since an APP_ID is a unique + # identifier, the Unique Resource from Sub-Collection access pattern may be used + # here, in the format: projects/-/iosApps/APP_ID Refer to the `IosApp` [`name`](. + # ./projects.iosApps#IosApp.FIELDS.name) field for details about + # PROJECT_IDENTIFIER and APP_ID values. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1204,25 +1066,21 @@ module Google execute_or_queue_command(command, &block) end - # Lists each IosApp associated with the specified FirebaseProject. - # The elements are returned in no particular order, but will be a - # consistent view of the Apps when additional requests are made with a - # `pageToken`. + # Lists each IosApp associated with the specified FirebaseProject. The elements + # are returned in no particular order, but will be a consistent view of the Apps + # when additional requests are made with a `pageToken`. # @param [String] parent # The resource name of the parent FirebaseProject for which to list each - # associated IosApp, in the format: - # projects/PROJECT_IDENTIFIER/iosApps - # Refer to the `FirebaseProject` - # [`name`](../projects#FirebaseProject.FIELDS.name) field for details - # about PROJECT_IDENTIFIER values. + # associated IosApp, in the format: projects/PROJECT_IDENTIFIER/iosApps Refer to + # the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field + # for details about PROJECT_IDENTIFIER values. # @param [Fixnum] page_size - # The maximum number of Apps to return in the response. - # The server may return fewer than this at its discretion. - # If no value is specified (or too large a value is specified), the server - # will impose its own limit. + # The maximum number of Apps to return in the response. The server may return + # fewer than this at its discretion. If no value is specified (or too large a + # value is specified), the server will impose its own limit. # @param [String] page_token - # Token returned from a previous call to `ListIosApps` indicating where in - # the set of Apps to resume listing. + # Token returned from a previous call to `ListIosApps` indicating where in the + # set of Apps to resume listing. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1254,23 +1112,19 @@ module Google # Updates the attributes of the specified IosApp. # @param [String] name - # The resource name of the IosApp, in the format: - # projects/PROJECT_IDENTIFIER/iosApps/APP_ID - # * PROJECT_IDENTIFIER: the parent Project's - # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) - # ***(recommended)*** - # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). - # Learn more about using project identifiers in - # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). - #
    Note that the value for PROJECT_IDENTIFIER in any - # response body will be the `ProjectId`. - # * APP_ID: the globally unique, Firebase-assigned identifier - # for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)). + # The resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER / + # iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../ + # projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [` + # ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about + # using project identifiers in Google's [AIP 2510 standard](https://google.aip. + # dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response + # body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned + # identifier for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id) + # ). # @param [Google::Apis::FirebaseV1beta1::IosApp] ios_app_object # @param [String] update_mask - # Specifies which fields to update. - # Note that the fields `name`, `appId`, `projectId`, and `bundleId` - # are all immutable. + # Specifies which fields to update. Note that the fields `name`, `appId`, ` + # projectId`, and `bundleId` are all immutable. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1301,18 +1155,15 @@ module Google execute_or_queue_command(command, &block) end - # Requests the creation of a new WebApp in the specified - # FirebaseProject. - # The result of this call is an `Operation` which can be used to track - # the provisioning process. The `Operation` is automatically deleted after + # Requests the creation of a new WebApp in the specified FirebaseProject. The + # result of this call is an `Operation` which can be used to track the + # provisioning process. The `Operation` is automatically deleted after # completion, so there is no need to call `DeleteOperation`. # @param [String] parent - # The resource name of the parent FirebaseProject in which to create a - # WebApp, in the format: - # projects/PROJECT_IDENTIFIER/webApps - # Refer to the `FirebaseProject` - # [`name`](../projects#FirebaseProject.FIELDS.name) field for details - # about PROJECT_IDENTIFIER values. + # The resource name of the parent FirebaseProject in which to create a WebApp, + # in the format: projects/PROJECT_IDENTIFIER/webApps Refer to the ` + # FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field for + # details about PROJECT_IDENTIFIER values. # @param [Google::Apis::FirebaseV1beta1::WebApp] web_app_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1345,16 +1196,11 @@ module Google # Gets the specified WebApp. # @param [String] name - # The resource name of the WebApp, in the format: - # projects/PROJECT_IDENTIFIER/webApps/APP_ID - #
    - # Since an APP_ID is a unique identifier, the Unique Resource - # from Sub-Collection access pattern may be used here, in the format: - # projects/-/webApps/APP_ID - #
    - # Refer to the `WebApp` - # [`name`](../projects.webApps#WebApp.FIELDS.name) field for details - # about PROJECT_IDENTIFIER and APP_ID values. + # The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER / + # webApps/APP_ID Since an APP_ID is a unique identifier, the Unique Resource + # from Sub-Collection access pattern may be used here, in the format: projects/-/ + # webApps/APP_ID Refer to the `WebApp` [`name`](../projects.webApps#WebApp. + # FIELDS.name) field for details about PROJECT_IDENTIFIER and APP_ID values. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1384,18 +1230,12 @@ module Google # Gets the configuration artifact associated with the specified WebApp. # @param [String] name - # The resource name of the WebApp configuration to download, - # in the format: - # projects/PROJECT_IDENTIFIER/webApps/APP_ID/config - #
    - # Since an APP_ID is a unique identifier, the Unique Resource - # from Sub-Collection access pattern may be used here, in the format: - # projects/-/webApps/APP_ID - #
    - # Refer to the `WebApp` - # [`name`](../projects.webApps#WebApp.FIELDS.name) field for details - # about PROJECT_IDENTIFIER and APP_ID values. + # The resource name of the WebApp configuration to download, in the format: + # projects/PROJECT_IDENTIFIER/webApps/APP_ID/config Since an APP_ID is a unique + # identifier, the Unique Resource from Sub-Collection access pattern may be used + # here, in the format: projects/-/webApps/APP_ID Refer to the `WebApp` [`name`](. + # ./projects.webApps#WebApp.FIELDS.name) field for details about + # PROJECT_IDENTIFIER and APP_ID values. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1423,25 +1263,21 @@ module Google execute_or_queue_command(command, &block) end - # Lists each WebApp associated with the specified FirebaseProject. - # The elements are returned in no particular order, but will be a - # consistent view of the Apps when additional requests are made with a - # `pageToken`. + # Lists each WebApp associated with the specified FirebaseProject. The elements + # are returned in no particular order, but will be a consistent view of the Apps + # when additional requests are made with a `pageToken`. # @param [String] parent # The resource name of the parent FirebaseProject for which to list each - # associated WebApp, in the format: - # projects/PROJECT_IDENTIFIER/webApps - # Refer to the `FirebaseProject` - # [`name`](../projects#FirebaseProject.FIELDS.name) field for details - # about PROJECT_IDENTIFIER values. + # associated WebApp, in the format: projects/PROJECT_IDENTIFIER/webApps Refer to + # the `FirebaseProject` [`name`](../projects#FirebaseProject.FIELDS.name) field + # for details about PROJECT_IDENTIFIER values. # @param [Fixnum] page_size - # The maximum number of Apps to return in the response. - # The server may return fewer than this value at its discretion. - # If no value is specified (or too large a value is specified), then the - # server will impose its own limit. + # The maximum number of Apps to return in the response. The server may return + # fewer than this value at its discretion. If no value is specified (or too + # large a value is specified), then the server will impose its own limit. # @param [String] page_token - # Token returned from a previous call to `ListWebApps` indicating where in - # the set of Apps to resume listing. + # Token returned from a previous call to `ListWebApps` indicating where in the + # set of Apps to resume listing. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1473,22 +1309,19 @@ module Google # Updates the attributes of the specified WebApp. # @param [String] name - # The resource name of the WebApp, in the format: - # projects/PROJECT_IDENTIFIER/webApps/APP_ID - # * PROJECT_IDENTIFIER: the parent Project's - # [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) - # ***(recommended)*** - # or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). - # Learn more about using project identifiers in - # Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). - #
    Note that the value for PROJECT_IDENTIFIER in any - # response body will be the `ProjectId`. - # * APP_ID: the globally unique, Firebase-assigned identifier - # for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)). + # The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER / + # webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../ + # projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [` + # ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about + # using project identifiers in Google's [AIP 2510 standard](https://google.aip. + # dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response + # body will be the `ProjectId`. * APP_ID: the globally unique, Firebase-assigned + # identifier for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id) + # ). # @param [Google::Apis::FirebaseV1beta1::WebApp] web_app_object # @param [String] update_mask - # Specifies which fields to update. - # Note that the fields `name`, `appId`, and `projectId` are all immutable. + # Specifies which fields to update. Note that the fields `name`, `appId`, and ` + # projectId` are all immutable. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/firebasedynamiclinks_v1.rb b/generated/google/apis/firebasedynamiclinks_v1.rb index f321846a3..e3da07f4b 100644 --- a/generated/google/apis/firebasedynamiclinks_v1.rb +++ b/generated/google/apis/firebasedynamiclinks_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://firebase.google.com/docs/dynamic-links/ module FirebasedynamiclinksV1 VERSION = 'V1' - REVISION = '20200218' + REVISION = '20200803' # View and administer all your Firebase data and settings AUTH_FIREBASE = 'https://www.googleapis.com/auth/firebase' diff --git a/generated/google/apis/firebasedynamiclinks_v1/classes.rb b/generated/google/apis/firebasedynamiclinks_v1/classes.rb index 8e8587446..a48631594 100644 --- a/generated/google/apis/firebasedynamiclinks_v1/classes.rb +++ b/generated/google/apis/firebasedynamiclinks_v1/classes.rb @@ -26,10 +26,9 @@ module Google class AnalyticsInfo include Google::Apis::Core::Hashable - # Parameters for Google Play Campaign Measurements. - # [Learn - # more](https://developers.google.com/analytics/devguides/collection/android/v4/ - # campaigns#campaign-params) + # Parameters for Google Play Campaign Measurements. [Learn more](https:// + # developers.google.com/analytics/devguides/collection/android/v4/campaigns# + # campaign-params) # Corresponds to the JSON property `googlePlayAnalytics` # @return [Google::Apis::FirebasedynamiclinksV1::GooglePlayAnalytics] attr_accessor :google_play_analytics @@ -64,8 +63,8 @@ module Google # @return [String] attr_accessor :android_link - # Minimum version code for the Android app. If the installed app’s version - # code is lower, then the user is taken to the Play Store. + # Minimum version code for the Android app. If the installed app’s version code + # is lower, then the user is taken to the Play Store. # Corresponds to the JSON property `androidMinPackageVersionCode` # @return [String] attr_accessor :android_min_package_version_code @@ -97,19 +96,17 @@ module Google # @return [Google::Apis::FirebasedynamiclinksV1::DynamicLinkInfo] attr_accessor :dynamic_link_info - # Full long Dynamic Link URL with desired query parameters specified. - # For example, - # "https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample", - # [Learn - # more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener). + # Full long Dynamic Link URL with desired query parameters specified. For + # example, "https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample" + # , [Learn more](https://firebase.google.com/docs/reference/dynamic-links/link- + # shortener). # Corresponds to the JSON property `longDynamicLink` # @return [String] attr_accessor :long_dynamic_link # Link name to associate with the link. It's used for marketer to identify - # manually-created links in the Firebase console - # (https://console.firebase.google.com/). - # Links must be named to be tracked. + # manually-created links in the Firebase console (https://console.firebase. + # google.com/). Links must be named to be tracked. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -178,11 +175,10 @@ module Google # @return [Google::Apis::FirebasedynamiclinksV1::DynamicLinkInfo] attr_accessor :dynamic_link_info - # Full long Dynamic Link URL with desired query parameters specified. - # For example, - # "https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample", - # [Learn - # more](https://firebase.google.com/docs/reference/dynamic-links/link-shortener). + # Full long Dynamic Link URL with desired query parameters specified. For + # example, "https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample" + # , [Learn more](https://firebase.google.com/docs/reference/dynamic-links/link- + # shortener). # Corresponds to the JSON property `longDynamicLink` # @return [String] attr_accessor :long_dynamic_link @@ -274,16 +270,14 @@ module Google # @return [String] attr_accessor :language_code - # Device language code setting obtained by executing JavaScript code in - # WebView. + # Device language code setting obtained by executing JavaScript code in WebView. # Corresponds to the JSON property `languageCodeFromWebview` # @return [String] attr_accessor :language_code_from_webview - # Device language code raw setting. - # iOS does returns language code in different format than iOS WebView. - # For example WebView returns en_US, but iOS returns en-US. - # Field below will return raw value returned by iOS. + # Device language code raw setting. iOS does returns language code in different + # format than iOS WebView. For example WebView returns en_US, but iOS returns en- + # US. Field below will return raw value returned by iOS. # Corresponds to the JSON property `languageCodeRaw` # @return [String] attr_accessor :language_code_raw @@ -369,19 +363,18 @@ module Google # @return [Google::Apis::FirebasedynamiclinksV1::DesktopInfo] attr_accessor :desktop_info - # E.g. https://maps.app.goo.gl, https://maps.page.link, https://g.co/maps - # More examples can be found in description of getNormalizedUriPrefix in - # j/c/g/firebase/dynamiclinks/uri/DdlDomain.java - # Will fallback to dynamic_link_domain is this field is missing + # E.g. https://maps.app.goo.gl, https://maps.page.link, https://g.co/maps More + # examples can be found in description of getNormalizedUriPrefix in j/c/g/ + # firebase/dynamiclinks/uri/DdlDomain.java Will fallback to dynamic_link_domain + # is this field is missing # Corresponds to the JSON property `domainUriPrefix` # @return [String] attr_accessor :domain_uri_prefix - # Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl - # [Learn - # more](https://firebase.google.com/docs/dynamic-links/android/receive) on - # how to set up Dynamic Link domain associated with your Firebase project. - # Required if missing domain_uri_prefix. + # Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl [Learn more]( + # https://firebase.google.com/docs/dynamic-links/android/receive) on how to set + # up Dynamic Link domain associated with your Firebase project. Required if + # missing domain_uri_prefix. # Corresponds to the JSON property `dynamicLinkDomain` # @return [String] attr_accessor :dynamic_link_domain @@ -391,12 +384,10 @@ module Google # @return [Google::Apis::FirebasedynamiclinksV1::IosInfo] attr_accessor :ios_info - # The link your app will open, You can specify any URL your app can handle. - # This link must be a well-formatted URL, be properly URL-encoded, and use - # the HTTP or HTTPS scheme. See 'link' parameters in the - # [documentation](https://firebase.google.com/docs/dynamic-links/create-manually) - # . - # Required. + # The link your app will open, You can specify any URL your app can handle. This + # link must be a well-formatted URL, be properly URL-encoded, and use the HTTP + # or HTTPS scheme. See 'link' parameters in the [documentation](https://firebase. + # google.com/docs/dynamic-links/create-manually). Required. # Corresponds to the JSON property `link` # @return [String] attr_accessor :link @@ -406,8 +397,8 @@ module Google # @return [Google::Apis::FirebasedynamiclinksV1::NavigationInfo] attr_accessor :navigation_info - # Parameters for social meta tag params. - # Used to set meta tag data for link previews on social sites. + # Parameters for social meta tag params. Used to set meta tag data for link + # previews on social sites. # Corresponds to the JSON property `socialMetaTagInfo` # @return [Google::Apis::FirebasedynamiclinksV1::SocialMetaTagInfo] attr_accessor :social_meta_tag_info @@ -481,13 +472,13 @@ module Google end # Request for iSDK to execute strong match flow for post-install attribution. - # This is meant for iOS requests only. Requests from other platforms will - # not be honored. + # This is meant for iOS requests only. Requests from other platforms will not be + # honored. class GetIosPostInstallAttributionRequest include Google::Apis::Core::Hashable - # App installation epoch time (https://en.wikipedia.org/wiki/Unix_time). - # This is a client signal for a more accurate weak match. + # App installation epoch time (https://en.wikipedia.org/wiki/Unix_time). This is + # a client signal for a more accurate weak match. # Corresponds to the JSON property `appInstallationTime` # @return [Fixnum] attr_accessor :app_installation_time @@ -502,15 +493,13 @@ module Google # @return [Google::Apis::FirebasedynamiclinksV1::DeviceInfo] attr_accessor :device - # iOS version, ie: 9.3.5. - # Consider adding "build". + # iOS version, ie: 9.3.5. Consider adding "build". # Corresponds to the JSON property `iosVersion` # @return [String] attr_accessor :ios_version - # App post install attribution retrieval information. Disambiguates - # mechanism (iSDK or developer invoked) to retrieve payload from - # clicked link. + # App post install attribution retrieval information. Disambiguates mechanism ( + # iSDK or developer invoked) to retrieve payload from clicked link. # Corresponds to the JSON property `retrievalMethod` # @return [String] attr_accessor :retrieval_method @@ -521,14 +510,14 @@ module Google attr_accessor :sdk_version # Possible unique matched link that server need to check before performing - # fingerprint match. If passed link is short server need to expand the link. - # If link is long server need to vslidate the link. + # fingerprint match. If passed link is short server need to expand the link. If + # link is long server need to vslidate the link. # Corresponds to the JSON property `uniqueMatchLinkToCheck` # @return [String] attr_accessor :unique_match_link_to_check - # Strong match page information. Disambiguates between default UI and - # custom page to present when strong match succeeds/fails to find cookie. + # Strong match page information. Disambiguates between default UI and custom + # page to present when strong match succeeds/fails to find cookie. # Corresponds to the JSON property `visualStyle` # @return [String] attr_accessor :visual_style @@ -554,8 +543,8 @@ module Google class GetIosPostInstallAttributionResponse include Google::Apis::Core::Hashable - # The minimum version for app, specified by dev through ?imv= parameter. - # Return to iSDK to allow app to evaluate if current version meets this. + # The minimum version for app, specified by dev through ?imv= parameter. Return + # to iSDK to allow app to evaluate if current version meets this. # Corresponds to the JSON property `appMinimumVersion` # @return [String] attr_accessor :app_minimum_version @@ -565,46 +554,44 @@ module Google # @return [String] attr_accessor :attribution_confidence - # The deep-link attributed post-install via one of several techniques - # (fingerprint, copy unique). + # The deep-link attributed post-install via one of several techniques ( + # fingerprint, copy unique). # Corresponds to the JSON property `deepLink` # @return [String] attr_accessor :deep_link # User-agent specific custom-scheme URIs for iSDK to open. This will be set - # according to the user-agent tha the click was originally made in. There is - # no Safari-equivalent custom-scheme open URLs. - # ie: googlechrome://www.example.com - # ie: firefox://open-url?url=http://www.example.com - # ie: opera-http://example.com + # according to the user-agent tha the click was originally made in. There is no + # Safari-equivalent custom-scheme open URLs. ie: googlechrome://www.example.com + # ie: firefox://open-url?url=http://www.example.com ie: opera-http://example.com # Corresponds to the JSON property `externalBrowserDestinationLink` # @return [String] attr_accessor :external_browser_destination_link - # The link to navigate to update the app if min version is not met. - # This is either (in order): 1) fallback link (from ?ifl= parameter, if - # specified by developer) or 2) AppStore URL (from ?isi= parameter, if - # specified), or 3) the payload link (from required link= parameter). + # The link to navigate to update the app if min version is not met. This is + # either (in order): 1) fallback link (from ?ifl= parameter, if specified by + # developer) or 2) AppStore URL (from ?isi= parameter, if specified), or 3) the + # payload link (from required link= parameter). # Corresponds to the JSON property `fallbackLink` # @return [String] attr_accessor :fallback_link - # Invitation ID attributed post-install via one of several techniques - # (fingerprint, copy unique). + # Invitation ID attributed post-install via one of several techniques ( + # fingerprint, copy unique). # Corresponds to the JSON property `invitationId` # @return [String] attr_accessor :invitation_id - # Instruction for iSDK to attemmpt to perform strong match. For instance, - # if browser does not support/allow cookie or outside of support browsers, - # this will be false. + # Instruction for iSDK to attemmpt to perform strong match. For instance, if + # browser does not support/allow cookie or outside of support browsers, this + # will be false. # Corresponds to the JSON property `isStrongMatchExecutable` # @return [Boolean] attr_accessor :is_strong_match_executable alias_method :is_strong_match_executable?, :is_strong_match_executable - # Describes why match failed, ie: "discarded due to low confidence". - # This message will be publicly visible. + # Describes why match failed, ie: "discarded due to low confidence". This + # message will be publicly visible. # Corresponds to the JSON property `matchMessage` # @return [String] attr_accessor :match_message @@ -621,10 +608,10 @@ module Google attr_accessor :requested_link # The entire FDL, expanded from a short link. It is the same as the - # requested_link, if it is long. Parameters from this should not be - # used directly (ie: server can default utm_[campaign|medium|source] - # to a value when requested_link lack them, server determine the best - # fallback_link when requested_link specifies >1 fallback links). + # requested_link, if it is long. Parameters from this should not be used + # directly (ie: server can default utm_[campaign|medium|source] to a value when + # requested_link lack them, server determine the best fallback_link when + # requested_link specifies >1 fallback links). # Corresponds to the JSON property `resolvedLink` # @return [String] attr_accessor :resolved_link @@ -689,14 +676,9 @@ module Google # @return [String] attr_accessor :bundle_id - # FDL link to be verified from an app universal link open. - # The FDL link can be one of: - # 1) short FDL. - # e.g. .page.link/, or - # 2) long FDL. - # e.g. .page.link/?`query params`, or - # 3) Invite FDL. - # e.g. .page.link/i/ + # FDL link to be verified from an app universal link open. The FDL link can be + # one of: 1) short FDL. e.g. .page.link/, or 2) long FDL. e.g. .page.link/?` + # query params`, or 3) Invite FDL. e.g. .page.link/i/ # Corresponds to the JSON property `requestedLink` # @return [String] attr_accessor :requested_link @@ -723,8 +705,8 @@ module Google class GetIosReopenAttributionResponse include Google::Apis::Core::Hashable - # The deep-link attributed the app universal link open. For both regular - # FDL links and invite FDL links. + # The deep-link attributed the app universal link open. For both regular FDL + # links and invite FDL links. # Corresponds to the JSON property `deepLink` # @return [String] attr_accessor :deep_link @@ -734,8 +716,8 @@ module Google # @return [String] attr_accessor :invitation_id - # FDL input value of the "&imv=" parameter, minimum app version to be - # returned to Google Firebase SDK running on iOS-9. + # FDL input value of the "&imv=" parameter, minimum app version to be returned + # to Google Firebase SDK running on iOS-9. # Corresponds to the JSON property `iosMinAppVersion` # @return [String] attr_accessor :ios_min_app_version @@ -789,17 +771,15 @@ module Google end end - # Parameters for Google Play Campaign Measurements. - # [Learn - # more](https://developers.google.com/analytics/devguides/collection/android/v4/ - # campaigns#campaign-params) + # Parameters for Google Play Campaign Measurements. [Learn more](https:// + # developers.google.com/analytics/devguides/collection/android/v4/campaigns# + # campaign-params) class GooglePlayAnalytics include Google::Apis::Core::Hashable - # [AdWords autotagging - # parameter](https://support.google.com/analytics/answer/1033981?hl=en); used - # to measure Google AdWords ads. This value is generated dynamically and - # should never be modified. + # [AdWords autotagging parameter](https://support.google.com/analytics/answer/ + # 1033981?hl=en); used to measure Google AdWords ads. This value is generated + # dynamically and should never be modified. # Corresponds to the JSON property `gclid` # @return [String] attr_accessor :gclid @@ -821,8 +801,7 @@ module Google # @return [String] attr_accessor :utm_medium - # Campaign source; used to identify a search engine, newsletter, or other - # source. + # Campaign source; used to identify a search engine, newsletter, or other source. # Corresponds to the JSON property `utmSource` # @return [String] attr_accessor :utm_source @@ -856,8 +835,8 @@ module Google # @return [String] attr_accessor :at - # Campaign text that developers can optionally add to any link in order to - # track sales from a specific marketing campaign. + # Campaign text that developers can optionally add to any link in order to track + # sales from a specific marketing campaign. # Corresponds to the JSON property `ct` # @return [String] attr_accessor :ct @@ -900,9 +879,8 @@ module Google # @return [String] attr_accessor :ios_bundle_id - # Custom (destination) scheme to use for iOS. By default, we’ll use the - # bundle ID as the custom scheme. Developer can override this behavior using - # this param. + # Custom (destination) scheme to use for iOS. By default, we’ll use the bundle + # ID as the custom scheme. Developer can override this behavior using this param. # Corresponds to the JSON property `iosCustomScheme` # @return [String] attr_accessor :ios_custom_scheme @@ -968,8 +946,7 @@ module Google # @return [String] attr_accessor :link - # Link name defined by the creator. - # Required. + # Link name defined by the creator. Required. # Corresponds to the JSON property `linkName` # @return [String] attr_accessor :link_name @@ -998,8 +975,8 @@ module Google class NavigationInfo include Google::Apis::Core::Hashable - # If this option is on, FDL click will be forced to redirect rather than - # show an interstitial page. + # If this option is on, FDL click will be forced to redirect rather than show an + # interstitial page. # Corresponds to the JSON property `enableForcedRedirect` # @return [Boolean] attr_accessor :enable_forced_redirect @@ -1015,8 +992,8 @@ module Google end end - # Parameters for social meta tag params. - # Used to set meta tag data for link previews on social sites. + # Parameters for social meta tag params. Used to set meta tag data for link + # previews on social sites. class SocialMetaTagInfo include Google::Apis::Core::Hashable diff --git a/generated/google/apis/firebasedynamiclinks_v1/service.rb b/generated/google/apis/firebasedynamiclinks_v1/service.rb index 3b800c09b..7a0c898fd 100644 --- a/generated/google/apis/firebasedynamiclinks_v1/service.rb +++ b/generated/google/apis/firebasedynamiclinks_v1/service.rb @@ -47,17 +47,15 @@ module Google @batch_path = 'batch' end - # Creates a managed short Dynamic Link given either a valid long Dynamic Link - # or details such as Dynamic Link domain, Android and iOS app information. - # The created short Dynamic Link will not expire. - # This differs from CreateShortDynamicLink in the following ways: - # - The request will also contain a name for the link (non unique name - # for the front end). - # - The response must be authenticated with an auth token (generated with - # the admin service account). - # - The link will appear in the FDL list of links in the console front end. - # The Dynamic Link domain in the request must be owned by requester's - # Firebase project. + # Creates a managed short Dynamic Link given either a valid long Dynamic Link or + # details such as Dynamic Link domain, Android and iOS app information. The + # created short Dynamic Link will not expire. This differs from + # CreateShortDynamicLink in the following ways: - The request will also contain + # a name for the link (non unique name for the front end). - The response must + # be authenticated with an auth token (generated with the admin service account). + # - The link will appear in the FDL list of links in the console front end. The + # Dynamic Link domain in the request must be owned by requester's Firebase + # project. # @param [Google::Apis::FirebasedynamiclinksV1::CreateManagedShortLinkRequest] create_managed_short_link_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -87,13 +85,12 @@ module Google execute_or_queue_command(command, &block) end - # Creates a short Dynamic Link given either a valid long Dynamic Link or - # details such as Dynamic Link domain, Android and iOS app information. - # The created short Dynamic Link will not expire. - # Repeated calls with the same long Dynamic Link or Dynamic Link information - # will produce the same short Dynamic Link. - # The Dynamic Link domain in the request must be owned by requester's - # Firebase project. + # Creates a short Dynamic Link given either a valid long Dynamic Link or details + # such as Dynamic Link domain, Android and iOS app information. The created + # short Dynamic Link will not expire. Repeated calls with the same long Dynamic + # Link or Dynamic Link information will produce the same short Dynamic Link. The + # Dynamic Link domain in the request must be owned by requester's Firebase + # project. # @param [Google::Apis::FirebasedynamiclinksV1::CreateShortDynamicLinkRequest] create_short_dynamic_link_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -123,9 +120,9 @@ module Google execute_or_queue_command(command, &block) end - # Fetches analytics stats of a short Dynamic Link for a given - # duration. Metrics include number of clicks, redirects, installs, - # app first opens, and app reopens. + # Fetches analytics stats of a short Dynamic Link for a given duration. Metrics + # include number of clicks, redirects, installs, app first opens, and app + # reopens. # @param [String] dynamic_link # Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz # @param [Fixnum] duration_days diff --git a/generated/google/apis/firebaseml_v1.rb b/generated/google/apis/firebaseml_v1.rb index f93f7fe71..31e4b2faa 100644 --- a/generated/google/apis/firebaseml_v1.rb +++ b/generated/google/apis/firebaseml_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://firebase.google.com module FirebasemlV1 VERSION = 'V1' - REVISION = '20200519' + 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/firebaseml_v1/classes.rb b/generated/google/apis/firebaseml_v1/classes.rb index 34dea06a9..f2a53b0d0 100644 --- a/generated/google/apis/firebaseml_v1/classes.rb +++ b/generated/google/apis/firebaseml_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 @@ -79,8 +77,7 @@ module Google end end - # This is returned in the longrunning operations - # for create/update. + # This is returned in the longrunning operations for create/update. class ModelOperationMetadata include Google::Apis::Core::Hashable @@ -89,8 +86,8 @@ module Google # @return [String] attr_accessor :basic_operation_status - # The name of the model we are creating/updating - # The name must have the form `projects/`project_id`/models/`model_id`` + # The name of the model we are creating/updating The name must have the form ` + # projects/`project_id`/models/`model_id`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -111,47 +108,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::FirebasemlV1::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 @@ -170,12 +165,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 @@ -184,15 +179,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/firebaseml_v1/service.rb b/generated/google/apis/firebaseml_v1/service.rb index ea5037eb7..176a371dd 100644 --- a/generated/google/apis/firebaseml_v1/service.rb +++ b/generated/google/apis/firebaseml_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,15 +120,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/firebaseml_v1beta2.rb b/generated/google/apis/firebaseml_v1beta2.rb index 7ff12f028..c58b88a13 100644 --- a/generated/google/apis/firebaseml_v1beta2.rb +++ b/generated/google/apis/firebaseml_v1beta2.rb @@ -25,7 +25,7 @@ module Google # @see https://firebase.google.com module FirebasemlV1beta2 VERSION = 'V1beta2' - REVISION = '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/firebaseml_v1beta2/classes.rb b/generated/google/apis/firebaseml_v1beta2/classes.rb index 2072671d6..ad62ce15b 100644 --- a/generated/google/apis/firebaseml_v1beta2/classes.rb +++ b/generated/google/apis/firebaseml_v1beta2/classes.rb @@ -22,13 +22,11 @@ module Google module Apis module FirebasemlV1beta2 - # 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 @@ -50,8 +48,8 @@ module Google # @return [Array] attr_accessor :models - # 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 @@ -83,15 +81,13 @@ module Google attr_accessor :create_time # Required. The name of the model to create. The name can be up to 32 characters - # long - # and can consist only of ASCII Latin letters A-Z and a-z, underscores(_) + # long and can consist only of ASCII Latin letters A-Z and a-z, underscores(_) # and ASCII digits 0-9. It must start with a letter. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Output only. See RFC7232 - # https://tools.ietf.org/html/rfc7232#section-2.3 + # Output only. See RFC7232 https://tools.ietf.org/html/rfc7232#section-2.3 # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag @@ -102,15 +98,14 @@ module Google # @return [String] attr_accessor :model_hash - # The resource name of the Model. - # Model names have the form `projects/`project_id`/models/`model_id`` - # The name is ignored when creating a model. + # The resource name of the Model. Model names have the form `projects/` + # project_id`/models/`model_id`` The name is ignored when creating a model. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # State common to all model types. - # Includes publishing and validation information. + # State common to all model types. Includes publishing and validation + # information. # Corresponds to the JSON property `state` # @return [Google::Apis::FirebasemlV1beta2::ModelState] attr_accessor :state @@ -149,8 +144,7 @@ module Google end end - # This is returned in the longrunning operations - # for create/update. + # This is returned in the longrunning operations for create/update. class ModelOperationMetadata include Google::Apis::Core::Hashable @@ -159,8 +153,8 @@ module Google # @return [String] attr_accessor :basic_operation_status - # The name of the model we are creating/updating - # The name must have the form `projects/`project_id`/models/`model_id`` + # The name of the model we are creating/updating The name must have the form ` + # projects/`project_id`/models/`model_id`` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -176,8 +170,8 @@ module Google end end - # State common to all model types. - # Includes publishing and validation information. + # State common to all model types. Includes publishing and validation + # information. class ModelState include Google::Apis::Core::Hashable @@ -187,12 +181,12 @@ module Google attr_accessor :published alias_method :published?, :published - # 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 `validationError` # @return [Google::Apis::FirebasemlV1beta2::Status] attr_accessor :validation_error @@ -213,47 +207,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::FirebasemlV1beta2::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 @@ -272,12 +264,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 @@ -286,15 +278,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 @@ -315,18 +307,16 @@ module Google class TfLiteModel include Google::Apis::Core::Hashable - # The TfLite file containing the model. (Stored in Google Cloud). - # The gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite - # Note: If you update the file in the original location, it is - # necessary to call UpdateModel for ML to pick up and validate the - # updated file. + # The TfLite file containing the model. (Stored in Google Cloud). The + # gcs_tflite_uri should have form: gs://some-bucket/some-model.tflite Note: If + # you update the file in the original location, it is necessary to call + # UpdateModel for ML to pick up and validate the updated file. # Corresponds to the JSON property `gcsTfliteUri` # @return [String] attr_accessor :gcs_tflite_uri # Output only. A boolean indicating that this model was uploaded from the - # console. - # Read only + # console. Read only # Corresponds to the JSON property `managedUpload` # @return [Boolean] attr_accessor :managed_upload diff --git a/generated/google/apis/firebaseml_v1beta2/service.rb b/generated/google/apis/firebaseml_v1beta2/service.rb index 91cbd8f3b..25735f8b2 100644 --- a/generated/google/apis/firebaseml_v1beta2/service.rb +++ b/generated/google/apis/firebaseml_v1beta2/service.rb @@ -47,11 +47,11 @@ module Google @batch_path = 'batch' end - # Creates a model in Firebase ML. - # The longrunning operation will eventually return a Model + # Creates a model in Firebase ML. The longrunning operation will eventually + # return a Model # @param [String] parent - # Required. The parent project resource where the model is to be created. - # The parent must have the form `projects/`project_id`` + # Required. The parent project resource where the model is to be created. The + # parent must have the form `projects/`project_id`` # @param [Google::Apis::FirebasemlV1beta2::Model] model_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -84,8 +84,8 @@ module Google # Deletes a model # @param [String] name - # Required. The name of the model to delete. - # The name must have the form `projects/`project_id`/models/`model_id`` + # Required. The name of the model to delete. The name must have the form ` + # projects/`project_id`/models/`model_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -115,8 +115,8 @@ module Google # Gets a model resource. # @param [String] name - # Required. The name of the model to get. - # The name must have the form `projects/`project_id`/models/`model_id`` + # Required. The name of the model to get. The name must have the form `projects/` + # project_id`/models/`model_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -146,11 +146,11 @@ module Google # Lists the models # @param [String] parent - # Required. The name of the parent to list models for. - # The parent must have the form `projects/`project_id`' + # Required. The name of the parent to list models for. The parent must have the + # form `projects/`project_id`' # @param [String] filter - # A filter for the list - # e.g. 'tags: abc' to list models which are tagged with "abc" + # A filter for the list e.g. 'tags: abc' to list models which are tagged with " + # abc" # @param [Fixnum] page_size # The maximum number of items to return # @param [String] page_token @@ -187,9 +187,8 @@ module Google # Updates a model. The longrunning operation will eventually return a Model. # @param [String] name - # The resource name of the Model. - # Model names have the form `projects/`project_id`/models/`model_id`` - # The name is ignored when creating a model. + # The resource name of the Model. Model names have the form `projects/` + # project_id`/models/`model_id`` The name is ignored when creating a model. # @param [Google::Apis::FirebasemlV1beta2::Model] model_object # @param [String] update_mask # The update mask @@ -223,9 +222,8 @@ module Google execute_or_queue_command(command, &block) end - # Gets the latest state of a long-running operation. Clients can use this - # method to poll the operation result at intervals as recommended by the API - # service. + # Gets the latest state of a long-running operation. Clients can use this method + # to poll the operation result at intervals as recommended by the API service. # @param [String] name # The name of the operation resource. # @param [String] fields diff --git a/generated/google/apis/gameservices_v1.rb b/generated/google/apis/gameservices_v1.rb index cc6838df5..195103fab 100644 --- a/generated/google/apis/gameservices_v1.rb +++ b/generated/google/apis/gameservices_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/solutions/gaming/ module GameservicesV1 VERSION = 'V1' - REVISION = '20200721' + 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/gameservices_v1beta.rb b/generated/google/apis/gameservices_v1beta.rb index 5e0d586b8..b97cf3f55 100644 --- a/generated/google/apis/gameservices_v1beta.rb +++ b/generated/google/apis/gameservices_v1beta.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/solutions/gaming/ module GameservicesV1beta VERSION = 'V1beta' - REVISION = '20200721' + 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/gmail_v1.rb b/generated/google/apis/gmail_v1.rb index ef0f5ec3d..09b2eec36 100644 --- a/generated/google/apis/gmail_v1.rb +++ b/generated/google/apis/gmail_v1.rb @@ -20,13 +20,13 @@ module Google module Apis # Gmail API # - # The Gmail API lets you view and manage Gmail mailbox data like - # threads, messages, and labels. + # The Gmail API lets you view and manage Gmail mailbox data like threads, + # messages, and labels. # # @see https://developers.google.com/gmail/api/ module GmailV1 VERSION = 'V1' - REVISION = '20200720' + REVISION = '20200803' # Read, compose, send, and permanently delete all your email from Gmail AUTH_SCOPE = 'https://mail.google.com/' diff --git a/generated/google/apis/gmail_v1/classes.rb b/generated/google/apis/gmail_v1/classes.rb index 35f6105e3..c4fb73f60 100644 --- a/generated/google/apis/gmail_v1/classes.rb +++ b/generated/google/apis/gmail_v1/classes.rb @@ -31,8 +31,8 @@ module Google # @return [String] attr_accessor :disposition - # Email address to which all incoming messages are forwarded. This email - # address must be a verified member of the forwarding addresses. + # Email address to which all incoming messages are forwarded. This email address + # must be a verified member of the forwarding addresses. # Corresponds to the JSON property `emailAddress` # @return [String] attr_accessor :email_address @@ -83,8 +83,7 @@ module Google # @return [Array] attr_accessor :add_label_ids - # The IDs of the messages to modify. There is a limit of 1000 ids per - # request. + # The IDs of the messages to modify. There is a limit of 1000 ids per request. # Corresponds to the JSON property `ids` # @return [Array] attr_accessor :ids @@ -107,9 +106,8 @@ module Google end # Settings for a delegate. Delegates can read, send, and delete messages, as - # well as view and add contacts, for the delegator's account. See - # "Set up - # mail delegation" for more information about delegates. + # well as view and add contacts, for the delegator's account. See "Set up mail + # delegation" for more information about delegates. class Delegate include Google::Apis::Core::Hashable @@ -118,8 +116,8 @@ module Google # @return [String] attr_accessor :delegate_email - # Indicates whether this address has been verified and can act as a delegate - # for the account. Read-only. + # Indicates whether this address has been verified and can act as a delegate for + # the account. Read-only. # Corresponds to the JSON property `verificationStatus` # @return [String] attr_accessor :verification_status @@ -244,18 +242,16 @@ module Google attr_accessor :has_attachment alias_method :has_attachment?, :has_attachment - # Only return messages not matching the specified query. Supports the same - # query format as the Gmail search box. For example, - # `"from:someuser@example.com rfc822msgid: - # is:unread"`. + # Only return messages not matching the specified query. Supports the same query + # format as the Gmail search box. For example, `"from:someuser@example.com + # rfc822msgid: is:unread"`. # Corresponds to the JSON property `negatedQuery` # @return [String] attr_accessor :negated_query - # Only return messages matching the specified query. Supports the same - # query format as the Gmail search box. For example, - # `"from:someuser@example.com rfc822msgid: - # is:unread"`. + # Only return messages matching the specified query. Supports the same query + # format as the Gmail search box. For example, `"from:someuser@example.com + # rfc822msgid: is:unread"`. # Corresponds to the JSON property `query` # @return [String] attr_accessor :query @@ -271,16 +267,16 @@ module Google # @return [String] attr_accessor :size_comparison - # Case-insensitive phrase found in the message's subject. Trailing and - # leading whitespace are be trimmed and adjacent spaces are collapsed. + # Case-insensitive phrase found in the message's subject. Trailing and leading + # whitespace are be trimmed and adjacent spaces are collapsed. # Corresponds to the JSON property `subject` # @return [String] attr_accessor :subject - # The recipient's display name or email address. Includes recipients in the - # "to", "cc", and "bcc" header fields. You can use simply the local part of - # the email address. For example, "example" and "example@" both match - # "example@gmail.com". This field is case-insensitive. + # The recipient's display name or email address. Includes recipients in the "to", + # "cc", and "bcc" header fields. You can use simply the local part of the email + # address. For example, "example" and "example@" both match "example@gmail.com". + # This field is case-insensitive. # Corresponds to the JSON property `to` # @return [String] attr_accessor :to @@ -312,8 +308,8 @@ module Google # @return [String] attr_accessor :forwarding_email - # Indicates whether this address has been verified and is usable for - # forwarding. Read-only. + # Indicates whether this address has been verified and is usable for forwarding. + # Read-only. # Corresponds to the JSON property `verificationStatus` # @return [String] attr_accessor :verification_status @@ -349,10 +345,9 @@ module Google # @return [Array] attr_accessor :labels_removed - # List of messages changed in this history record. The fields for specific - # change types, such as `messagesAdded` may duplicate messages in - # this field. We recommend using the specific change-type fields instead - # of this. + # List of messages changed in this history record. The fields for specific + # change types, such as `messagesAdded` may duplicate messages in this field. We + # recommend using the specific change-type fields instead of this. # Corresponds to the JSON property `messages` # @return [Array] attr_accessor :messages @@ -475,8 +470,8 @@ module Google include Google::Apis::Core::Hashable # If this value is true, Gmail will immediately expunge a message when it is - # marked as deleted in IMAP. Otherwise, Gmail will wait for an update from - # the client before expunging messages marked as deleted. + # marked as deleted in IMAP. Otherwise, Gmail will wait for an update from the + # client before expunging messages marked as deleted. # Corresponds to the JSON property `autoExpunge` # @return [Boolean] attr_accessor :auto_expunge @@ -488,15 +483,15 @@ module Google attr_accessor :enabled alias_method :enabled?, :enabled - # The action that will be executed on a message when it is marked as deleted - # and expunged from the last visible IMAP folder. + # The action that will be executed on a message when it is marked as deleted and + # expunged from the last visible IMAP folder. # Corresponds to the JSON property `expungeBehavior` # @return [String] attr_accessor :expunge_behavior - # An optional limit on the number of messages that an IMAP folder may - # contain. Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero - # is interpreted to mean that there is no limit. + # An optional limit on the number of messages that an IMAP folder may contain. + # Legal values are 0, 1000, 2000, 5000 or 10000. A value of zero is interpreted + # to mean that there is no limit. # Corresponds to the JSON property `maxFolderSize` # @return [Fixnum] attr_accessor :max_folder_size @@ -514,14 +509,13 @@ module Google end end - # Labels are used to categorize messages and threads within the - # user's mailbox. + # Labels are used to categorize messages and threads within the user's mailbox. class Label include Google::Apis::Core::Hashable - # The color to assign to the label. Color is only available for labels that - # have their `type` set to `user`. - # @mutable gmail.users.labels.create gmail.users.labels.update + # The color to assign to the label. Color is only available for labels that have + # their `type` set to `user`. @mutable gmail.users.labels.create gmail.users. + # labels.update # Corresponds to the JSON property `color` # @return [Google::Apis::GmailV1::LabelColor] attr_accessor :color @@ -531,15 +525,14 @@ module Google # @return [String] attr_accessor :id - # The visibility of the label in the label list in the Gmail web interface. - # @mutable gmail.users.labels.create gmail.users.labels.update + # The visibility of the label in the label list in the Gmail web interface. @ + # mutable gmail.users.labels.create gmail.users.labels.update # Corresponds to the JSON property `labelListVisibility` # @return [String] attr_accessor :label_list_visibility - # The visibility of messages with this label in the message list - # in the Gmail web interface. - # @mutable gmail.users.labels.create gmail.users.labels.update + # The visibility of messages with this label in the message list in the Gmail + # web interface. @mutable gmail.users.labels.create gmail.users.labels.update # Corresponds to the JSON property `messageListVisibility` # @return [String] attr_accessor :message_list_visibility @@ -554,8 +547,8 @@ module Google # @return [Fixnum] attr_accessor :messages_unread - # The display name of the label. - # @mutable gmail.users.labels.create gmail.users.labels.update + # The display name of the label. @mutable gmail.users.labels.create gmail.users. + # labels.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -570,15 +563,14 @@ module Google # @return [Fixnum] attr_accessor :threads_unread - # The owner type for the label. User labels are created by the user and - # can be modified and deleted by the user and can be applied to any - # message or thread. System labels are internally created and cannot be - # added, modified, or deleted. System labels may be able to be applied to or - # removed from messages and threads under some circumstances but this is - # not guaranteed. For example, users can apply and remove the - # `INBOX` and `UNREAD` labels from messages and - # threads, but cannot apply or remove the `DRAFTS` or - # `SENT` labels from messages or threads. + # The owner type for the label. User labels are created by the user and can be + # modified and deleted by the user and can be applied to any message or thread. + # System labels are internally created and cannot be added, modified, or deleted. + # System labels may be able to be applied to or removed from messages and + # threads under some circumstances but this is not guaranteed. For example, + # users can apply and remove the `INBOX` and `UNREAD` labels from messages and + # threads, but cannot apply or remove the `DRAFTS` or `SENT` labels from + # messages or threads. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -606,46 +598,42 @@ module Google class LabelColor include Google::Apis::Core::Hashable - # The background color represented as hex string #RRGGBB (ex #000000). - # This field is required in order to set the color of a label. - # Only the following predefined set of color values are allowed: - #
    - # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, - # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, - # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, - # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, - # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, - # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, - # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, - # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c - # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, - # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, - # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, - # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, - # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - # @mutable gmail.users.labels.create gmail.users.labels.update + # The background color represented as hex string #RRGGBB (ex #000000). This + # field is required in order to set the color of a label. Only the following + # predefined set of color values are allowed: # 000000, #434343, #666666, # + # 999999, #cccccc, #efefef, #f3f3f3, #ffffff, # fb4c2f, #ffad47, #fad165, # + # 16a766, #43d692, #4a86e8, #a479e2, #f691b3, # f6c5be, #ffe6c7, #fef1d1, # + # b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, # efa093, #ffd6a2, #fce8b3, # + # 89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, # e66550, #ffbc6b, #fcda83, # + # 44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, # cc3a21, #eaa041, #f2c960, # + # 149e60, #3dc789, #3c78d8, #8e63ce, #e07798, # ac2b16, #cf8933, #d5ae49, # + # 0b804b, #2a9c68, #285bac, #653e9b, #b65775, # 822111, #a46a21, #aa8831, # + # 076239, #1a764d, #1c4587, #41236d, #83334c # 464646, #e7e7e7, #0d3472, #b6cff5, + # #0d3b44, #98d7e4, #3d188e, #e3d7ff, # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, # + # 7a2e0b, #ffc8af, #7a4706, #ffdeb5, # 594c05, #fbe983, #684e07, #fdedc1, # + # 0b4f30, #b3efd3, #04502e, #a2dcc1, # c2c2c2, #4986e7, #2da2bb, #b99aff, # + # 994a64, #f691b2, #ff7537, #ffad46, # 662e37, #ebdbde, #cca6ac, #094228, # + # 42d692, #16a765 @mutable gmail.users.labels.create gmail.users.labels.update # Corresponds to the JSON property `backgroundColor` # @return [String] attr_accessor :background_color - # The text color of the label, represented as hex string. - # This field is required in order to set the color of a label. - # Only the following predefined set of color values are allowed: - #
    - # # 000000, #434343, #666666, #999999, #cccccc, #efefef, #f3f3f3, #ffffff, - # # fb4c2f, #ffad47, #fad165, #16a766, #43d692, #4a86e8, #a479e2, #f691b3, - # # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, #c9daf8, #e4d7f5, #fcdee8, - # # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, #a4c2f4, #d0bcf1, #fbc8d9, - # # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, #6d9eeb, #b694e8, #f7a7c0, - # # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, #3c78d8, #8e63ce, #e07798, - # # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, #285bac, #653e9b, #b65775, - # # 822111, #a46a21, #aa8831, #076239, #1a764d, #1c4587, #41236d, #83334c - # # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, #3d188e, #e3d7ff, - # # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, #7a4706, #ffdeb5, - # # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, #04502e, #a2dcc1, - # # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, #ff7537, #ffad46, - # # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 - # @mutable gmail.users.labels.create gmail.users.labels.update + # The text color of the label, represented as hex string. This field is required + # in order to set the color of a label. Only the following predefined set of + # color values are allowed: # 000000, #434343, #666666, #999999, #cccccc, # + # efefef, #f3f3f3, #ffffff, # fb4c2f, #ffad47, #fad165, #16a766, #43d692, # + # 4a86e8, #a479e2, #f691b3, # f6c5be, #ffe6c7, #fef1d1, #b9e4d0, #c6f3de, # + # c9daf8, #e4d7f5, #fcdee8, # efa093, #ffd6a2, #fce8b3, #89d3b2, #a0eac9, # + # a4c2f4, #d0bcf1, #fbc8d9, # e66550, #ffbc6b, #fcda83, #44b984, #68dfa9, # + # 6d9eeb, #b694e8, #f7a7c0, # cc3a21, #eaa041, #f2c960, #149e60, #3dc789, # + # 3c78d8, #8e63ce, #e07798, # ac2b16, #cf8933, #d5ae49, #0b804b, #2a9c68, # + # 285bac, #653e9b, #b65775, # 822111, #a46a21, #aa8831, #076239, #1a764d, # + # 1c4587, #41236d, #83334c # 464646, #e7e7e7, #0d3472, #b6cff5, #0d3b44, #98d7e4, + # #3d188e, #e3d7ff, # 711a36, #fbd3e0, #8a1c0a, #f2b2a8, #7a2e0b, #ffc8af, # + # 7a4706, #ffdeb5, # 594c05, #fbe983, #684e07, #fdedc1, #0b4f30, #b3efd3, # + # 04502e, #a2dcc1, # c2c2c2, #4986e7, #2da2bb, #b99aff, #994a64, #f691b2, # + # ff7537, #ffad46, # 662e37, #ebdbde, #cca6ac, #094228, #42d692, #16a765 @ + # mutable gmail.users.labels.create gmail.users.labels.update # Corresponds to the JSON property `textColor` # @return [String] attr_accessor :text_color @@ -661,28 +649,21 @@ module Google end end - # Language settings for an account. These settings correspond to - # the "Language - # settings" feature in the web interface. + # Language settings for an account. These settings correspond to the "Language + # settings" feature in the web interface. class LanguageSettings include Google::Apis::Core::Hashable - # The language to display Gmail in, formatted as an - # RFC 3066 - # Language Tag (for example `en-GB`, `fr` or - # `ja` for British English, French, or Japanese respectively). - # The set of languages supported by Gmail evolves over time, so please refer - # to the "Language" dropdown in the - # Gmail settings - # for all available options, as described in the - # language settings - # help article. A table of sample values is also provided in the - # Managing - # Language Settings guide - # Not all Gmail clients can display the same set of languages. In the case - # that a user's display language is not available for use on a particular - # client, said client automatically chooses to display in the closest - # supported variant (or a reasonable default). + # The language to display Gmail in, formatted as an RFC 3066 Language Tag (for + # example `en-GB`, `fr` or `ja` for British English, French, or Japanese + # respectively). The set of languages supported by Gmail evolves over time, so + # please refer to the "Language" dropdown in the Gmail settings for all + # available options, as described in the language settings help article. A table + # of sample values is also provided in the Managing Language Settings guide Not + # all Gmail clients can display the same set of languages. In the case that a + # user's display language is not available for use on a particular client, said + # client automatically chooses to display in the closest supported variant (or a + # reasonable default). # Corresponds to the JSON property `displayLanguage` # @return [String] attr_accessor :display_language @@ -720,11 +701,9 @@ module Google class ListDraftsResponse include Google::Apis::Core::Hashable - # List of drafts. Note that the `Message` property in each - # `Draft` resource only contains an `id` and a - # `threadId`. The - # messages.get - # method can fetch additional message details. + # List of drafts. Note that the `Message` property in each `Draft` resource only + # contains an `id` and a `threadId`. The messages.get method can fetch + # additional message details. # Corresponds to the JSON property `drafts` # @return [Array] attr_accessor :drafts @@ -793,9 +772,8 @@ module Google class ListHistoryResponse include Google::Apis::Core::Hashable - # List of history records. Any `messages` contained in the - # response will typically only have `id` and - # `threadId` fields populated. + # List of history records. Any `messages` contained in the response will + # typically only have `id` and `threadId` fields populated. # Corresponds to the JSON property `history` # @return [Array] attr_accessor :history @@ -826,11 +804,9 @@ module Google class ListLabelsResponse include Google::Apis::Core::Hashable - # List of labels. Note that each label resource only contains an - # `id`, `name`, `messageListVisibility`, - # `labelListVisibility`, and `type`. The - # labels.get method - # can fetch additional label details. + # List of labels. Note that each label resource only contains an `id`, `name`, ` + # messageListVisibility`, `labelListVisibility`, and `type`. The labels.get + # method can fetch additional label details. # Corresponds to the JSON property `labels` # @return [Array] attr_accessor :labels @@ -849,10 +825,8 @@ module Google class ListMessagesResponse include Google::Apis::Core::Hashable - # List of messages. Note that each message resource contains only an - # `id` and a `threadId`. Additional message details can - # be fetched using the - # messages.get + # List of messages. Note that each message resource contains only an `id` and a ` + # threadId`. Additional message details can be fetched using the messages.get # method. # Corresponds to the JSON property `messages` # @return [Array] @@ -932,10 +906,9 @@ module Google # @return [Fixnum] attr_accessor :result_size_estimate - # List of threads. Note that each thread resource does not contain a list of - # `messages`. The list of `messages` for a given thread - # can be fetched using the - # threads.get method. + # List of threads. Note that each thread resource does not contain a list of ` + # messages`. The list of `messages` for a given thread can be fetched using the + # threads.get method. # Corresponds to the JSON property `threads` # @return [Array] attr_accessor :threads @@ -966,17 +939,17 @@ module Google # @return [String] attr_accessor :id - # The internal message creation timestamp (epoch ms), which determines - # ordering in the inbox. For normal SMTP-received email, this represents the - # time the message was originally accepted by Google, which is more reliable - # than the `Date` header. However, for API-migrated mail, it can - # be configured by client to be based on the `Date` header. + # The internal message creation timestamp (epoch ms), which determines ordering + # in the inbox. For normal SMTP-received email, this represents the time the + # message was originally accepted by Google, which is more reliable than the ` + # Date` header. However, for API-migrated mail, it can be configured by client + # to be based on the `Date` header. # Corresponds to the JSON property `internalDate` # @return [Fixnum] attr_accessor :internal_date - # List of IDs of labels applied to this message. - # @mutable gmail.users.messages.insert gmail.users.messages.modify + # List of IDs of labels applied to this message. @mutable gmail.users.messages. + # insert gmail.users.messages.modify # Corresponds to the JSON property `labelIds` # @return [Array] attr_accessor :label_ids @@ -986,12 +959,10 @@ module Google # @return [Google::Apis::GmailV1::MessagePart] attr_accessor :payload - # The entire email message in an RFC 2822 formatted and base64url - # encoded string. Returned in `messages.get` and - # `drafts.get` responses when the `format=RAW` - # parameter is supplied. - # @mutable gmail.users.messages.insert gmail.users.messages.send - # @mutable gmail.users.drafts.create gmail.users.drafts.update + # The entire email message in an RFC 2822 formatted and base64url encoded string. + # Returned in `messages.get` and `drafts.get` responses when the `format=RAW` + # parameter is supplied. @mutable gmail.users.messages.insert gmail.users. + # messages.send @mutable gmail.users.drafts.create gmail.users.drafts.update # Corresponds to the JSON property `raw` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1007,17 +978,13 @@ module Google # @return [String] attr_accessor :snippet - # The ID of the thread the message belongs to. To add a message or draft to - # a thread, the following criteria must be met: - #
    1. The requested `threadId` must be specified on the - # `Message` or `Draft.Message` you supply with your - # request.
      2. - #
    2. The `References` and `In-Reply-To` headers must - # be set in compliance with the - # RFC 2822 standard.
      3. - #
    3. The `Subject` headers must match. - # @mutable gmail.users.messages.insert gmail.users.messages.send - # @mutable gmail.users.drafts.create gmail.users.drafts.update + # The ID of the thread the message belongs to. To add a message or draft to a + # thread, the following criteria must be met: 1. The requested `threadId` must + # be specified on the `Message` or `Draft.Message` you supply with your request. + # 2. The `References` and `In-Reply-To` headers must be set in compliance with + # the RFC 2822 standard. 3. The `Subject` headers must match. @mutable gmail. + # users.messages.insert gmail.users.messages.send @mutable gmail.users.drafts. + # create gmail.users.drafts.update # Corresponds to the JSON property `threadId` # @return [String] attr_accessor :thread_id @@ -1049,16 +1016,15 @@ module Google # @return [Google::Apis::GmailV1::MessagePartBody] attr_accessor :body - # The filename of the attachment. Only present if this message part - # represents an attachment. + # The filename of the attachment. Only present if this message part represents + # an attachment. # Corresponds to the JSON property `filename` # @return [String] attr_accessor :filename # List of headers on this message part. For the top-level message part, - # representing the entire message payload, it will contain the standard - # RFC 2822 email headers such as `To`, `From`, and - # `Subject`. + # representing the entire message payload, it will contain the standard RFC 2822 + # email headers such as `To`, `From`, and `Subject`. # Corresponds to the JSON property `headers` # @return [Array] attr_accessor :headers @@ -1073,11 +1039,10 @@ module Google # @return [String] attr_accessor :part_id - # The child MIME message parts of this part. This only applies to container - # MIME message parts, for example `multipart/*`. For non- - # container MIME message part types, such as `text/plain`, this - # field is empty. For more information, see - # RFC 1521. + # The child MIME message parts of this part. This only applies to container MIME + # message parts, for example `multipart/*`. For non- container MIME message part + # types, such as `text/plain`, this field is empty. For more information, see + # RFC 1521. # Corresponds to the JSON property `parts` # @return [Array] attr_accessor :parts @@ -1101,19 +1066,17 @@ module Google class MessagePartBody include Google::Apis::Core::Hashable - # When present, contains the ID of an external attachment that can be - # retrieved in a separate `messages.attachments.get` request. - # When not present, the entire content of the message part body is - # contained in the data field. + # When present, contains the ID of an external attachment that can be retrieved + # in a separate `messages.attachments.get` request. When not present, the entire + # content of the message part body is contained in the data field. # Corresponds to the JSON property `attachmentId` # @return [String] attr_accessor :attachment_id - # The body data of a MIME message part as a base64url encoded string. - # May be empty for MIME container - # types that have no message body or when the body data is sent as a - # separate attachment. An attachment ID is present if the body data is - # contained in a separate attachment. + # The body data of a MIME message part as a base64url encoded string. May be + # empty for MIME container types that have no message body or when the body data + # is sent as a separate attachment. An attachment ID is present if the body data + # is contained in a separate attachment. # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1140,14 +1103,13 @@ module Google class MessagePartHeader include Google::Apis::Core::Hashable - # The name of the header before the `:` separator. For - # example, `To`. + # The name of the header before the `:` separator. For example, `To`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The value of the header after the `:` separator. For example, - # `someuser@example.com`. + # The value of the header after the `:` separator. For example, `someuser@ + # example.com`. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -1277,53 +1239,48 @@ module Google end # Settings associated with a send-as alias, which can be either the primary - # login address associated with the account or a custom "from" address. - # Send-as aliases correspond to the - # "Send Mail As" - # feature in the web interface. + # login address associated with the account or a custom "from" address. Send-as + # aliases correspond to the "Send Mail As" feature in the web interface. class SendAs include Google::Apis::Core::Hashable - # A name that appears in the "From:" header for mail sent using this alias. - # For custom "from" addresses, when this is empty, Gmail will populate the - # "From:" header with the name that is used for the primary address - # associated with the account. - # If the admin has disabled the ability for users to update their name - # format, requests to update this field for the primary login will silently - # fail. + # A name that appears in the "From:" header for mail sent using this alias. For + # custom "from" addresses, when this is empty, Gmail will populate the "From:" + # header with the name that is used for the primary address associated with the + # account. If the admin has disabled the ability for users to update their name + # format, requests to update this field for the primary login will silently fail. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Whether this address is selected as the default "From:" address in - # situations such as composing a new message or sending a vacation - # auto-reply. Every Gmail account has exactly one default send-as address, - # so the only legal value that clients may write to this field is - # `true`. Changing this from `false` to - # `true` for an address will result in this field becoming - # `false` for the other previous default address. + # Whether this address is selected as the default "From:" address in situations + # such as composing a new message or sending a vacation auto-reply. Every Gmail + # account has exactly one default send-as address, so the only legal value that + # clients may write to this field is `true`. Changing this from `false` to `true` + # for an address will result in this field becoming `false` for the other + # previous default address. # Corresponds to the JSON property `isDefault` # @return [Boolean] attr_accessor :is_default alias_method :is_default?, :is_default # Whether this address is the primary address used to login to the account. - # Every Gmail account has exactly one primary address, and it cannot be - # deleted from the collection of send-as aliases. This field is read-only. + # Every Gmail account has exactly one primary address, and it cannot be deleted + # from the collection of send-as aliases. This field is read-only. # Corresponds to the JSON property `isPrimary` # @return [Boolean] attr_accessor :is_primary alias_method :is_primary?, :is_primary # An optional email address that is included in a "Reply-To:" header for mail - # sent using this alias. If this is empty, Gmail will not generate a - # "Reply-To:" header. + # sent using this alias. If this is empty, Gmail will not generate a "Reply-To:" + # header. # Corresponds to the JSON property `replyToAddress` # @return [String] attr_accessor :reply_to_address - # The email address that appears in the "From:" header for mail sent using - # this alias. This is read-only for all operations except create. + # The email address that appears in the "From:" header for mail sent using this + # alias. This is read-only for all operations except create. # Corresponds to the JSON property `sendAsEmail` # @return [String] attr_accessor :send_as_email @@ -1339,16 +1296,15 @@ module Google # @return [Google::Apis::GmailV1::SmtpMsa] attr_accessor :smtp_msa - # Whether Gmail should - # treat this address as an alias for the user's primary email address. - # This setting only applies to custom "from" aliases. + # Whether Gmail should treat this address as an alias for the user's primary + # email address. This setting only applies to custom "from" aliases. # Corresponds to the JSON property `treatAsAlias` # @return [Boolean] attr_accessor :treat_as_alias alias_method :treat_as_alias?, :treat_as_alias - # Indicates whether this address has been verified for use as a send-as - # alias. Read-only. This setting only applies to custom "from" aliases. + # Indicates whether this address has been verified for use as a send-as alias. + # Read-only. This setting only applies to custom "from" aliases. # Corresponds to the JSON property `verificationStatus` # @return [String] attr_accessor :verification_status @@ -1401,18 +1357,18 @@ module Google # @return [String] attr_accessor :issuer_cn - # PEM formatted X509 concatenated certificate string (standard base64 - # encoding). Format used for returning key, which includes public key - # as well as certificate chain (not private key). + # PEM formatted X509 concatenated certificate string (standard base64 encoding). + # Format used for returning key, which includes public key as well as + # certificate chain (not private key). # Corresponds to the JSON property `pem` # @return [String] attr_accessor :pem - # PKCS#12 format containing a single private/public key pair and - # certificate chain. This format is only accepted from client - # for creating a new SmimeInfo and is never returned, because the - # private key is not intended to be exported. PKCS#12 may be encrypted, - # in which case encryptedKeyPassword should be set appropriately. + # PKCS#12 format containing a single private/public key pair and certificate + # chain. This format is only accepted from client for creating a new SmimeInfo + # and is never returned, because the private key is not intended to be exported. + # PKCS#12 may be encrypted, in which case encryptedKeyPassword should be set + # appropriately. # Corresponds to the JSON property `pkcs12` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1438,32 +1394,32 @@ module Google class SmtpMsa include Google::Apis::Core::Hashable - # The hostname of the SMTP service. Required. + # The hostname of the SMTP service. Required. # Corresponds to the JSON property `host` # @return [String] attr_accessor :host - # The password that will be used for authentication with the SMTP service. - # This is a write-only field that can be specified in requests to create or - # update SendAs settings; it is never populated in responses. + # The password that will be used for authentication with the SMTP service. This + # is a write-only field that can be specified in requests to create or update + # SendAs settings; it is never populated in responses. # Corresponds to the JSON property `password` # @return [String] attr_accessor :password - # The port of the SMTP service. Required. + # The port of the SMTP service. Required. # Corresponds to the JSON property `port` # @return [Fixnum] attr_accessor :port - # The protocol that will be used to secure communication with the SMTP - # service. Required. + # The protocol that will be used to secure communication with the SMTP service. + # Required. # Corresponds to the JSON property `securityMode` # @return [String] attr_accessor :security_mode - # The username that will be used for authentication with the SMTP service. - # This is a write-only field that can be specified in requests to create or - # update SendAs settings; it is never populated in responses. + # The username that will be used for authentication with the SMTP service. This + # is a write-only field that can be specified in requests to create or update + # SendAs settings; it is never populated in responses. # Corresponds to the JSON property `username` # @return [String] attr_accessor :username @@ -1519,9 +1475,8 @@ module Google end end - # Vacation auto-reply settings for an account. These settings correspond to - # the "Vacation - # responder" feature in the web interface. + # Vacation auto-reply settings for an account. These settings correspond to the " + # Vacation responder" feature in the web interface. class VacationSettings include Google::Apis::Core::Hashable @@ -1531,57 +1486,52 @@ module Google attr_accessor :enable_auto_reply alias_method :enable_auto_reply?, :enable_auto_reply - # An optional end time for sending auto-replies (epoch ms). - # When this is specified, Gmail will automatically reply only to messages - # that it receives before the end time. If both `startTime` and - # `endTime` are specified, `startTime` must precede - # `endTime`. + # An optional end time for sending auto-replies (epoch ms). When this is + # specified, Gmail will automatically reply only to messages that it receives + # before the end time. If both `startTime` and `endTime` are specified, ` + # startTime` must precede `endTime`. # Corresponds to the JSON property `endTime` # @return [Fixnum] attr_accessor :end_time - # Response body in HTML format. Gmail will sanitize the HTML before - # storing it. If both `response_body_plain_text` and - # `response_body_html` are specified, - # `response_body_html` will be used. + # Response body in HTML format. Gmail will sanitize the HTML before storing it. + # If both `response_body_plain_text` and `response_body_html` are specified, ` + # response_body_html` will be used. # Corresponds to the JSON property `responseBodyHtml` # @return [String] attr_accessor :response_body_html - # Response body in plain text format. If both - # `response_body_plain_text` and `response_body_html` - # are specified, `response_body_html` will be used. + # Response body in plain text format. If both `response_body_plain_text` and ` + # response_body_html` are specified, `response_body_html` will be used. # Corresponds to the JSON property `responseBodyPlainText` # @return [String] attr_accessor :response_body_plain_text - # Optional text to prepend to the subject line in vacation responses. In - # order to enable auto-replies, either the response subject or the response - # body must be nonempty. + # Optional text to prepend to the subject line in vacation responses. In order + # to enable auto-replies, either the response subject or the response body must + # be nonempty. # Corresponds to the JSON property `responseSubject` # @return [String] attr_accessor :response_subject - # Flag that determines whether responses are sent to recipients who are not - # in the user's list of contacts. + # Flag that determines whether responses are sent to recipients who are not in + # the user's list of contacts. # Corresponds to the JSON property `restrictToContacts` # @return [Boolean] attr_accessor :restrict_to_contacts alias_method :restrict_to_contacts?, :restrict_to_contacts - # Flag that determines whether responses are sent to recipients who are - # outside of the user's domain. This feature is only available for G Suite - # users. + # Flag that determines whether responses are sent to recipients who are outside + # of the user's domain. This feature is only available for G Suite users. # Corresponds to the JSON property `restrictToDomain` # @return [Boolean] attr_accessor :restrict_to_domain alias_method :restrict_to_domain?, :restrict_to_domain - # An optional start time for sending auto-replies (epoch ms). - # When this is specified, Gmail will automatically reply only to messages - # that it receives after the start time. If both `startTime` and - # `endTime` are specified, `startTime` must precede - # `endTime`. + # An optional start time for sending auto-replies (epoch ms). When this is + # specified, Gmail will automatically reply only to messages that it receives + # after the start time. If both `startTime` and `endTime` are specified, ` + # startTime` must precede `endTime`. # Corresponds to the JSON property `startTime` # @return [Fixnum] attr_accessor :start_time @@ -1612,21 +1562,19 @@ module Google # @return [String] attr_accessor :label_filter_action - # List of label_ids to restrict notifications about. By default, - # if unspecified, all changes are pushed out. If specified then - # dictates which labels are required for a push notification to - # be generated. + # List of label_ids to restrict notifications about. By default, if unspecified, + # all changes are pushed out. If specified then dictates which labels are + # required for a push notification to be generated. # Corresponds to the JSON property `labelIds` # @return [Array] attr_accessor :label_ids - # A fully qualified Google Cloud Pub/Sub API topic name to publish the - # events to. This topic name **must** already exist in Cloud Pub/Sub and - # you **must** have already granted gmail "publish" permission on it. - # For example, "projects/my-project-identifier/topics/my-topic-name" - # (using the Cloud Pub/Sub "v1" topic naming format). - # Note that the "my-project-identifier" portion must exactly match your - # Google developer project id (the one executing this watch request). + # A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. + # This topic name **must** already exist in Cloud Pub/Sub and you **must** have + # already granted gmail "publish" permission on it. For example, "projects/my- + # project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic + # naming format). Note that the "my-project-identifier" portion must exactly + # match your Google developer project id (the one executing this watch request). # Corresponds to the JSON property `topicName` # @return [String] attr_accessor :topic_name @@ -1647,9 +1595,8 @@ module Google class WatchResponse include Google::Apis::Core::Hashable - # When Gmail will stop sending notifications for mailbox updates - # (epoch millis). Call `watch` again before this time to renew - # the watch. + # When Gmail will stop sending notifications for mailbox updates (epoch millis). + # Call `watch` again before this time to renew the watch. # Corresponds to the JSON property `expiration` # @return [Fixnum] attr_accessor :expiration diff --git a/generated/google/apis/gmail_v1/service.rb b/generated/google/apis/gmail_v1/service.rb index b04211038..ecd0c8e95 100644 --- a/generated/google/apis/gmail_v1/service.rb +++ b/generated/google/apis/gmail_v1/service.rb @@ -22,8 +22,8 @@ module Google module GmailV1 # Gmail API # - # The Gmail API lets you view and manage Gmail mailbox data like - # threads, messages, and labels. + # The Gmail API lets you view and manage Gmail mailbox data like threads, + # messages, and labels. # # @example # require 'google/apis/gmail_v1' @@ -50,8 +50,8 @@ module Google # Gets the current user's Gmail profile. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -81,8 +81,8 @@ module Google # Stop receiving push notifications for the given user mailbox. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -110,8 +110,8 @@ module Google # Set up or update a push notification watch on the given user mailbox. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::WatchRequest] watch_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -144,8 +144,8 @@ module Google # Creates a new draft with the `DRAFT` label. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Draft] draft_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -186,11 +186,11 @@ module Google execute_or_queue_command(command, &block) end - # Immediately and permanently deletes the specified draft. - # Does not simply trash it. + # Immediately and permanently deletes the specified draft. Does not simply trash + # it. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the draft to delete. # @param [String] fields @@ -221,8 +221,8 @@ module Google # Gets the specified draft. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the draft to retrieve. # @param [String] format @@ -258,20 +258,18 @@ module Google # Lists the drafts in the user's mailbox. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Boolean] include_spam_trash - # Include drafts from `SPAM` and `TRASH` - # in the results. + # Include drafts from `SPAM` and `TRASH` in the results. # @param [Fixnum] max_results # Maximum number of drafts to return. # @param [String] page_token # Page token to retrieve a specific page of results in the list. # @param [String] q # Only return draft messages matching the specified query. Supports the same - # query format as the Gmail search box. For example, - # `"from:someuser@example.com rfc822msgid: - # is:unread"`. + # query format as the Gmail search box. For example, `"from:someuser@example.com + # rfc822msgid: is:unread"`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -303,11 +301,11 @@ module Google execute_or_queue_command(command, &block) end - # Sends the specified, existing draft to the recipients in the - # `To`, `Cc`, and `Bcc` headers. + # Sends the specified, existing draft to the recipients in the `To`, `Cc`, and ` + # Bcc` headers. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Draft] draft_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -350,8 +348,8 @@ module Google # Replaces a draft's content. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the draft to update. # @param [Google::Apis::GmailV1::Draft] draft_object @@ -398,8 +396,8 @@ module Google # Lists the history of all changes to the given mailbox. History results are # returned in chronological order (increasing `historyId`). # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Array, String] history_types # History types to be returned by the function # @param [String] label_id @@ -409,19 +407,16 @@ module Google # @param [String] page_token # Page token to retrieve a specific page of results in the list. # @param [Fixnum] start_history_id - # Required. Returns history records after the specified - # `startHistoryId`. The supplied `startHistoryId` - # should be obtained from the `historyId` of a message, thread, or - # previous `list` response. History IDs increase - # chronologically but are not contiguous with random gaps in between valid - # IDs. Supplying an invalid or out of date `startHistoryId` - # typically returns an `HTTP 404` error code. A - # `historyId` is typically valid for at least a week, but in some - # rare circumstances may be valid for only a few hours. If you receive an - # `HTTP 404` error response, your application should perform a - # full sync. If you receive no `nextPageToken` in the response, - # there are no updates to retrieve and you can store the returned - # `historyId` for a future request. + # Required. Returns history records after the specified `startHistoryId`. The + # supplied `startHistoryId` should be obtained from the `historyId` of a message, + # thread, or previous `list` response. History IDs increase chronologically but + # are not contiguous with random gaps in between valid IDs. Supplying an invalid + # or out of date `startHistoryId` typically returns an `HTTP 404` error code. A ` + # historyId` is typically valid for at least a week, but in some rare + # circumstances may be valid for only a few hours. If you receive an `HTTP 404` + # error response, your application should perform a full sync. If you receive no + # `nextPageToken` in the response, there are no updates to retrieve and you can + # store the returned `historyId` for a future request. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -456,8 +451,8 @@ module Google # Creates a new label. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Label] label_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -491,8 +486,8 @@ module Google # Immediately and permanently deletes the specified label and removes it from # any messages and threads that it is applied to. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the label to delete. # @param [String] fields @@ -523,8 +518,8 @@ module Google # Gets the specified label. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the label to retrieve. # @param [String] fields @@ -557,8 +552,8 @@ module Google # Lists all labels in the user's mailbox. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -588,8 +583,8 @@ module Google # Patch the specified label. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the label to update. # @param [Google::Apis::GmailV1::Label] label_object @@ -625,8 +620,8 @@ module Google # Updates the specified label. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the label to update. # @param [Google::Apis::GmailV1::Label] label_object @@ -660,11 +655,11 @@ module Google execute_or_queue_command(command, &block) end - # Deletes many messages by message ID. Provides no guarantees that messages - # were not already deleted or even existed at all. + # Deletes many messages by message ID. Provides no guarantees that messages were + # not already deleted or even existed at all. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::BatchDeleteMessagesRequest] batch_delete_messages_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -695,8 +690,8 @@ module Google # Modifies the labels on the specified messages. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::BatchModifyMessagesRequest] batch_modify_messages_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -726,10 +721,10 @@ module Google end # Immediately and permanently deletes the specified message. This operation - # cannot be undone. Prefer `messages.trash` instead. + # cannot be undone. Prefer `messages.trash` instead. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the message to delete. # @param [String] fields @@ -760,15 +755,14 @@ module Google # Gets the specified message. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the message to retrieve. # @param [String] format # The format to return the message in. # @param [Array, String] metadata_headers - # When given and format is `METADATA`, only include headers - # specified. + # When given and format is `METADATA`, only include headers specified. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -799,26 +793,24 @@ module Google execute_or_queue_command(command, &block) end - # Imports a message into only this user's mailbox, with standard - # email delivery scanning and classification similar to receiving via SMTP. - # Does not send a message. + # Imports a message into only this user's mailbox, with standard email delivery + # scanning and classification similar to receiving via SMTP. Does not send a + # message. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Message] message_object # @param [Boolean] deleted - # Mark the email as permanently deleted (not TRASH) and - # only visible in - # Google Vault to - # a Vault administrator. Only used for G Suite accounts. + # Mark the email as permanently deleted (not TRASH) and only visible in Google + # Vault to a Vault administrator. Only used for G Suite accounts. # @param [String] internal_date_source # Source for Gmail's internal date of the message. # @param [Boolean] never_mark_spam - # Ignore the Gmail spam classifier decision and never mark - # this email as SPAM in the mailbox. + # Ignore the Gmail spam classifier decision and never mark this email as SPAM in + # the mailbox. # @param [Boolean] process_for_calendar - # Process calendar invites in the email and add any extracted - # meetings to the Google Calendar for this user. + # Process calendar invites in the email and add any extracted meetings to the + # Google Calendar for this user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -862,18 +854,15 @@ module Google execute_or_queue_command(command, &block) end - # Directly inserts a message into only this user's mailbox similar to - # `IMAP APPEND`, bypassing most scanning and classification. - # Does not send a message. + # Directly inserts a message into only this user's mailbox similar to `IMAP + # APPEND`, bypassing most scanning and classification. Does not send a message. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Message] message_object # @param [Boolean] deleted - # Mark the email as permanently deleted (not TRASH) and - # only visible in - # Google Vault to - # a Vault administrator. Only used for G Suite accounts. + # Mark the email as permanently deleted (not TRASH) and only visible in Google + # Vault to a Vault administrator. Only used for G Suite accounts. # @param [String] internal_date_source # Source for Gmail's internal date of the message. # @param [String] fields @@ -919,11 +908,10 @@ module Google # Lists the messages in the user's mailbox. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Boolean] include_spam_trash - # Include messages from `SPAM` and `TRASH` - # in the results. + # Include messages from `SPAM` and `TRASH` in the results. # @param [Array, String] label_ids # Only return messages with labels that match all of the specified label IDs. # @param [Fixnum] max_results @@ -931,10 +919,9 @@ module Google # @param [String] page_token # Page token to retrieve a specific page of results in the list. # @param [String] q - # Only return messages matching the specified query. Supports the same - # query format as the Gmail search box. For example, - # `"from:someuser@example.com rfc822msgid: - # is:unread"`. Parameter cannot be used when accessing the api + # Only return messages matching the specified query. Supports the same query + # format as the Gmail search box. For example, `"from:someuser@example.com + # rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api # using the gmail.metadata scope. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -970,8 +957,8 @@ module Google # Modifies the labels on the specified message. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the message to modify. # @param [Google::Apis::GmailV1::ModifyMessageRequest] modify_message_request_object @@ -1005,11 +992,11 @@ module Google execute_or_queue_command(command, &block) end - # Sends the specified message to the recipients in the - # `To`, `Cc`, and `Bcc` headers. + # Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` + # headers. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Message] message_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1052,8 +1039,8 @@ module Google # Moves the specified message to the trash. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the message to Trash. # @param [String] fields @@ -1086,8 +1073,8 @@ module Google # Removes the specified message from the trash. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the message to remove from Trash. # @param [String] fields @@ -1120,8 +1107,8 @@ module Google # Gets the specified message attachment. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] message_id # The ID of the message containing the attachment. # @param [String] id @@ -1157,8 +1144,8 @@ module Google # Gets the auto-forwarding setting for the specified account. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1188,8 +1175,8 @@ module Google # Gets IMAP settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1219,8 +1206,8 @@ module Google # Gets language settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1250,8 +1237,8 @@ module Google # Gets POP settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1281,8 +1268,8 @@ module Google # Gets vacation responder settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1310,13 +1297,13 @@ module Google execute_or_queue_command(command, &block) end - # Updates the auto-forwarding setting for the specified account. A verified - # forwarding address must be specified when auto-forwarding is enabled. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Updates the auto-forwarding setting for the specified account. A verified + # forwarding address must be specified when auto-forwarding is enabled. This + # method is only available to service account clients that have been delegated + # domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::AutoForwarding] auto_forwarding_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1349,8 +1336,8 @@ module Google # Updates IMAP settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::ImapSettings] imap_settings_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1381,15 +1368,14 @@ module Google execute_or_queue_command(command, &block) end - # Updates language settings. - # If successful, the return object contains the `displayLanguage` - # that was saved for the user, which may differ from the value passed into - # the request. This is because the requested `displayLanguage` may + # Updates language settings. If successful, the return object contains the ` + # displayLanguage` that was saved for the user, which may differ from the value + # passed into the request. This is because the requested `displayLanguage` may # not be directly supported by Gmail but have a close variant that is, and so # the variant may be chosen and saved instead. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::LanguageSettings] language_settings_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1422,8 +1408,8 @@ module Google # Updates POP settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::PopSettings] pop_settings_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1456,8 +1442,8 @@ module Google # Updates vacation responder settings. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::VacationSettings] vacation_settings_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1488,23 +1474,20 @@ module Google execute_or_queue_command(command, &block) end - # Adds a delegate with its verification status set directly to - # `accepted`, without sending any verification email. The - # delegate user must be a member of the same G Suite organization as the - # delegator user. - # Gmail imposes limitations on the number of delegates and delegators each - # user in a G Suite organization can have. These limits depend on your - # organization, but in general each user can have up to 25 delegates and - # up to 10 delegators. - # Note that a delegate user must be referred to by their primary email - # address, and not an email alias. - # Also note that when a new delegate is created, there may be up to a one - # minute delay before the new delegate is available for use. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Adds a delegate with its verification status set directly to `accepted`, + # without sending any verification email. The delegate user must be a member of + # the same G Suite organization as the delegator user. Gmail imposes limitations + # on the number of delegates and delegators each user in a G Suite organization + # can have. These limits depend on your organization, but in general each user + # can have up to 25 delegates and up to 10 delegators. Note that a delegate user + # must be referred to by their primary email address, and not an email alias. + # Also note that when a new delegate is created, there may be up to a one minute + # delay before the new delegate is available for use. This method is only + # available to service account clients that have been delegated domain-wide + # authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Delegate] delegate_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1535,15 +1518,14 @@ module Google execute_or_queue_command(command, &block) end - # Removes the specified delegate (which can be of any verification status), - # and revokes any verification that may have been required for using it. - # Note that a delegate user must be referred to by their primary email - # address, and not an email alias. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Removes the specified delegate (which can be of any verification status), and + # revokes any verification that may have been required for using it. Note that a + # delegate user must be referred to by their primary email address, and not an + # email alias. This method is only available to service account clients that + # have been delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] delegate_email # The email address of the user to be removed as a delegate. # @param [String] fields @@ -1572,17 +1554,15 @@ module Google execute_or_queue_command(command, &block) end - # Gets the specified delegate. - # Note that a delegate user must be referred to by their primary email - # address, and not an email alias. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Gets the specified delegate. Note that a delegate user must be referred to by + # their primary email address, and not an email alias. This method is only + # available to service account clients that have been delegated domain-wide + # authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] delegate_email - # The email address of the user whose delegate relationship is to be - # retrieved. + # The email address of the user whose delegate relationship is to be retrieved. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1611,12 +1591,11 @@ module Google execute_or_queue_command(command, &block) end - # Lists the delegates for the specified account. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Lists the delegates for the specified account. This method is only available + # to service account clients that have been delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1646,8 +1625,8 @@ module Google # Creates a filter. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::Filter] filter_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1680,8 +1659,8 @@ module Google # Deletes a filter. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] id # The ID of the filter to be deleted. # @param [String] fields @@ -1712,8 +1691,8 @@ module Google # Gets a filter. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] id # The ID of the filter to be fetched. # @param [String] fields @@ -1746,8 +1725,8 @@ module Google # Lists the message filters of a Gmail user. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1775,15 +1754,14 @@ module Google execute_or_queue_command(command, &block) end - # Creates a forwarding address. If ownership verification is required, a - # message will be sent to the recipient and the resource's verification - # status will be set to `pending`; otherwise, the resource will be - # created with verification status set to `accepted`. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Creates a forwarding address. If ownership verification is required, a message + # will be sent to the recipient and the resource's verification status will be + # set to `pending`; otherwise, the resource will be created with verification + # status set to `accepted`. This method is only available to service account + # clients that have been delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::ForwardingAddress] forwarding_address_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1814,13 +1792,12 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified forwarding address and revokes any verification that - # may have been required. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Deletes the specified forwarding address and revokes any verification that may + # have been required. This method is only available to service account clients + # that have been delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] forwarding_email # The forwarding address to be deleted. # @param [String] fields @@ -1851,8 +1828,8 @@ module Google # Gets the specified forwarding address. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] forwarding_email # The forwarding address to be retrieved. # @param [String] fields @@ -1885,8 +1862,8 @@ module Google # Lists the forwarding addresses for the specified account. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1914,19 +1891,18 @@ module Google execute_or_queue_command(command, &block) end - # Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail - # will attempt to connect to the SMTP service to validate the configuration - # before creating the alias. If ownership verification is required for the - # alias, a message will be sent to the email address and the resource's - # verification status will be set to `pending`; otherwise, the - # resource will be created with verification status set to - # `accepted`. If a signature is provided, Gmail will sanitize the - # HTML before saving it with the alias. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will + # attempt to connect to the SMTP service to validate the configuration before + # creating the alias. If ownership verification is required for the alias, a + # message will be sent to the email address and the resource's verification + # status will be set to `pending`; otherwise, the resource will be created with + # verification status set to `accepted`. If a signature is provided, Gmail will + # sanitize the HTML before saving it with the alias. This method is only + # available to service account clients that have been delegated domain-wide + # authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [Google::Apis::GmailV1::SendAs] send_as_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1957,13 +1933,12 @@ module Google execute_or_queue_command(command, &block) end - # Deletes the specified send-as alias. Revokes any verification that may - # have been required for using it. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Deletes the specified send-as alias. Revokes any verification that may have + # been required for using it. This method is only available to service account + # clients that have been delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] send_as_email # The send-as alias to be deleted. # @param [String] fields @@ -1992,11 +1967,11 @@ module Google execute_or_queue_command(command, &block) end - # Gets the specified send-as alias. Fails with an HTTP 404 error if the + # Gets the specified send-as alias. Fails with an HTTP 404 error if the # specified address is not a member of the collection. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] send_as_email # The send-as alias to be retrieved. # @param [String] fields @@ -2027,12 +2002,12 @@ module Google execute_or_queue_command(command, &block) end - # Lists the send-as aliases for the specified account. The result includes - # the primary send-as address associated with the account as well as any - # custom "from" aliases. + # Lists the send-as aliases for the specified account. The result includes the + # primary send-as address associated with the account as well as any custom " + # from" aliases. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2062,8 +2037,8 @@ module Google # Patch the specified send-as alias. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] send_as_email # The send-as alias to be updated. # @param [Google::Apis::GmailV1::SendAs] send_as_object @@ -2097,14 +2072,13 @@ module Google execute_or_queue_command(command, &block) end - # Updates a send-as alias. If a signature is provided, Gmail will sanitize - # the HTML before saving it with the alias. - # Addresses other than the primary address for the account can only be - # updated by service account clients that have been delegated domain-wide - # authority. + # Updates a send-as alias. If a signature is provided, Gmail will sanitize the + # HTML before saving it with the alias. Addresses other than the primary address + # for the account can only be updated by service account clients that have been + # delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] send_as_email # The send-as alias to be updated. # @param [Google::Apis::GmailV1::SendAs] send_as_object @@ -2138,13 +2112,12 @@ module Google execute_or_queue_command(command, &block) end - # Sends a verification email to the specified send-as alias address. - # The verification status must be `pending`. - # This method is only available to service account clients that have been - # delegated domain-wide authority. + # Sends a verification email to the specified send-as alias address. The + # verification status must be `pending`. This method is only available to + # service account clients that have been delegated domain-wide authority. # @param [String] user_id - # User's email address. The special value "me" - # can be used to indicate the authenticated user. + # User's email address. The special value "me" can be used to indicate the + # authenticated user. # @param [String] send_as_email # The send-as alias to be verified. # @param [String] fields @@ -2175,11 +2148,11 @@ module Google # Deletes the specified S/MIME config for the specified send-as alias. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using - # this alias. + # The email address that appears in the "From:" header for mail sent using this + # alias. # @param [String] id # The immutable ID for the SmimeInfo. # @param [String] fields @@ -2211,11 +2184,11 @@ module Google # Gets the specified S/MIME config for the specified send-as alias. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using - # this alias. + # The email address that appears in the "From:" header for mail sent using this + # alias. # @param [String] id # The immutable ID for the SmimeInfo. # @param [String] fields @@ -2247,14 +2220,14 @@ module Google execute_or_queue_command(command, &block) end - # Insert (upload) the given S/MIME config for the specified send-as alias. - # Note that pkcs12 format is required for the key. + # Insert (upload) the given S/MIME config for the specified send-as alias. Note + # that pkcs12 format is required for the key. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using - # this alias. + # The email address that appears in the "From:" header for mail sent using this + # alias. # @param [Google::Apis::GmailV1::SmimeInfo] smime_info_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2288,11 +2261,11 @@ module Google # Lists S/MIME configs for the specified send-as alias. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using - # this alias. + # The email address that appears in the "From:" header for mail sent using this + # alias. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2323,11 +2296,11 @@ module Google # Sets the default S/MIME config for the specified send-as alias. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] send_as_email - # The email address that appears in the "From:" header for mail sent using - # this alias. + # The email address that appears in the "From:" header for mail sent using this + # alias. # @param [String] id # The immutable ID for the SmimeInfo. # @param [String] fields @@ -2360,8 +2333,8 @@ module Google # Immediately and permanently deletes the specified thread. This operation # cannot be undone. Prefer `threads.trash` instead. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # ID of the Thread to delete. # @param [String] fields @@ -2392,8 +2365,8 @@ module Google # Gets the specified thread. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the thread to retrieve. # @param [String] format @@ -2432,11 +2405,10 @@ module Google # Lists the threads in the user's mailbox. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [Boolean] include_spam_trash - # Include threads from `SPAM` and `TRASH` - # in the results. + # Include threads from `SPAM` and `TRASH` in the results. # @param [Array, String] label_ids # Only return threads with labels that match all of the specified label IDs. # @param [Fixnum] max_results @@ -2444,10 +2416,9 @@ module Google # @param [String] page_token # Page token to retrieve a specific page of results in the list. # @param [String] q - # Only return threads matching the specified query. Supports the same - # query format as the Gmail search box. For example, - # `"from:someuser@example.com rfc822msgid: - # is:unread"`. Parameter cannot be used when accessing the api + # Only return threads matching the specified query. Supports the same query + # format as the Gmail search box. For example, `"from:someuser@example.com + # rfc822msgid: is:unread"`. Parameter cannot be used when accessing the api # using the gmail.metadata scope. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2481,11 +2452,11 @@ module Google execute_or_queue_command(command, &block) end - # Modifies the labels applied to the thread. This applies to all messages - # in the thread. + # Modifies the labels applied to the thread. This applies to all messages in the + # thread. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the thread to modify. # @param [Google::Apis::GmailV1::ModifyThreadRequest] modify_thread_request_object @@ -2521,8 +2492,8 @@ module Google # Moves the specified thread to the trash. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the thread to Trash. # @param [String] fields @@ -2555,8 +2526,8 @@ module Google # Removes the specified thread from the trash. # @param [String] user_id - # The user's email address. The special value `me` - # can be used to indicate the authenticated user. + # The user's email address. The special value `me` can be used to indicate the + # authenticated user. # @param [String] id # The ID of the thread to remove from Trash. # @param [String] fields diff --git a/generated/google/apis/osconfig_v1.rb b/generated/google/apis/osconfig_v1.rb index 7a59fa8e1..bb14e84c4 100644 --- a/generated/google/apis/osconfig_v1.rb +++ b/generated/google/apis/osconfig_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/ module OsconfigV1 VERSION = 'V1' - REVISION = '20200714' + 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/osconfig_v1/classes.rb b/generated/google/apis/osconfig_v1/classes.rb index 9435f8c77..47c03061a 100644 --- a/generated/google/apis/osconfig_v1/classes.rb +++ b/generated/google/apis/osconfig_v1/classes.rb @@ -90,6 +90,74 @@ module Google end end + # A resource that contains custom validation and enforcement steps. + class ExecResource + include Google::Apis::Core::Hashable + + # A file or script to execute. + # Corresponds to the JSON property `enforce` + # @return [Google::Apis::OsconfigV1::ExecResourceExec] + attr_accessor :enforce + + # A file or script to execute. + # Corresponds to the JSON property `validate` + # @return [Google::Apis::OsconfigV1::ExecResourceExec] + attr_accessor :validate + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @enforce = args[:enforce] if args.key?(:enforce) + @validate = args[:validate] if args.key?(:validate) + end + end + + # A file or script to execute. + class ExecResourceExec + include Google::Apis::Core::Hashable + + # Exit codes that indicate success. + # Corresponds to the JSON property `allowedSuccessCodes` + # @return [Array] + attr_accessor :allowed_success_codes + + # Arguments to use. + # Corresponds to the JSON property `args` + # @return [Array] + attr_accessor :args + + # A remote or local file. + # Corresponds to the JSON property `file` + # @return [Google::Apis::OsconfigV1::File] + attr_accessor :file + + # The script interpreter to use. + # Corresponds to the JSON property `interpreter` + # @return [String] + attr_accessor :interpreter + + # An inline script. + # Corresponds to the JSON property `script` + # @return [String] + attr_accessor :script + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allowed_success_codes = args[:allowed_success_codes] if args.key?(:allowed_success_codes) + @args = args[:args] if args.key?(:args) + @file = args[:file] if args.key?(:file) + @interpreter = args[:interpreter] if args.key?(:interpreter) + @script = args[:script] if args.key?(:script) + end + end + # A step that runs an executable for a PatchJob. class ExecStep include Google::Apis::Core::Hashable @@ -221,6 +289,206 @@ module Google end end + # A resource that extracts an archive + class ExtractArchiveResource + include Google::Apis::Core::Hashable + + # Local file path that signals this resource is in the desired state. + # The absence of this file will indicate whether the archive needs to be + # extracted. + # Corresponds to the JSON property `creates` + # @return [String] + attr_accessor :creates + + # Directory to extract archive to. + # Corresponds to the JSON property `destination` + # @return [String] + attr_accessor :destination + + # Whether to overwrite existing files during extraction. If this is set to + # true, any existing files in the destination location will be overwritten by + # the extraction. + # Corresponds to the JSON property `overwrite` + # @return [Boolean] + attr_accessor :overwrite + alias_method :overwrite?, :overwrite + + # A remote or local file. + # Corresponds to the JSON property `source` + # @return [Google::Apis::OsconfigV1::File] + attr_accessor :source + + # The type of the archive to extract. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @creates = args[:creates] if args.key?(:creates) + @destination = args[:destination] if args.key?(:destination) + @overwrite = args[:overwrite] if args.key?(:overwrite) + @source = args[:source] if args.key?(:source) + @type = args[:type] if args.key?(:type) + end + end + + # A remote or local file. + class File + include Google::Apis::Core::Hashable + + # Defaults to false. When false, files will be subject to validations + # based on the file type: + # Remote: A checksum must be specified. + # GCS: An object generation number must be specified. + # Corresponds to the JSON property `allowInsecure` + # @return [Boolean] + attr_accessor :allow_insecure + alias_method :allow_insecure?, :allow_insecure + + # Specifies a file available as a GCS Object. + # Corresponds to the JSON property `gcs` + # @return [Google::Apis::OsconfigV1::FileGcs] + attr_accessor :gcs + + # A local path to use. + # Corresponds to the JSON property `localPath` + # @return [String] + attr_accessor :local_path + + # Specifies a file available via some URI. + # Corresponds to the JSON property `remote` + # @return [Google::Apis::OsconfigV1::FileRemote] + attr_accessor :remote + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allow_insecure = args[:allow_insecure] if args.key?(:allow_insecure) + @gcs = args[:gcs] if args.key?(:gcs) + @local_path = args[:local_path] if args.key?(:local_path) + @remote = args[:remote] if args.key?(:remote) + end + end + + # Specifies a file available as a GCS Object. + class FileGcs + include Google::Apis::Core::Hashable + + # Bucket of the GCS object. + # Corresponds to the JSON property `bucket` + # @return [String] + attr_accessor :bucket + + # Generation number of the GCS object. + # Corresponds to the JSON property `generation` + # @return [Fixnum] + attr_accessor :generation + + # Name of the GCS object. + # Corresponds to the JSON property `object` + # @return [String] + attr_accessor :object + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bucket = args[:bucket] if args.key?(:bucket) + @generation = args[:generation] if args.key?(:generation) + @object = args[:object] if args.key?(:object) + end + end + + # Specifies a file available via some URI. + class FileRemote + include Google::Apis::Core::Hashable + + # SHA256 checksum of the remote file. + # Corresponds to the JSON property `sha256Checksum` + # @return [String] + attr_accessor :sha256_checksum + + # URI from which to fetch the object. It should contain both the protocol + # and path following the format `protocol`://`location`. + # Corresponds to the JSON property `uri` + # @return [String] + attr_accessor :uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @sha256_checksum = args[:sha256_checksum] if args.key?(:sha256_checksum) + @uri = args[:uri] if args.key?(:uri) + end + end + + # A resource that manages the state of a file. + class FileResource + include Google::Apis::Core::Hashable + + # A a file with this content. + # Corresponds to the JSON property `content` + # @return [String] + attr_accessor :content + + # A remote or local file. + # Corresponds to the JSON property `file` + # @return [Google::Apis::OsconfigV1::File] + attr_accessor :file + + # The absolute path of the file. + # Corresponds to the JSON property `path` + # @return [String] + attr_accessor :path + + # Consists of three octal digits which represent, in + # order, the permissions of the owner, group, and other users for the + # file (similarly to the numeric mode used in the linux chmod utility). + # Each digit represents a three bit number with the 4 bit + # corresponding to the read permissions, the 2 bit corresponds to the + # write bit, and the one bit corresponds to the execute permission. + # Default behavior is 755. + # Below are some examples of permissions and their associated values: + # read, write, and execute: 7 + # read and execute: 5 + # read and write: 6 + # read only: 4 + # Corresponds to the JSON property `permissions` + # @return [String] + attr_accessor :permissions + + # Desired state of the file. + # Corresponds to the JSON property `state` + # @return [String] + attr_accessor :state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content = args[:content] if args.key?(:content) + @file = args[:file] if args.key?(:file) + @path = args[:path] if args.key?(:path) + @permissions = args[:permissions] if args.key?(:permissions) + @state = args[:state] if args.key?(:state) + end + end + # Message encapsulating a value that can be either absolute ("fixed") or # relative ("percent") to a value. class FixedOrPercent @@ -418,6 +686,252 @@ module Google end end + # A resource that manages a system package. + class PackageResource + include Google::Apis::Core::Hashable + + # A package managed by APT. + # install: `apt-get update && apt-get -y install [name]` + # remove: `apt-get -y remove [name]` + # Corresponds to the JSON property `apt` + # @return [Google::Apis::OsconfigV1::PackageResourceApt] + attr_accessor :apt + + # A deb package file. dpkg packages only support INSTALLED state. + # Corresponds to the JSON property `deb` + # @return [Google::Apis::OsconfigV1::PackageResourceDeb] + attr_accessor :deb + + # The desired_state the agent should maintain for this package. The + # default is to ensure the package is installed. + # Corresponds to the JSON property `desiredState` + # @return [String] + attr_accessor :desired_state + + # A package managed by GooGet. + # install: `googet -noconfirm install package` + # remove: `googet -noconfirm remove package` + # Corresponds to the JSON property `googet` + # @return [Google::Apis::OsconfigV1::PackageResourceGooGet] + attr_accessor :googet + + # An MSI package. MSI packages only support INSTALLED state. + # Install msiexec /i /qn /norestart + # Corresponds to the JSON property `msi` + # @return [Google::Apis::OsconfigV1::PackageResourceMsi] + attr_accessor :msi + + # An RPM package file. RPM packages only support INSTALLED state. + # Corresponds to the JSON property `rpm` + # @return [Google::Apis::OsconfigV1::PackageResourceRpm] + attr_accessor :rpm + + # A package managed by YUM. + # install: `yum -y install package` + # remove: `yum -y remove package` + # Corresponds to the JSON property `yum` + # @return [Google::Apis::OsconfigV1::PackageResourceYum] + attr_accessor :yum + + # A package managed by Zypper. + # install: `zypper -y install package` + # remove: `zypper -y rm package` + # Corresponds to the JSON property `zypper` + # @return [Google::Apis::OsconfigV1::PackageResourceZypper] + attr_accessor :zypper + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @apt = args[:apt] if args.key?(:apt) + @deb = args[:deb] if args.key?(:deb) + @desired_state = args[:desired_state] if args.key?(:desired_state) + @googet = args[:googet] if args.key?(:googet) + @msi = args[:msi] if args.key?(:msi) + @rpm = args[:rpm] if args.key?(:rpm) + @yum = args[:yum] if args.key?(:yum) + @zypper = args[:zypper] if args.key?(:zypper) + end + end + + # A package managed by APT. + # install: `apt-get update && apt-get -y install [name]` + # remove: `apt-get -y remove [name]` + class PackageResourceApt + include Google::Apis::Core::Hashable + + # Package name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + end + end + + # A deb package file. dpkg packages only support INSTALLED state. + class PackageResourceDeb + include Google::Apis::Core::Hashable + + # Whether dependencies should also be installed. + # install when false: `dpkg -i package` + # install when true: `apt-get update && apt-get -y install package.deb` + # Corresponds to the JSON property `pullDeps` + # @return [Boolean] + attr_accessor :pull_deps + alias_method :pull_deps?, :pull_deps + + # A remote or local file. + # Corresponds to the JSON property `source` + # @return [Google::Apis::OsconfigV1::File] + attr_accessor :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @pull_deps = args[:pull_deps] if args.key?(:pull_deps) + @source = args[:source] if args.key?(:source) + end + end + + # A package managed by GooGet. + # install: `googet -noconfirm install package` + # remove: `googet -noconfirm remove package` + class PackageResourceGooGet + include Google::Apis::Core::Hashable + + # Package name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + end + end + + # An MSI package. MSI packages only support INSTALLED state. + # Install msiexec /i /qn /norestart + class PackageResourceMsi + include Google::Apis::Core::Hashable + + # Return codes that indicate that the software installed or updated + # successfully. Behaviour defaults to [0] + # Corresponds to the JSON property `allowedSuccessCodes` + # @return [Array] + attr_accessor :allowed_success_codes + + # Flags to use during package install. + # Appended to the defalts of "/i /qn /norestart" + # Corresponds to the JSON property `flags` + # @return [Array] + attr_accessor :flags + + # A remote or local file. + # Corresponds to the JSON property `source` + # @return [Google::Apis::OsconfigV1::File] + attr_accessor :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allowed_success_codes = args[:allowed_success_codes] if args.key?(:allowed_success_codes) + @flags = args[:flags] if args.key?(:flags) + @source = args[:source] if args.key?(:source) + end + end + + # An RPM package file. RPM packages only support INSTALLED state. + class PackageResourceRpm + include Google::Apis::Core::Hashable + + # Whether dependencies should also be installed. + # install when false: `rpm --upgrade --replacepkgs package.rpm` + # install when true: `yum -y install package.rpm` or + # `zypper -y install package.rpm` + # Corresponds to the JSON property `pullDeps` + # @return [Boolean] + attr_accessor :pull_deps + alias_method :pull_deps?, :pull_deps + + # A remote or local file. + # Corresponds to the JSON property `source` + # @return [Google::Apis::OsconfigV1::File] + attr_accessor :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @pull_deps = args[:pull_deps] if args.key?(:pull_deps) + @source = args[:source] if args.key?(:source) + end + end + + # A package managed by YUM. + # install: `yum -y install package` + # remove: `yum -y remove package` + class PackageResourceYum + include Google::Apis::Core::Hashable + + # Package name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + end + end + + # A package managed by Zypper. + # install: `zypper -y install package` + # remove: `zypper -y rm package` + class PackageResourceZypper + include Google::Apis::Core::Hashable + + # Package name. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + end + end + # Patch configuration specifications. Contains details on how to apply the # patch(es) to a VM instance. class PatchConfig @@ -1047,6 +1561,213 @@ module Google end end + # A resource that manages a package repository. + class RepositoryResource + include Google::Apis::Core::Hashable + + # Represents a single apt package repository. These will be added to a repo + # file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. + # Corresponds to the JSON property `apt` + # @return [Google::Apis::OsconfigV1::RepositoryResourceAptRepository] + attr_accessor :apt + + # Represents a Goo package repository. These will be added to a repo file + # that will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo. + # Corresponds to the JSON property `goo` + # @return [Google::Apis::OsconfigV1::RepositoryResourceGooRepository] + attr_accessor :goo + + # Represents a single yum package repository. These will be added to a repo + # file that will be managed at /etc/yum.repos.d/google_osconfig.repo. + # Corresponds to the JSON property `yum` + # @return [Google::Apis::OsconfigV1::RepositoryResourceYumRepository] + attr_accessor :yum + + # Represents a single zypper package repository. These will be added to a + # repo file that will be managed at /etc/zypp/repos.d/google_osconfig.repo. + # Corresponds to the JSON property `zypper` + # @return [Google::Apis::OsconfigV1::RepositoryResourceZypperRepository] + attr_accessor :zypper + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @apt = args[:apt] if args.key?(:apt) + @goo = args[:goo] if args.key?(:goo) + @yum = args[:yum] if args.key?(:yum) + @zypper = args[:zypper] if args.key?(:zypper) + end + end + + # Represents a single apt package repository. These will be added to a repo + # file that will be managed at /etc/apt/sources.list.d/google_osconfig.list. + class RepositoryResourceAptRepository + include Google::Apis::Core::Hashable + + # Type of archive files in this repository. The default behavior is DEB. + # Corresponds to the JSON property `archiveType` + # @return [String] + attr_accessor :archive_type + + # List of components for this repository. Must contain at least one item. + # Corresponds to the JSON property `components` + # @return [Array] + attr_accessor :components + + # Distribution of this repository. + # Corresponds to the JSON property `distribution` + # @return [String] + attr_accessor :distribution + + # URI of the key file for this repository. The agent will maintain + # a keyring at /etc/apt/trusted.gpg.d/osconfig_agent_managed.gpg. + # Corresponds to the JSON property `gpgKey` + # @return [String] + attr_accessor :gpg_key + + # URI for this repository. + # Corresponds to the JSON property `uri` + # @return [String] + attr_accessor :uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @archive_type = args[:archive_type] if args.key?(:archive_type) + @components = args[:components] if args.key?(:components) + @distribution = args[:distribution] if args.key?(:distribution) + @gpg_key = args[:gpg_key] if args.key?(:gpg_key) + @uri = args[:uri] if args.key?(:uri) + end + end + + # Represents a Goo package repository. These will be added to a repo file + # that will be managed at C:/ProgramData/GooGet/repos/google_osconfig.repo. + class RepositoryResourceGooRepository + include Google::Apis::Core::Hashable + + # The name of the repository. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The url of the repository. + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @url = args[:url] if args.key?(:url) + end + end + + # Represents a single yum package repository. These will be added to a repo + # file that will be managed at /etc/yum.repos.d/google_osconfig.repo. + class RepositoryResourceYumRepository + include Google::Apis::Core::Hashable + + # The location of the repository directory. + # Corresponds to the JSON property `baseUrl` + # @return [String] + attr_accessor :base_url + + # The display name of the repository. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # URIs of GPG keys. + # Corresponds to the JSON property `gpgKeys` + # @return [Array] + attr_accessor :gpg_keys + + # A one word, unique name for this repository. This will be + # the `repo id` in the yum config file and also the `display_name` if + # `display_name` is omitted. This id is also used as the unique identifier + # when checking for resource conflicts. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @base_url = args[:base_url] if args.key?(:base_url) + @display_name = args[:display_name] if args.key?(:display_name) + @gpg_keys = args[:gpg_keys] if args.key?(:gpg_keys) + @id = args[:id] if args.key?(:id) + end + end + + # Represents a single zypper package repository. These will be added to a + # repo file that will be managed at /etc/zypp/repos.d/google_osconfig.repo. + class RepositoryResourceZypperRepository + include Google::Apis::Core::Hashable + + # The location of the repository directory. + # Corresponds to the JSON property `baseUrl` + # @return [String] + attr_accessor :base_url + + # The display name of the repository. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # URIs of GPG keys. + # Corresponds to the JSON property `gpgKeys` + # @return [Array] + attr_accessor :gpg_keys + + # A one word, unique name for this repository. This will be + # the `repo id` in the zypper config file and also the `display_name` if + # `display_name` is omitted. This id is also used as the unique identifier + # when checking for GuestPolicy conflicts. + # Corresponds to the JSON property `id` + # @return [String] + attr_accessor :id + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @base_url = args[:base_url] if args.key?(:base_url) + @display_name = args[:display_name] if args.key?(:display_name) + @gpg_keys = args[:gpg_keys] if args.key?(:gpg_keys) + @id = args[:id] if args.key?(:id) + end + end + + # A resource that manages a system service. + class ServiceResource + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + # Represents a time of day. The date and time zone are either not significant # or are specified elsewhere. An API may choose to allow leap seconds. Related # types are google.type.Date and `google.protobuf.Timestamp`. diff --git a/generated/google/apis/osconfig_v1/representations.rb b/generated/google/apis/osconfig_v1/representations.rb index 69177d359..acaab92cf 100644 --- a/generated/google/apis/osconfig_v1/representations.rb +++ b/generated/google/apis/osconfig_v1/representations.rb @@ -40,6 +40,18 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ExecResource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ExecResourceExec + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class ExecStep class Representation < Google::Apis::Core::JsonRepresentation; end @@ -58,6 +70,36 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class ExtractArchiveResource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class File + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FileGcs + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FileRemote + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class FileResource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class FixedOrPercent class Representation < Google::Apis::Core::JsonRepresentation; end @@ -106,6 +148,54 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class PackageResource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PackageResourceApt + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PackageResourceDeb + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PackageResourceGooGet + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PackageResourceMsi + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PackageResourceRpm + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PackageResourceYum + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class PackageResourceZypper + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class PatchConfig class Representation < Google::Apis::Core::JsonRepresentation; end @@ -160,6 +250,42 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class RepositoryResource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RepositoryResourceAptRepository + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RepositoryResourceGooRepository + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RepositoryResourceYumRepository + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class RepositoryResourceZypperRepository + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class ServiceResource + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class TimeOfDay class Representation < Google::Apis::Core::JsonRepresentation; end @@ -223,6 +349,28 @@ module Google end end + class ExecResource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :enforce, as: 'enforce', class: Google::Apis::OsconfigV1::ExecResourceExec, decorator: Google::Apis::OsconfigV1::ExecResourceExec::Representation + + property :validate, as: 'validate', class: Google::Apis::OsconfigV1::ExecResourceExec, decorator: Google::Apis::OsconfigV1::ExecResourceExec::Representation + + end + end + + class ExecResourceExec + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :allowed_success_codes, as: 'allowedSuccessCodes' + collection :args, as: 'args' + property :file, as: 'file', class: Google::Apis::OsconfigV1::File, decorator: Google::Apis::OsconfigV1::File::Representation + + property :interpreter, as: 'interpreter' + property :script, as: 'script' + end + end + class ExecStep # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -260,6 +408,59 @@ module Google end end + class ExtractArchiveResource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :creates, as: 'creates' + property :destination, as: 'destination' + property :overwrite, as: 'overwrite' + property :source, as: 'source', class: Google::Apis::OsconfigV1::File, decorator: Google::Apis::OsconfigV1::File::Representation + + property :type, as: 'type' + end + end + + class File + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :allow_insecure, as: 'allowInsecure' + property :gcs, as: 'gcs', class: Google::Apis::OsconfigV1::FileGcs, decorator: Google::Apis::OsconfigV1::FileGcs::Representation + + property :local_path, as: 'localPath' + property :remote, as: 'remote', class: Google::Apis::OsconfigV1::FileRemote, decorator: Google::Apis::OsconfigV1::FileRemote::Representation + + end + end + + class FileGcs + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bucket, as: 'bucket' + property :generation, :numeric_string => true, as: 'generation' + property :object, as: 'object' + end + end + + class FileRemote + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :sha256_checksum, as: 'sha256Checksum' + property :uri, as: 'uri' + end + end + + class FileResource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content, as: 'content' + property :file, as: 'file', class: Google::Apis::OsconfigV1::File, decorator: Google::Apis::OsconfigV1::File::Representation + + property :path, as: 'path' + property :permissions, as: 'permissions' + property :state, as: 'state' + end + end + class FixedOrPercent # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -326,6 +527,83 @@ module Google end end + class PackageResource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :apt, as: 'apt', class: Google::Apis::OsconfigV1::PackageResourceApt, decorator: Google::Apis::OsconfigV1::PackageResourceApt::Representation + + property :deb, as: 'deb', class: Google::Apis::OsconfigV1::PackageResourceDeb, decorator: Google::Apis::OsconfigV1::PackageResourceDeb::Representation + + property :desired_state, as: 'desiredState' + property :googet, as: 'googet', class: Google::Apis::OsconfigV1::PackageResourceGooGet, decorator: Google::Apis::OsconfigV1::PackageResourceGooGet::Representation + + property :msi, as: 'msi', class: Google::Apis::OsconfigV1::PackageResourceMsi, decorator: Google::Apis::OsconfigV1::PackageResourceMsi::Representation + + property :rpm, as: 'rpm', class: Google::Apis::OsconfigV1::PackageResourceRpm, decorator: Google::Apis::OsconfigV1::PackageResourceRpm::Representation + + property :yum, as: 'yum', class: Google::Apis::OsconfigV1::PackageResourceYum, decorator: Google::Apis::OsconfigV1::PackageResourceYum::Representation + + property :zypper, as: 'zypper', class: Google::Apis::OsconfigV1::PackageResourceZypper, decorator: Google::Apis::OsconfigV1::PackageResourceZypper::Representation + + end + end + + class PackageResourceApt + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + end + end + + class PackageResourceDeb + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :pull_deps, as: 'pullDeps' + property :source, as: 'source', class: Google::Apis::OsconfigV1::File, decorator: Google::Apis::OsconfigV1::File::Representation + + end + end + + class PackageResourceGooGet + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + end + end + + class PackageResourceMsi + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :allowed_success_codes, as: 'allowedSuccessCodes' + collection :flags, as: 'flags' + property :source, as: 'source', class: Google::Apis::OsconfigV1::File, decorator: Google::Apis::OsconfigV1::File::Representation + + end + end + + class PackageResourceRpm + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :pull_deps, as: 'pullDeps' + property :source, as: 'source', class: Google::Apis::OsconfigV1::File, decorator: Google::Apis::OsconfigV1::File::Representation + + end + end + + class PackageResourceYum + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + end + end + + class PackageResourceZypper + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + end + end + class PatchConfig # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -473,6 +751,65 @@ module Google end end + class RepositoryResource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :apt, as: 'apt', class: Google::Apis::OsconfigV1::RepositoryResourceAptRepository, decorator: Google::Apis::OsconfigV1::RepositoryResourceAptRepository::Representation + + property :goo, as: 'goo', class: Google::Apis::OsconfigV1::RepositoryResourceGooRepository, decorator: Google::Apis::OsconfigV1::RepositoryResourceGooRepository::Representation + + property :yum, as: 'yum', class: Google::Apis::OsconfigV1::RepositoryResourceYumRepository, decorator: Google::Apis::OsconfigV1::RepositoryResourceYumRepository::Representation + + property :zypper, as: 'zypper', class: Google::Apis::OsconfigV1::RepositoryResourceZypperRepository, decorator: Google::Apis::OsconfigV1::RepositoryResourceZypperRepository::Representation + + end + end + + class RepositoryResourceAptRepository + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :archive_type, as: 'archiveType' + collection :components, as: 'components' + property :distribution, as: 'distribution' + property :gpg_key, as: 'gpgKey' + property :uri, as: 'uri' + end + end + + class RepositoryResourceGooRepository + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + property :url, as: 'url' + end + end + + class RepositoryResourceYumRepository + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :base_url, as: 'baseUrl' + property :display_name, as: 'displayName' + collection :gpg_keys, as: 'gpgKeys' + property :id, as: 'id' + end + end + + class RepositoryResourceZypperRepository + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :base_url, as: 'baseUrl' + property :display_name, as: 'displayName' + collection :gpg_keys, as: 'gpgKeys' + property :id, as: 'id' + end + end + + class ServiceResource + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + class TimeOfDay # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/policytroubleshooter_v1.rb b/generated/google/apis/policytroubleshooter_v1.rb index 5c464a763..5bcb1c6ca 100644 --- a/generated/google/apis/policytroubleshooter_v1.rb +++ b/generated/google/apis/policytroubleshooter_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/iam/ module PolicytroubleshooterV1 VERSION = 'V1' - REVISION = '20200606' + 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/policytroubleshooter_v1/classes.rb b/generated/google/apis/policytroubleshooter_v1/classes.rb index 291bbc8cc..bf5451a94 100644 --- a/generated/google/apis/policytroubleshooter_v1/classes.rb +++ b/generated/google/apis/policytroubleshooter_v1/classes.rb @@ -26,31 +26,28 @@ module Google class GoogleCloudPolicytroubleshooterV1AccessTuple include Google::Apis::Core::Hashable - # Required. The full resource name that identifies the resource. For example, - # `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my- - # instance`. - # For examples of full resource names for Google Cloud services, see + # Required. The full resource name that identifies the resource. For example, `// + # compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my- + # instance`. For examples of full resource names for Google Cloud services, see # https://cloud.google.com/iam/help/troubleshooter/full-resource-names. # Corresponds to the JSON property `fullResourceName` # @return [String] attr_accessor :full_resource_name # Required. The IAM permission to check for the specified member and resource. - # For a complete list of IAM permissions, see - # https://cloud.google.com/iam/help/permissions/reference. - # For a complete list of predefined IAM roles and the permissions in each - # role, see https://cloud.google.com/iam/help/roles/reference. + # For a complete list of IAM permissions, see https://cloud.google.com/iam/help/ + # permissions/reference. For a complete list of predefined IAM roles and the + # permissions in each role, see https://cloud.google.com/iam/help/roles/ + # reference. # Corresponds to the JSON property `permission` # @return [String] attr_accessor :permission # Required. The member, or principal, whose access you want to check, in the - # form of - # the email address that represents that member. For example, - # `alice@example.com` or - # `my-service-account@my-project.iam.gserviceaccount.com`. - # The member must be a Google Account or a service account. Other types of - # members are not supported. + # form of the email address that represents that member. For example, `alice@ + # example.com` or `my-service-account@my-project.iam.gserviceaccount.com`. The + # member must be a Google Account or a service account. Other types of members + # are not supported. # Corresponds to the JSON property `principal` # @return [String] attr_accessor :principal @@ -73,58 +70,45 @@ module Google include Google::Apis::Core::Hashable # Required. Indicates whether _this binding_ provides the specified permission - # to the - # specified member for the specified resource. - # This field does _not_ indicate whether the member actually has the - # permission for the resource. There might be another binding that overrides - # this binding. To determine whether the member actually has the permission, - # use the `access` field in the + # to the specified member for the specified resource. This field does _not_ + # indicate whether the member actually has the permission for the resource. + # There might be another binding that overrides this binding. To determine + # whether the member actually has the permission, use the `access` field in the # TroubleshootIamPolicyResponse. # Corresponds to the JSON property `access` # @return [String] attr_accessor :access - # 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::PolicytroubleshooterV1::GoogleTypeExpr] attr_accessor :condition - # Indicates whether each member in the binding includes the member specified - # in the request, either directly or indirectly. Each key identifies a member - # in the binding, and each value indicates whether the member in the binding - # includes the member in the request. - # For example, suppose that a binding includes the following members: - # * `user:alice@example.com` - # * `group:product-eng@example.com` - # You want to troubleshoot access for `user:bob@example.com`. This user is a - # member of the group `group:product-eng@example.com`. - # For the first member in the binding, the key is `user:alice@example.com`, - # and the `membership` field in the value is set to - # `MEMBERSHIP_NOT_INCLUDED`. - # For the second member in the binding, the key is - # `group:product-eng@example.com`, and the `membership` field in the value is - # set to `MEMBERSHIP_INCLUDED`. + # Indicates whether each member in the binding includes the member specified in + # the request, either directly or indirectly. Each key identifies a member in + # the binding, and each value indicates whether the member in the binding + # includes the member in the request. For example, suppose that a binding + # includes the following members: * `user:alice@example.com` * `group:product- + # eng@example.com` You want to troubleshoot access for `user:bob@example.com`. + # This user is a member of the group `group:product-eng@example.com`. For the + # first member in the binding, the key is `user:alice@example.com`, and the ` + # membership` field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. For the + # second member in the binding, the key is `group:product-eng@example.com`, and + # the `membership` field in the value is set to `MEMBERSHIP_INCLUDED`. # Corresponds to the JSON property `memberships` # @return [Hash] attr_accessor :memberships @@ -135,8 +119,7 @@ module Google # @return [String] attr_accessor :relevance - # The role that this binding grants. For example, - # `roles/compute.serviceAgent`. + # The role that this binding grants. For example, `roles/compute.serviceAgent`. # For a complete list of predefined IAM roles, as well as the permissions in # each role, see https://cloud.google.com/iam/help/roles/reference. # Corresponds to the JSON property `role` @@ -149,8 +132,8 @@ module Google # @return [String] attr_accessor :role_permission - # The relevance of the permission's existence, or nonexistence, in the role - # to the overall determination for the entire policy. + # The relevance of the permission's existence, or nonexistence, in the role to + # the overall determination for the entire policy. # Corresponds to the JSON property `rolePermissionRelevance` # @return [String] attr_accessor :role_permission_relevance @@ -197,110 +180,70 @@ module Google end end - # Details about how a specific IAM Policy contributed - # to the access check. + # Details about how a specific IAM Policy contributed to the access check. class GoogleCloudPolicytroubleshooterV1ExplainedPolicy include Google::Apis::Core::Hashable # Indicates whether _this policy_ provides the specified permission to the - # specified member for the specified resource. - # This field does _not_ indicate whether the member actually has the - # permission for the resource. There might be another policy that overrides - # this policy. To determine whether the member actually has the permission, - # use the `access` field in the + # specified member for the specified resource. This field does _not_ indicate + # whether the member actually has the permission for the resource. There might + # be another policy that overrides this policy. To determine whether the member + # actually has the permission, use the `access` field in the # TroubleshootIamPolicyResponse. # Corresponds to the JSON property `access` # @return [String] attr_accessor :access - # Details about how each binding in the policy affects the member's ability, - # or inability, to use the permission for the resource. - # If the sender of the request does not have access to the policy, this field - # is omitted. + # Details about how each binding in the policy affects the member's ability, or + # inability, to use the permission for the resource. If the sender of the + # request does not have access to the policy, this field is omitted. # Corresponds to the JSON property `bindingExplanations` # @return [Array] attr_accessor :binding_explanations - # The full resource name that identifies the resource. For example, - # `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my- - # instance`. - # If the sender of the request does not have access to the policy, this field - # is omitted. - # For examples of full resource names for Google Cloud services, see + # The full resource name that identifies the resource. For example, `//compute. + # googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. + # If the sender of the request does not have access to the policy, this field is + # omitted. For examples of full resource names for Google Cloud services, see # https://cloud.google.com/iam/help/troubleshooter/full-resource-names. # Corresponds to the JSON property `fullResourceName` # @return [String] attr_accessor :full_resource_name # 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::PolicytroubleshooterV1::GoogleIamV1Policy] attr_accessor :policy # The relevance of this policy to the overall determination in the - # TroubleshootIamPolicyResponse. - # If the sender of the request does not have access to the policy, this field - # is omitted. + # TroubleshootIamPolicyResponse. If the sender of the request does not have + # access to the policy, this field is omitted. # Corresponds to the JSON property `relevance` # @return [String] attr_accessor :relevance @@ -349,13 +292,12 @@ module Google attr_accessor :access # List of IAM policies that were evaluated to check the member's permissions, - # with annotations to indicate how each policy contributed to the final - # result. + # with annotations to indicate how each policy contributed to the final result. # The list of policies can include the policy for the resource itself. It can # also include policies that are inherited from higher levels of the resource - # hierarchy, including the organization, the folder, and the project. - # To learn more about the resource hierarchy, see - # https://cloud.google.com/iam/help/resource-hierarchy. + # hierarchy, including the organization, the folder, and the project. To learn + # more about the resource hierarchy, see https://cloud.google.com/iam/help/ + # resource-hierarchy. # Corresponds to the JSON property `explainedPolicies` # @return [Array] attr_accessor :explained_policies @@ -371,53 +313,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 GoogleIamV1AuditConfig include Google::Apis::Core::Hashable @@ -426,9 +336,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 @@ -444,28 +354,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 GoogleIamV1AuditLogConfig 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] @@ -491,69 +388,57 @@ module Google class GoogleIamV1Binding 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::PolicytroubleshooterV1::GoogleTypeExpr] 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 @@ -571,66 +456,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 GoogleIamV1Policy include Google::Apis::Core::Hashable @@ -639,48 +490,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 @@ -698,52 +545,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 GoogleTypeExpr 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 diff --git a/generated/google/apis/policytroubleshooter_v1/service.rb b/generated/google/apis/policytroubleshooter_v1/service.rb index 4659d9df1..eb51abbae 100644 --- a/generated/google/apis/policytroubleshooter_v1/service.rb +++ b/generated/google/apis/policytroubleshooter_v1/service.rb @@ -47,8 +47,8 @@ module Google @batch_path = 'batch' end - # Checks whether a member has a specific permission for a specific resource, - # and explains why the member does or does not have that permission. + # Checks whether a member has a specific permission for a specific resource, and + # explains why the member does or does not have that permission. # @param [Google::Apis::PolicytroubleshooterV1::GoogleCloudPolicytroubleshooterV1TroubleshootIamPolicyRequest] google_cloud_policytroubleshooter_v1_troubleshoot_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/policytroubleshooter_v1beta.rb b/generated/google/apis/policytroubleshooter_v1beta.rb index d66f8a2d0..82b943299 100644 --- a/generated/google/apis/policytroubleshooter_v1beta.rb +++ b/generated/google/apis/policytroubleshooter_v1beta.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/iam/ module PolicytroubleshooterV1beta VERSION = 'V1beta' - REVISION = '20200606' + 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/policytroubleshooter_v1beta/classes.rb b/generated/google/apis/policytroubleshooter_v1beta/classes.rb index 8cf14144e..e76e0809b 100644 --- a/generated/google/apis/policytroubleshooter_v1beta/classes.rb +++ b/generated/google/apis/policytroubleshooter_v1beta/classes.rb @@ -26,31 +26,28 @@ module Google class GoogleCloudPolicytroubleshooterV1betaAccessTuple include Google::Apis::Core::Hashable - # Required. The full resource name that identifies the resource. For example, - # `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my- - # instance`. - # For examples of full resource names for Google Cloud services, see + # Required. The full resource name that identifies the resource. For example, `// + # compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my- + # instance`. For examples of full resource names for Google Cloud services, see # https://cloud.google.com/iam/help/troubleshooter/full-resource-names. # Corresponds to the JSON property `fullResourceName` # @return [String] attr_accessor :full_resource_name # Required. The IAM permission to check for the specified member and resource. - # For a complete list of IAM permissions, see - # https://cloud.google.com/iam/help/permissions/reference. - # For a complete list of predefined IAM roles and the permissions in each - # role, see https://cloud.google.com/iam/help/roles/reference. + # For a complete list of IAM permissions, see https://cloud.google.com/iam/help/ + # permissions/reference. For a complete list of predefined IAM roles and the + # permissions in each role, see https://cloud.google.com/iam/help/roles/ + # reference. # Corresponds to the JSON property `permission` # @return [String] attr_accessor :permission # Required. The member, or principal, whose access you want to check, in the - # form of - # the email address that represents that member. For example, - # `alice@example.com` or - # `my-service-account@my-project.iam.gserviceaccount.com`. - # The member must be a Google Account or a service account. Other types of - # members are not supported. + # form of the email address that represents that member. For example, `alice@ + # example.com` or `my-service-account@my-project.iam.gserviceaccount.com`. The + # member must be a Google Account or a service account. Other types of members + # are not supported. # Corresponds to the JSON property `principal` # @return [String] attr_accessor :principal @@ -73,57 +70,45 @@ module Google include Google::Apis::Core::Hashable # Indicates whether _this binding_ provides the specified permission to the - # specified member for the specified resource. - # This field does _not_ indicate whether the member actually has the - # permission for the resource. There might be another binding that overrides - # this binding. To determine whether the member actually has the permission, - # use the `access` field in the + # specified member for the specified resource. This field does _not_ indicate + # whether the member actually has the permission for the resource. There might + # be another binding that overrides this binding. To determine whether the + # member actually has the permission, use the `access` field in the # TroubleshootIamPolicyResponse. # Corresponds to the JSON property `access` # @return [String] attr_accessor :access - # 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::PolicytroubleshooterV1beta::GoogleTypeExpr] attr_accessor :condition - # Indicates whether each member in the binding includes the member specified - # in the request, either directly or indirectly. Each key identifies a member - # in the binding, and each value indicates whether the member in the binding - # includes the member in the request. - # For example, suppose that a binding includes the following members: - # * `user:alice@example.com` - # * `group:product-eng@example.com` - # You want to troubleshoot access for `user:bob@example.com`. This user is a - # member of the group `group:product-eng@example.com`. - # For the first member in the binding, the key is `user:alice@example.com`, - # and the `membership` field in the value is set to - # `MEMBERSHIP_NOT_INCLUDED`. - # For the second member in the binding, the key is - # `group:product-eng@example.com`, and the `membership` field in the value is - # set to `MEMBERSHIP_INCLUDED`. + # Indicates whether each member in the binding includes the member specified in + # the request, either directly or indirectly. Each key identifies a member in + # the binding, and each value indicates whether the member in the binding + # includes the member in the request. For example, suppose that a binding + # includes the following members: * `user:alice@example.com` * `group:product- + # eng@example.com` You want to troubleshoot access for `user:bob@example.com`. + # This user is a member of the group `group:product-eng@example.com`. For the + # first member in the binding, the key is `user:alice@example.com`, and the ` + # membership` field in the value is set to `MEMBERSHIP_NOT_INCLUDED`. For the + # second member in the binding, the key is `group:product-eng@example.com`, and + # the `membership` field in the value is set to `MEMBERSHIP_INCLUDED`. # Corresponds to the JSON property `memberships` # @return [Hash] attr_accessor :memberships @@ -134,8 +119,7 @@ module Google # @return [String] attr_accessor :relevance - # The role that this binding grants. For example, - # `roles/compute.serviceAgent`. + # The role that this binding grants. For example, `roles/compute.serviceAgent`. # For a complete list of predefined IAM roles, as well as the permissions in # each role, see https://cloud.google.com/iam/help/roles/reference. # Corresponds to the JSON property `role` @@ -148,8 +132,8 @@ module Google # @return [String] attr_accessor :role_permission - # The relevance of the permission's existence, or nonexistence, in the role - # to the overall determination for the entire policy. + # The relevance of the permission's existence, or nonexistence, in the role to + # the overall determination for the entire policy. # Corresponds to the JSON property `rolePermissionRelevance` # @return [String] attr_accessor :role_permission_relevance @@ -196,110 +180,70 @@ module Google end end - # Details about how a specific IAM Policy contributed - # to the access check. + # Details about how a specific IAM Policy contributed to the access check. class GoogleCloudPolicytroubleshooterV1betaExplainedPolicy include Google::Apis::Core::Hashable # Indicates whether _this policy_ provides the specified permission to the - # specified member for the specified resource. - # This field does _not_ indicate whether the member actually has the - # permission for the resource. There might be another policy that overrides - # this policy. To determine whether the member actually has the permission, - # use the `access` field in the + # specified member for the specified resource. This field does _not_ indicate + # whether the member actually has the permission for the resource. There might + # be another policy that overrides this policy. To determine whether the member + # actually has the permission, use the `access` field in the # TroubleshootIamPolicyResponse. # Corresponds to the JSON property `access` # @return [String] attr_accessor :access - # Details about how each binding in the policy affects the member's ability, - # or inability, to use the permission for the resource. - # If the sender of the request does not have access to the policy, this field - # is omitted. + # Details about how each binding in the policy affects the member's ability, or + # inability, to use the permission for the resource. If the sender of the + # request does not have access to the policy, this field is omitted. # Corresponds to the JSON property `bindingExplanations` # @return [Array] attr_accessor :binding_explanations - # The full resource name that identifies the resource. For example, - # `//compute.googleapis.com/projects/my-project/zones/us-central1-a/instances/my- - # instance`. - # If the sender of the request does not have access to the policy, this field - # is omitted. - # For examples of full resource names for Google Cloud services, see + # The full resource name that identifies the resource. For example, `//compute. + # googleapis.com/projects/my-project/zones/us-central1-a/instances/my-instance`. + # If the sender of the request does not have access to the policy, this field is + # omitted. For examples of full resource names for Google Cloud services, see # https://cloud.google.com/iam/help/troubleshooter/full-resource-names. # Corresponds to the JSON property `fullResourceName` # @return [String] attr_accessor :full_resource_name # 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::PolicytroubleshooterV1beta::GoogleIamV1Policy] attr_accessor :policy # The relevance of this policy to the overall determination in the - # TroubleshootIamPolicyResponse. - # If the sender of the request does not have access to the policy, this field - # is omitted. + # TroubleshootIamPolicyResponse. If the sender of the request does not have + # access to the policy, this field is omitted. # Corresponds to the JSON property `relevance` # @return [String] attr_accessor :relevance @@ -348,13 +292,12 @@ module Google attr_accessor :access # List of IAM policies that were evaluated to check the member's permissions, - # with annotations to indicate how each policy contributed to the final - # result. + # with annotations to indicate how each policy contributed to the final result. # The list of policies can include the policy for the resource itself. It can # also include policies that are inherited from higher levels of the resource - # hierarchy, including the organization, the folder, and the project. - # To learn more about the resource hierarchy, see - # https://cloud.google.com/iam/help/resource-hierarchy. + # hierarchy, including the organization, the folder, and the project. To learn + # more about the resource hierarchy, see https://cloud.google.com/iam/help/ + # resource-hierarchy. # Corresponds to the JSON property `explainedPolicies` # @return [Array] attr_accessor :explained_policies @@ -370,53 +313,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 GoogleIamV1AuditConfig include Google::Apis::Core::Hashable @@ -425,9 +336,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 @@ -443,28 +354,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 GoogleIamV1AuditLogConfig 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] @@ -490,69 +388,57 @@ module Google class GoogleIamV1Binding 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::PolicytroubleshooterV1beta::GoogleTypeExpr] 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 @@ -570,66 +456,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 GoogleIamV1Policy include Google::Apis::Core::Hashable @@ -638,48 +490,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 @@ -697,52 +545,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 GoogleTypeExpr 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 diff --git a/generated/google/apis/policytroubleshooter_v1beta/service.rb b/generated/google/apis/policytroubleshooter_v1beta/service.rb index b181ff3d5..0bdb4b827 100644 --- a/generated/google/apis/policytroubleshooter_v1beta/service.rb +++ b/generated/google/apis/policytroubleshooter_v1beta/service.rb @@ -47,8 +47,8 @@ module Google @batch_path = 'batch' end - # Checks whether a member has a specific permission for a specific resource, - # and explains why the member does or does not have that permission. + # Checks whether a member has a specific permission for a specific resource, and + # explains why the member does or does not have that permission. # @param [Google::Apis::PolicytroubleshooterV1beta::GoogleCloudPolicytroubleshooterV1betaTroubleshootIamPolicyRequest] google_cloud_policytroubleshooter_v1beta_troubleshoot_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/recommender_v1.rb b/generated/google/apis/recommender_v1.rb index 22abd7ed7..737228ec4 100644 --- a/generated/google/apis/recommender_v1.rb +++ b/generated/google/apis/recommender_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/recommender/docs/ module RecommenderV1 VERSION = 'V1' - REVISION = '20200704' + 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/recommender_v1/classes.rb b/generated/google/apis/recommender_v1/classes.rb index e16052d81..3556ec61b 100644 --- a/generated/google/apis/recommender_v1/classes.rb +++ b/generated/google/apis/recommender_v1/classes.rb @@ -87,8 +87,8 @@ module Google # @return [String] attr_accessor :category - # A struct of custom fields to explain the insight. - # Example: "grantedPermissionsCount": "1000" + # A struct of custom fields to explain the insight. Example: " + # grantedPermissionsCount": "1000" # Corresponds to the JSON property `content` # @return [Hash] attr_accessor :content @@ -99,8 +99,7 @@ module Google # @return [String] attr_accessor :description - # Fingerprint of the Insight. Provides optimistic locking when updating - # states. + # Fingerprint of the Insight. Provides optimistic locking when updating states. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag @@ -120,9 +119,9 @@ module Google # @return [String] attr_accessor :name - # Observation period that led to the insight. The source data used to - # generate the insight ends at last_refresh_time and begins at - # (last_refresh_time - observation_period). + # Observation period that led to the insight. The source data used to generate + # the insight ends at last_refresh_time and begins at (last_refresh_time - + # observation_period). # Corresponds to the JSON property `observationPeriod` # @return [String] attr_accessor :observation_period @@ -161,9 +160,8 @@ module Google class GoogleCloudRecommenderV1InsightRecommendationReference include Google::Apis::Core::Hashable - # Recommendation resource name, e.g. - # projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/ - # recommendations/[RECOMMENDATION_ID] + # Recommendation resource name, e.g. projects/[PROJECT_NUMBER]/locations/[ + # LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] # Corresponds to the JSON property `recommendation` # @return [String] attr_accessor :recommendation @@ -264,9 +262,8 @@ module Google # @return [String] attr_accessor :etag - # Optional. State properties user wish to include with this state. Full replace - # of the - # current state_metadata. + # Optional. State properties user wish to include with this state. Full replace + # of the current state_metadata. # Corresponds to the JSON property `stateMetadata` # @return [Hash] attr_accessor :state_metadata @@ -291,10 +288,9 @@ module Google # @return [String] attr_accessor :etag - # State properties to include with this state. Overwrites any existing - # `state_metadata`. - # Keys must match the regex /^a-z0-9`0,62`$/. - # Values must match the regex /^[a-zA-Z0-9_./-]`0,255`$/. + # State properties to include with this state. Overwrites any existing ` + # state_metadata`. Keys must match the regex /^a-z0-9`0,62`$/. Values must match + # the regex /^[a-zA-Z0-9_./-]`0,255`$/. # Corresponds to the JSON property `stateMetadata` # @return [Hash] attr_accessor :state_metadata @@ -319,10 +315,9 @@ module Google # @return [String] attr_accessor :etag - # State properties to include with this state. Overwrites any existing - # `state_metadata`. - # Keys must match the regex /^a-z0-9`0,62`$/. - # Values must match the regex /^[a-zA-Z0-9_./-]`0,255`$/. + # State properties to include with this state. Overwrites any existing ` + # state_metadata`. Keys must match the regex /^a-z0-9`0,62`$/. Values must match + # the regex /^[a-zA-Z0-9_./-]`0,255`$/. # Corresponds to the JSON property `stateMetadata` # @return [Hash] attr_accessor :state_metadata @@ -347,10 +342,9 @@ module Google # @return [String] attr_accessor :etag - # State properties to include with this state. Overwrites any existing - # `state_metadata`. - # Keys must match the regex /^a-z0-9`0,62`$/. - # Values must match the regex /^[a-zA-Z0-9_./-]`0,255`$/. + # State properties to include with this state. Overwrites any existing ` + # state_metadata`. Keys must match the regex /^a-z0-9`0,62`$/. Values must match + # the regex /^[a-zA-Z0-9_./-]`0,255`$/. # Corresponds to the JSON property `stateMetadata` # @return [Hash] attr_accessor :state_metadata @@ -367,19 +361,17 @@ module Google end # Contains an operation for a resource loosely based on the JSON-PATCH format - # with support for: - # * Custom filters for describing partial array patch. - # * Extended path values for describing nested arrays. - # * Custom fields for describing the resource for which the operation is being - # described. - # * Allows extension to custom operations not natively supported by RFC6902. - # See https://tools.ietf.org/html/rfc6902 for details on the original RFC. + # with support for: * Custom filters for describing partial array patch. * + # Extended path values for describing nested arrays. * Custom fields for + # describing the resource for which the operation is being described. * Allows + # extension to custom operations not natively supported by RFC6902. See https:// + # tools.ietf.org/html/rfc6902 for details on the original RFC. class GoogleCloudRecommenderV1Operation include Google::Apis::Core::Hashable - # Type of this operation. Contains one of 'and', 'remove', 'replace', 'move', - # 'copy', 'test' and custom operations. This field is case-insensitive and - # always populated. + # Type of this operation. Contains one of 'and', 'remove', 'replace', 'move', ' + # copy', 'test' and custom operations. This field is case-insensitive and always + # populated. # Corresponds to the JSON property `action` # @return [String] attr_accessor :action @@ -392,45 +384,34 @@ module Google # Set of filters to apply if `path` refers to array elements or nested array # elements in order to narrow down to a single unique element that is being - # tested/modified. - # This is intended to be an exact match per filter. To perform advanced - # matching, use path_value_matchers. - # * Example: ` - # "/versions/*/name" : "it-123" - # "/versions/*/targetSize/percent": 20 - # ` - # * Example: ` - # "/bindings/*/role": "roles/admin" - # "/bindings/*/condition" : null - # ` - # * Example: ` - # "/bindings/*/role": "roles/admin" - # "/bindings/*/members/*" : ["x@google.com", "y@google.com"] - # ` - # When both path_filters and path_value_matchers are set, an implicit AND - # must be performed. + # tested/modified. This is intended to be an exact match per filter. To perform + # advanced matching, use path_value_matchers. * Example: ` "/versions/*/name" : " + # it-123" "/versions/*/targetSize/percent": 20 ` * Example: ` "/bindings/*/role": + # "roles/admin" "/bindings/*/condition" : null ` * Example: ` "/bindings/*/role" + # : "roles/admin" "/bindings/*/members/*" : ["x@google.com", "y@google.com"] ` + # When both path_filters and path_value_matchers are set, an implicit AND must + # be performed. # Corresponds to the JSON property `pathFilters` # @return [Hash] attr_accessor :path_filters - # Similar to path_filters, this contains set of filters to apply if `path` - # field referes to array elements. This is meant to support value matching - # beyond exact match. To perform exact match, use path_filters. - # When both path_filters and path_value_matchers are set, an implicit AND - # must be performed. + # Similar to path_filters, this contains set of filters to apply if `path` field + # referes to array elements. This is meant to support value matching beyond + # exact match. To perform exact match, use path_filters. When both path_filters + # and path_value_matchers are set, an implicit AND must be performed. # Corresponds to the JSON property `pathValueMatchers` # @return [Hash] attr_accessor :path_value_matchers - # Contains the fully qualified resource name. This field is always populated. - # ex: //cloudresourcemanager.googleapis.com/projects/foo. + # Contains the fully qualified resource name. This field is always populated. ex: + # //cloudresourcemanager.googleapis.com/projects/foo. # Corresponds to the JSON property `resource` # @return [String] attr_accessor :resource # Type of GCP resource being modified/tested. This field is always populated. - # Example: cloudresourcemanager.googleapis.com/Project, - # compute.googleapis.com/Instance + # Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/ + # Instance # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -441,18 +422,17 @@ module Google # @return [String] attr_accessor :source_path - # Can be set with action 'copy' to copy resource configuration across - # different resources of the same type. Example: A resource clone can be - # done via action = 'copy', path = "/", from = "/", - # source_resource = and resource_name = . - # This field is empty for all other values of `action`. + # Can be set with action 'copy' to copy resource configuration across different + # resources of the same type. Example: A resource clone can be done via action = + # 'copy', path = "/", from = "/", source_resource = and resource_name = . This + # field is empty for all other values of `action`. # Corresponds to the JSON property `sourceResource` # @return [String] attr_accessor :source_resource - # Value for the `path` field. Will be set for actions:'add'/'replace'. - # Maybe set for action: 'test'. Either this or `value_matcher` will be set - # for 'test' operation. An exact match must be performed. + # Value for the `path` field. Will be set for actions:'add'/'replace'. Maybe set + # for action: 'test'. Either this or `value_matcher` will be set for 'test' + # operation. An exact match must be performed. # Corresponds to the JSON property `value` # @return [Object] attr_accessor :value @@ -507,8 +487,7 @@ module Google include Google::Apis::Core::Hashable # Optional set of additional impact that this recommendation may have when - # trying to optimize for the primary category. These may be positive - # or negative. + # trying to optimize for the primary category. These may be positive or negative. # Corresponds to the JSON property `additionalImpact` # @return [Array] attr_accessor :additional_impact @@ -529,14 +508,14 @@ module Google # @return [String] attr_accessor :description - # Fingerprint of the Recommendation. Provides optimistic locking when - # updating states. + # Fingerprint of the Recommendation. Provides optimistic locking when updating + # states. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # Last time this recommendation was refreshed by the system that created it - # in the first place. + # Last time this recommendation was refreshed by the system that created it in + # the first place. # Corresponds to the JSON property `lastRefreshTime` # @return [String] attr_accessor :last_refresh_time @@ -551,14 +530,13 @@ module Google # @return [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1Impact] attr_accessor :primary_impact - # Contains an identifier for a subtype of recommendations produced for the - # same recommender. Subtype is a function of content and impact, meaning a - # new subtype might be added when significant changes to `content` or - # `primary_impact.category` are introduced. See the Recommenders section - # to see a list of subtypes for a given Recommender. - # Examples: - # For recommender = "google.iam.policy.Recommender", - # recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" + # Contains an identifier for a subtype of recommendations produced for the same + # recommender. Subtype is a function of content and impact, meaning a new + # subtype might be added when significant changes to `content` or ` + # primary_impact.category` are introduced. See the Recommenders section to see a + # list of subtypes for a given Recommender. Examples: For recommender = "google. + # iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/" + # REPLACE_ROLE" # Corresponds to the JSON property `recommenderSubtype` # @return [String] attr_accessor :recommender_subtype @@ -591,9 +569,9 @@ module Google class GoogleCloudRecommenderV1RecommendationContent include Google::Apis::Core::Hashable - # Operations to one or more Google Cloud resources grouped in such a way - # that, all operations within one group are expected to be performed - # atomically and in an order. + # Operations to one or more Google Cloud resources grouped in such a way that, + # all operations within one group are expected to be performed atomically and in + # an order. # Corresponds to the JSON property `operationGroups` # @return [Array] attr_accessor :operation_groups @@ -612,9 +590,8 @@ module Google class GoogleCloudRecommenderV1RecommendationInsightReference include Google::Apis::Core::Hashable - # Insight resource name, e.g. - # projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/ - # insights/[INSIGHT_ID] + # Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/ + # insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] # Corresponds to the JSON property `insight` # @return [String] attr_accessor :insight @@ -658,9 +635,9 @@ module Google class GoogleCloudRecommenderV1ValueMatcher include Google::Apis::Core::Hashable - # To be used for full regex matching. The regular expression is using the - # Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be - # used with RE2::FullMatch + # To be used for full regex matching. The regular expression is using the Google + # RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2: + # :FullMatch # Corresponds to the JSON property `matchesPattern` # @return [String] attr_accessor :matches_pattern @@ -684,18 +661,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/recommender_v1/service.rb b/generated/google/apis/recommender_v1/service.rb index ff7449149..faec8b84f 100644 --- a/generated/google/apis/recommender_v1/service.rb +++ b/generated/google/apis/recommender_v1/service.rb @@ -47,8 +47,8 @@ module Google @batch_path = 'batch' end - # Gets the requested insight. Requires the recommender.*.get IAM permission - # for the specified insight type. + # Gets the requested insight. Requires the recommender.*.get IAM permission for + # the specified insight type. # @param [String] name # Required. Name of the insight. # @param [String] fields @@ -81,27 +81,21 @@ module Google # Lists insights for a Cloud project. Requires the recommender.*.list IAM # permission for the specified insight type. # @param [String] parent - # Required. The container resource on which to execute the request. - # Acceptable formats: - # 1. - # "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]" - # , - # LOCATION here refers to GCP Locations: - # https://cloud.google.com/about/locations/ + # Required. The container resource on which to execute the request. Acceptable + # formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[ + # INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google. + # com/about/locations/ # @param [String] filter # Optional. Filter expression to restrict the insights returned. Supported - # filter fields: state - # Eg: `state:"DISMISSED" or state:"ACTIVE" + # filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE" # @param [Fixnum] page_size - # Optional. The maximum number of results to return from this request. Non- - # positive - # values are ignored. If not specified, the server will determine the number - # of results to return. + # Optional. The maximum number of results to return from this request. Non- + # positive values are ignored. If not specified, the server will determine the + # number of results to return. # @param [String] page_token # Optional. If present, retrieves the next batch of results from the preceding - # call to - # this method. `page_token` must be the value of `next_page_token` from the - # previous response. The values of other method parameters must be identical + # call to this method. `page_token` must be the value of `next_page_token` from + # the previous response. The values of other method parameters must be identical # to those in the previous call. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -133,11 +127,11 @@ module Google execute_or_queue_command(command, &block) end - # Marks the Insight State as Accepted. Users can use this method to - # indicate to the Recommender API that they have applied some action based - # on the insight. This stops the insight content from being updated. - # MarkInsightAccepted can be applied to insights in ACTIVE state. Requires - # the recommender.*.update IAM permission for the specified insight. + # Marks the Insight State as Accepted. Users can use this method to indicate to + # the Recommender API that they have applied some action based on the insight. + # This stops the insight content from being updated. MarkInsightAccepted can be + # applied to insights in ACTIVE state. Requires the recommender.*.update IAM + # permission for the specified insight. # @param [String] name # Required. Name of the insight. # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkInsightAcceptedRequest] google_cloud_recommender_v1_mark_insight_accepted_request_object @@ -170,8 +164,8 @@ module Google execute_or_queue_command(command, &block) end - # Gets the requested recommendation. Requires the recommender.*.get - # IAM permission for the specified recommender. + # Gets the requested recommendation. Requires the recommender.*.get IAM + # permission for the specified recommender. # @param [String] name # Required. Name of the recommendation. # @param [String] fields @@ -201,29 +195,25 @@ module Google execute_or_queue_command(command, &block) end - # Lists recommendations for a Cloud project. Requires the recommender.*.list - # IAM permission for the specified recommender. + # Lists recommendations for a Cloud project. Requires the recommender.*.list IAM + # permission for the specified recommender. # @param [String] parent - # Required. The container resource on which to execute the request. - # Acceptable formats: - # 1. - # "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", - # LOCATION here refers to GCP Locations: - # https://cloud.google.com/about/locations/ + # Required. The container resource on which to execute the request. Acceptable + # formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[ + # RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google. + # com/about/locations/ # @param [String] filter - # Filter expression to restrict the recommendations returned. Supported - # filter fields: state_info.state - # Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED" + # Filter expression to restrict the recommendations returned. Supported filter + # fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state: + # "FAILED" # @param [Fixnum] page_size - # Optional. The maximum number of results to return from this request. Non- - # positive - # values are ignored. If not specified, the server will determine the number - # of results to return. + # Optional. The maximum number of results to return from this request. Non- + # positive values are ignored. If not specified, the server will determine the + # number of results to return. # @param [String] page_token # Optional. If present, retrieves the next batch of results from the preceding - # call to - # this method. `page_token` must be the value of `next_page_token` from the - # previous response. The values of other method parameters must be identical + # call to this method. `page_token` must be the value of `next_page_token` from + # the previous response. The values of other method parameters must be identical # to those in the previous call. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -260,9 +250,8 @@ module Google # recommendation themselves. This stops the recommendation content from being # updated. Associated insights are frozen and placed in the ACCEPTED state. # MarkRecommendationClaimed can be applied to recommendations in CLAIMED, - # SUCCEEDED, FAILED, or ACTIVE state. - # Requires the recommender.*.update IAM permission for the specified - # recommender. + # SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM + # permission for the specified recommender. # @param [String] name # Required. Name of the recommendation. # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationClaimedRequest] google_cloud_recommender_v1_mark_recommendation_claimed_request_object @@ -298,12 +287,10 @@ module Google # Marks the Recommendation State as Failed. Users can use this method to # indicate to the Recommender API that they have applied the recommendation # themselves, and the operation failed. This stops the recommendation content - # from being updated. Associated insights are frozen and placed in the - # ACCEPTED state. - # MarkRecommendationFailed can be applied to recommendations in ACTIVE, - # CLAIMED, SUCCEEDED, or FAILED state. - # Requires the recommender.*.update IAM permission for the specified - # recommender. + # from being updated. Associated insights are frozen and placed in the ACCEPTED + # state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, + # CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM + # permission for the specified recommender. # @param [String] name # Required. Name of the recommendation. # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationFailedRequest] google_cloud_recommender_v1_mark_recommendation_failed_request_object @@ -339,12 +326,10 @@ module Google # Marks the Recommendation State as Succeeded. Users can use this method to # indicate to the Recommender API that they have applied the recommendation # themselves, and the operation was successful. This stops the recommendation - # content from being updated. Associated insights are frozen and placed in - # the ACCEPTED state. - # MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, - # CLAIMED, SUCCEEDED, or FAILED state. - # Requires the recommender.*.update IAM permission for the specified - # recommender. + # content from being updated. Associated insights are frozen and placed in the + # ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations + # in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*. + # update IAM permission for the specified recommender. # @param [String] name # Required. Name of the recommendation. # @param [Google::Apis::RecommenderV1::GoogleCloudRecommenderV1MarkRecommendationSucceededRequest] google_cloud_recommender_v1_mark_recommendation_succeeded_request_object diff --git a/generated/google/apis/recommender_v1beta1.rb b/generated/google/apis/recommender_v1beta1.rb index 0e5f4fee7..6f6d42ee3 100644 --- a/generated/google/apis/recommender_v1beta1.rb +++ b/generated/google/apis/recommender_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/recommender/docs/ module RecommenderV1beta1 VERSION = 'V1beta1' - REVISION = '20200313' + 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/recommender_v1beta1/classes.rb b/generated/google/apis/recommender_v1beta1/classes.rb index 11ae8522b..0358905f7 100644 --- a/generated/google/apis/recommender_v1beta1/classes.rb +++ b/generated/google/apis/recommender_v1beta1/classes.rb @@ -87,8 +87,8 @@ module Google # @return [String] attr_accessor :category - # A struct of custom fields to explain the insight. - # Example: "grantedPermissionsCount": "1000" + # A struct of custom fields to explain the insight. Example: " + # grantedPermissionsCount": "1000" # Corresponds to the JSON property `content` # @return [Hash] attr_accessor :content @@ -99,8 +99,7 @@ module Google # @return [String] attr_accessor :description - # Fingerprint of the Insight. Provides optimistic locking when updating - # states. + # Fingerprint of the Insight. Provides optimistic locking when updating states. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag @@ -120,9 +119,9 @@ module Google # @return [String] attr_accessor :name - # Observation period that led to the insight. The source data used to - # generate the insight ends at last_refresh_time and begins at - # (last_refresh_time - observation_period). + # Observation period that led to the insight. The source data used to generate + # the insight ends at last_refresh_time and begins at (last_refresh_time - + # observation_period). # Corresponds to the JSON property `observationPeriod` # @return [String] attr_accessor :observation_period @@ -161,9 +160,8 @@ module Google class GoogleCloudRecommenderV1beta1InsightRecommendationReference include Google::Apis::Core::Hashable - # Recommendation resource name, e.g. - # projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/ - # recommendations/[RECOMMENDATION_ID] + # Recommendation resource name, e.g. projects/[PROJECT_NUMBER]/locations/[ + # LOCATION]/recommenders/[RECOMMENDER_ID]/recommendations/[RECOMMENDATION_ID] # Corresponds to the JSON property `recommendation` # @return [String] attr_accessor :recommendation @@ -264,9 +262,8 @@ module Google # @return [String] attr_accessor :etag - # Optional. State properties user wish to include with this state. Full replace - # of the - # current state_metadata. + # Optional. State properties user wish to include with this state. Full replace + # of the current state_metadata. # Corresponds to the JSON property `stateMetadata` # @return [Hash] attr_accessor :state_metadata @@ -291,10 +288,9 @@ module Google # @return [String] attr_accessor :etag - # State properties to include with this state. Overwrites any existing - # `state_metadata`. - # Keys must match the regex /^a-z0-9`0,62`$/. - # Values must match the regex /^[a-zA-Z0-9_./-]`0,255`$/. + # State properties to include with this state. Overwrites any existing ` + # state_metadata`. Keys must match the regex /^a-z0-9`0,62`$/. Values must match + # the regex /^[a-zA-Z0-9_./-]`0,255`$/. # Corresponds to the JSON property `stateMetadata` # @return [Hash] attr_accessor :state_metadata @@ -319,10 +315,9 @@ module Google # @return [String] attr_accessor :etag - # State properties to include with this state. Overwrites any existing - # `state_metadata`. - # Keys must match the regex /^a-z0-9`0,62`$/. - # Values must match the regex /^[a-zA-Z0-9_./-]`0,255`$/. + # State properties to include with this state. Overwrites any existing ` + # state_metadata`. Keys must match the regex /^a-z0-9`0,62`$/. Values must match + # the regex /^[a-zA-Z0-9_./-]`0,255`$/. # Corresponds to the JSON property `stateMetadata` # @return [Hash] attr_accessor :state_metadata @@ -347,10 +342,9 @@ module Google # @return [String] attr_accessor :etag - # State properties to include with this state. Overwrites any existing - # `state_metadata`. - # Keys must match the regex /^a-z0-9`0,62`$/. - # Values must match the regex /^[a-zA-Z0-9_./-]`0,255`$/. + # State properties to include with this state. Overwrites any existing ` + # state_metadata`. Keys must match the regex /^a-z0-9`0,62`$/. Values must match + # the regex /^[a-zA-Z0-9_./-]`0,255`$/. # Corresponds to the JSON property `stateMetadata` # @return [Hash] attr_accessor :state_metadata @@ -367,18 +361,16 @@ module Google end # Contains an operation for a resource loosely based on the JSON-PATCH format - # with support for: - # * Custom filters for describing partial array patch. - # * Extended path values for describing nested arrays. - # * Custom fields for describing the resource for which the operation is being - # described. - # * Allows extension to custom operations not natively supported by RFC6902. - # See https://tools.ietf.org/html/rfc6902 for details on the original RFC. + # with support for: * Custom filters for describing partial array patch. * + # Extended path values for describing nested arrays. * Custom fields for + # describing the resource for which the operation is being described. * Allows + # extension to custom operations not natively supported by RFC6902. See https:// + # tools.ietf.org/html/rfc6902 for details on the original RFC. class GoogleCloudRecommenderV1beta1Operation include Google::Apis::Core::Hashable - # Type of this operation. Contains one of 'and', 'remove', 'replace', 'move', - # 'copy', 'test' and 'custom' operations. This field is case-insensitive and + # Type of this operation. Contains one of 'and', 'remove', 'replace', 'move', ' + # copy', 'test' and 'custom' operations. This field is case-insensitive and # always populated. # Corresponds to the JSON property `action` # @return [String] @@ -392,45 +384,34 @@ module Google # Set of filters to apply if `path` refers to array elements or nested array # elements in order to narrow down to a single unique element that is being - # tested/modified. - # This is intended to be an exact match per filter. To perform advanced - # matching, use path_value_matchers. - # * Example: ` - # "/versions/*/name" : "it-123" - # "/versions/*/targetSize/percent": 20 - # ` - # * Example: ` - # "/bindings/*/role": "roles/admin" - # "/bindings/*/condition" : null - # ` - # * Example: ` - # "/bindings/*/role": "roles/admin" - # "/bindings/*/members/*" : ["x@google.com", "y@google.com"] - # ` - # When both path_filters and path_value_matchers are set, an implicit AND - # must be performed. + # tested/modified. This is intended to be an exact match per filter. To perform + # advanced matching, use path_value_matchers. * Example: ` "/versions/*/name" : " + # it-123" "/versions/*/targetSize/percent": 20 ` * Example: ` "/bindings/*/role": + # "roles/admin" "/bindings/*/condition" : null ` * Example: ` "/bindings/*/role" + # : "roles/admin" "/bindings/*/members/*" : ["x@google.com", "y@google.com"] ` + # When both path_filters and path_value_matchers are set, an implicit AND must + # be performed. # Corresponds to the JSON property `pathFilters` # @return [Hash] attr_accessor :path_filters - # Similar to path_filters, this contains set of filters to apply if `path` - # field referes to array elements. This is meant to support value matching - # beyond exact match. To perform exact match, use path_filters. - # When both path_filters and path_value_matchers are set, an implicit AND - # must be performed. + # Similar to path_filters, this contains set of filters to apply if `path` field + # referes to array elements. This is meant to support value matching beyond + # exact match. To perform exact match, use path_filters. When both path_filters + # and path_value_matchers are set, an implicit AND must be performed. # Corresponds to the JSON property `pathValueMatchers` # @return [Hash] attr_accessor :path_value_matchers - # Contains the fully qualified resource name. This field is always populated. - # ex: //cloudresourcemanager.googleapis.com/projects/foo. + # Contains the fully qualified resource name. This field is always populated. ex: + # //cloudresourcemanager.googleapis.com/projects/foo. # Corresponds to the JSON property `resource` # @return [String] attr_accessor :resource # Type of GCP resource being modified/tested. This field is always populated. - # Example: cloudresourcemanager.googleapis.com/Project, - # compute.googleapis.com/Instance + # Example: cloudresourcemanager.googleapis.com/Project, compute.googleapis.com/ + # Instance # Corresponds to the JSON property `resourceType` # @return [String] attr_accessor :resource_type @@ -441,18 +422,17 @@ module Google # @return [String] attr_accessor :source_path - # Can be set with action 'copy' to copy resource configuration across - # different resources of the same type. Example: A resource clone can be - # done via action = 'copy', path = "/", from = "/", - # source_resource = and resource_name = . - # This field is empty for all other values of `action`. + # Can be set with action 'copy' to copy resource configuration across different + # resources of the same type. Example: A resource clone can be done via action = + # 'copy', path = "/", from = "/", source_resource = and resource_name = . This + # field is empty for all other values of `action`. # Corresponds to the JSON property `sourceResource` # @return [String] attr_accessor :source_resource - # Value for the `path` field. Will be set for actions:'add'/'replace'. - # Maybe set for action: 'test'. Either this or `value_matcher` will be set - # for 'test' operation. An exact match must be performed. + # Value for the `path` field. Will be set for actions:'add'/'replace'. Maybe set + # for action: 'test'. Either this or `value_matcher` will be set for 'test' + # operation. An exact match must be performed. # Corresponds to the JSON property `value` # @return [Object] attr_accessor :value @@ -507,8 +487,7 @@ module Google include Google::Apis::Core::Hashable # Optional set of additional impact that this recommendation may have when - # trying to optimize for the primary category. These may be positive - # or negative. + # trying to optimize for the primary category. These may be positive or negative. # Corresponds to the JSON property `additionalImpact` # @return [Array] attr_accessor :additional_impact @@ -529,14 +508,14 @@ module Google # @return [String] attr_accessor :description - # Fingerprint of the Recommendation. Provides optimistic locking when - # updating states. + # Fingerprint of the Recommendation. Provides optimistic locking when updating + # states. # Corresponds to the JSON property `etag` # @return [String] attr_accessor :etag - # Last time this recommendation was refreshed by the system that created it - # in the first place. + # Last time this recommendation was refreshed by the system that created it in + # the first place. # Corresponds to the JSON property `lastRefreshTime` # @return [String] attr_accessor :last_refresh_time @@ -551,14 +530,13 @@ module Google # @return [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1Impact] attr_accessor :primary_impact - # Contains an identifier for a subtype of recommendations produced for the - # same recommender. Subtype is a function of content and impact, meaning a - # new subtype might be added when significant changes to `content` or - # `primary_impact.category` are introduced. See the Recommenders section - # to see a list of subtypes for a given Recommender. - # Examples: - # For recommender = "google.iam.policy.Recommender", - # recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" + # Contains an identifier for a subtype of recommendations produced for the same + # recommender. Subtype is a function of content and impact, meaning a new + # subtype might be added when significant changes to `content` or ` + # primary_impact.category` are introduced. See the Recommenders section to see a + # list of subtypes for a given Recommender. Examples: For recommender = "google. + # iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/" + # REPLACE_ROLE" # Corresponds to the JSON property `recommenderSubtype` # @return [String] attr_accessor :recommender_subtype @@ -591,9 +569,9 @@ module Google class GoogleCloudRecommenderV1beta1RecommendationContent include Google::Apis::Core::Hashable - # Operations to one or more Google Cloud resources grouped in such a way - # that, all operations within one group are expected to be performed - # atomically and in an order. + # Operations to one or more Google Cloud resources grouped in such a way that, + # all operations within one group are expected to be performed atomically and in + # an order. # Corresponds to the JSON property `operationGroups` # @return [Array] attr_accessor :operation_groups @@ -612,9 +590,8 @@ module Google class GoogleCloudRecommenderV1beta1RecommendationInsightReference include Google::Apis::Core::Hashable - # Insight resource name, e.g. - # projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/ - # insights/[INSIGHT_ID] + # Insight resource name, e.g. projects/[PROJECT_NUMBER]/locations/[LOCATION]/ + # insightTypes/[INSIGHT_TYPE_ID]/insights/[INSIGHT_ID] # Corresponds to the JSON property `insight` # @return [String] attr_accessor :insight @@ -658,9 +635,9 @@ module Google class GoogleCloudRecommenderV1beta1ValueMatcher include Google::Apis::Core::Hashable - # To be used for full regex matching. The regular expression is using the - # Google RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be - # used with RE2::FullMatch + # To be used for full regex matching. The regular expression is using the Google + # RE2 syntax (https://github.com/google/re2/wiki/Syntax), so to be used with RE2: + # :FullMatch # Corresponds to the JSON property `matchesPattern` # @return [String] attr_accessor :matches_pattern @@ -684,18 +661,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/recommender_v1beta1/service.rb b/generated/google/apis/recommender_v1beta1/service.rb index 343ecacd0..aa0022841 100644 --- a/generated/google/apis/recommender_v1beta1/service.rb +++ b/generated/google/apis/recommender_v1beta1/service.rb @@ -47,8 +47,8 @@ module Google @batch_path = 'batch' end - # Gets the requested insight. Requires the recommender.*.get IAM permission - # for the specified insight type. + # Gets the requested insight. Requires the recommender.*.get IAM permission for + # the specified insight type. # @param [String] name # Required. Name of the insight. # @param [String] fields @@ -81,27 +81,21 @@ module Google # Lists insights for a Cloud project. Requires the recommender.*.list IAM # permission for the specified insight type. # @param [String] parent - # Required. The container resource on which to execute the request. - # Acceptable formats: - # 1. - # "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]" - # , - # LOCATION here refers to GCP Locations: - # https://cloud.google.com/about/locations/ + # Required. The container resource on which to execute the request. Acceptable + # formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[ + # INSIGHT_TYPE_ID]", LOCATION here refers to GCP Locations: https://cloud.google. + # com/about/locations/ # @param [String] filter # Optional. Filter expression to restrict the insights returned. Supported - # filter fields: state - # Eg: `state:"DISMISSED" or state:"ACTIVE" + # filter fields: state Eg: `state:"DISMISSED" or state:"ACTIVE" # @param [Fixnum] page_size - # Optional. The maximum number of results to return from this request. Non- - # positive - # values are ignored. If not specified, the server will determine the number - # of results to return. + # Optional. The maximum number of results to return from this request. Non- + # positive values are ignored. If not specified, the server will determine the + # number of results to return. # @param [String] page_token # Optional. If present, retrieves the next batch of results from the preceding - # call to - # this method. `page_token` must be the value of `next_page_token` from the - # previous response. The values of other method parameters must be identical + # call to this method. `page_token` must be the value of `next_page_token` from + # the previous response. The values of other method parameters must be identical # to those in the previous call. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -133,11 +127,11 @@ module Google execute_or_queue_command(command, &block) end - # Marks the Insight State as Accepted. Users can use this method to - # indicate to the Recommender API that they have applied some action based - # on the insight. This stops the insight content from being updated. - # MarkInsightAccepted can be applied to insights in ACTIVE state. Requires - # the recommender.*.update IAM permission for the specified insight. + # Marks the Insight State as Accepted. Users can use this method to indicate to + # the Recommender API that they have applied some action based on the insight. + # This stops the insight content from being updated. MarkInsightAccepted can be + # applied to insights in ACTIVE state. Requires the recommender.*.update IAM + # permission for the specified insight. # @param [String] name # Required. Name of the insight. # @param [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkInsightAcceptedRequest] google_cloud_recommender_v1beta1_mark_insight_accepted_request_object @@ -170,8 +164,8 @@ module Google execute_or_queue_command(command, &block) end - # Gets the requested recommendation. Requires the recommender.*.get - # IAM permission for the specified recommender. + # Gets the requested recommendation. Requires the recommender.*.get IAM + # permission for the specified recommender. # @param [String] name # Required. Name of the recommendation. # @param [String] fields @@ -201,29 +195,25 @@ module Google execute_or_queue_command(command, &block) end - # Lists recommendations for a Cloud project. Requires the recommender.*.list - # IAM permission for the specified recommender. + # Lists recommendations for a Cloud project. Requires the recommender.*.list IAM + # permission for the specified recommender. # @param [String] parent - # Required. The container resource on which to execute the request. - # Acceptable formats: - # 1. - # "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]", - # LOCATION here refers to GCP Locations: - # https://cloud.google.com/about/locations/ + # Required. The container resource on which to execute the request. Acceptable + # formats: 1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[ + # RECOMMENDER_ID]", LOCATION here refers to GCP Locations: https://cloud.google. + # com/about/locations/ # @param [String] filter - # Filter expression to restrict the recommendations returned. Supported - # filter fields: state_info.state - # Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED" + # Filter expression to restrict the recommendations returned. Supported filter + # fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state: + # "FAILED" # @param [Fixnum] page_size - # Optional. The maximum number of results to return from this request. Non- - # positive - # values are ignored. If not specified, the server will determine the number - # of results to return. + # Optional. The maximum number of results to return from this request. Non- + # positive values are ignored. If not specified, the server will determine the + # number of results to return. # @param [String] page_token # Optional. If present, retrieves the next batch of results from the preceding - # call to - # this method. `page_token` must be the value of `next_page_token` from the - # previous response. The values of other method parameters must be identical + # call to this method. `page_token` must be the value of `next_page_token` from + # the previous response. The values of other method parameters must be identical # to those in the previous call. # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -260,9 +250,8 @@ module Google # recommendation themselves. This stops the recommendation content from being # updated. Associated insights are frozen and placed in the ACCEPTED state. # MarkRecommendationClaimed can be applied to recommendations in CLAIMED or - # ACTIVE state. - # Requires the recommender.*.update IAM permission for the specified - # recommender. + # ACTIVE state. Requires the recommender.*.update IAM permission for the + # specified recommender. # @param [String] name # Required. Name of the recommendation. # @param [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest] google_cloud_recommender_v1beta1_mark_recommendation_claimed_request_object @@ -298,12 +287,10 @@ module Google # Marks the Recommendation State as Failed. Users can use this method to # indicate to the Recommender API that they have applied the recommendation # themselves, and the operation failed. This stops the recommendation content - # from being updated. Associated insights are frozen and placed in the - # ACCEPTED state. - # MarkRecommendationFailed can be applied to recommendations in ACTIVE, - # CLAIMED, SUCCEEDED, or FAILED state. - # Requires the recommender.*.update IAM permission for the specified - # recommender. + # from being updated. Associated insights are frozen and placed in the ACCEPTED + # state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, + # CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM + # permission for the specified recommender. # @param [String] name # Required. Name of the recommendation. # @param [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest] google_cloud_recommender_v1beta1_mark_recommendation_failed_request_object @@ -339,12 +326,10 @@ module Google # Marks the Recommendation State as Succeeded. Users can use this method to # indicate to the Recommender API that they have applied the recommendation # themselves, and the operation was successful. This stops the recommendation - # content from being updated. Associated insights are frozen and placed in - # the ACCEPTED state. - # MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, - # CLAIMED, SUCCEEDED, or FAILED state. - # Requires the recommender.*.update IAM permission for the specified - # recommender. + # content from being updated. Associated insights are frozen and placed in the + # ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations + # in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*. + # update IAM permission for the specified recommender. # @param [String] name # Required. Name of the recommendation. # @param [Google::Apis::RecommenderV1beta1::GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest] google_cloud_recommender_v1beta1_mark_recommendation_succeeded_request_object diff --git a/generated/google/apis/runtimeconfig_v1.rb b/generated/google/apis/runtimeconfig_v1.rb index 26b2fe7d5..53cea03fd 100644 --- a/generated/google/apis/runtimeconfig_v1.rb +++ b/generated/google/apis/runtimeconfig_v1.rb @@ -28,7 +28,7 @@ module Google # @see https://cloud.google.com/deployment-manager/runtime-configurator/ module RuntimeconfigV1 VERSION = 'V1' - REVISION = '20200224' + 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/runtimeconfig_v1/classes.rb b/generated/google/apis/runtimeconfig_v1/classes.rb index ece1fcb41..96354585d 100644 --- a/generated/google/apis/runtimeconfig_v1/classes.rb +++ b/generated/google/apis/runtimeconfig_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::RuntimeconfigV1::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/runtimeconfig_v1/service.rb b/generated/google/apis/runtimeconfig_v1/service.rb index 08d75c45a..a18f0ccee 100644 --- a/generated/google/apis/runtimeconfig_v1/service.rb +++ b/generated/google/apis/runtimeconfig_v1/service.rb @@ -50,15 +50,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. @@ -92,10 +90,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 @@ -125,15 +123,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/searchconsole_v1.rb b/generated/google/apis/searchconsole_v1.rb index 0e0cdb5c7..3e8140473 100644 --- a/generated/google/apis/searchconsole_v1.rb +++ b/generated/google/apis/searchconsole_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://developers.google.com/webmaster-tools/search-console-api/ module SearchconsoleV1 VERSION = 'V1' - REVISION = '20200714' + REVISION = '20200803' end end end diff --git a/generated/google/apis/searchconsole_v1/classes.rb b/generated/google/apis/searchconsole_v1/classes.rb index 8812645d8..9ed4b5c12 100644 --- a/generated/google/apis/searchconsole_v1/classes.rb +++ b/generated/google/apis/searchconsole_v1/classes.rb @@ -45,8 +45,8 @@ module Google class Image include Google::Apis::Core::Hashable - # Image data in format determined by the mime type. Currently, the format - # will always be "image/png", but this might change in the future. + # Image data in format determined by the mime type. Currently, the format will + # always be "image/png", but this might change in the future. # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] diff --git a/generated/google/apis/storagetransfer_v1.rb b/generated/google/apis/storagetransfer_v1.rb index 2667e0d58..43f0d0e3e 100644 --- a/generated/google/apis/storagetransfer_v1.rb +++ b/generated/google/apis/storagetransfer_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/storage-transfer/docs module StoragetransferV1 VERSION = 'V1' - REVISION = '20200721' + 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/storagetransfer_v1/classes.rb b/generated/google/apis/storagetransfer_v1/classes.rb index 796315d0f..d2afbffd5 100644 --- a/generated/google/apis/storagetransfer_v1/classes.rb +++ b/generated/google/apis/storagetransfer_v1/classes.rb @@ -459,11 +459,11 @@ module Google end # Conditions that determine which objects will be transferred. Applies only - # to S3 and Cloud Storage objects. + # to Cloud Data Sources such as S3, Azure, and Cloud Storage. # The "last modification time" refers to the time of the # last change to the object's content or metadata — specifically, this is - # the `updated` property of Cloud Storage objects and the `LastModified` - # field of S3 objects. + # the `updated` property of Cloud Storage objects, the `LastModified` field of + # S3 objects, and the `Last-Modified` header of Azure blobs. class ObjectConditions include Google::Apis::Core::Hashable @@ -1081,8 +1081,7 @@ module Google end end - # TransferOptions uses three boolean parameters to define the actions - # to be performed on objects in a transfer. + # TransferOptions define the actions to be performed on objects in a transfer. class TransferOptions include Google::Apis::Core::Hashable @@ -1196,17 +1195,16 @@ module Google attr_accessor :http_data_source # Conditions that determine which objects will be transferred. Applies only - # to S3 and Cloud Storage objects. + # to Cloud Data Sources such as S3, Azure, and Cloud Storage. # The "last modification time" refers to the time of the # last change to the object's content or metadata — specifically, this is - # the `updated` property of Cloud Storage objects and the `LastModified` - # field of S3 objects. + # the `updated` property of Cloud Storage objects, the `LastModified` field of + # S3 objects, and the `Last-Modified` header of Azure blobs. # Corresponds to the JSON property `objectConditions` # @return [Google::Apis::StoragetransferV1::ObjectConditions] attr_accessor :object_conditions - # TransferOptions uses three boolean parameters to define the actions - # to be performed on objects in a transfer. + # TransferOptions define the actions to be performed on objects in a transfer. # Corresponds to the JSON property `transferOptions` # @return [Google::Apis::StoragetransferV1::TransferOptions] attr_accessor :transfer_options diff --git a/generated/google/apis/tagmanager_v1.rb b/generated/google/apis/tagmanager_v1.rb index 90f74a248..4b93cb4b6 100644 --- a/generated/google/apis/tagmanager_v1.rb +++ b/generated/google/apis/tagmanager_v1.rb @@ -20,13 +20,12 @@ module Google module Apis # Tag Manager API # - # This API allows clients to access and modify container and tag - # configuration. + # This API allows clients to access and modify container and tag configuration. # # @see https://developers.google.com/tag-manager module TagmanagerV1 VERSION = 'V1' - REVISION = '20200504' + REVISION = '20200803' # Delete your Google Tag Manager containers AUTH_TAGMANAGER_DELETE_CONTAINERS = 'https://www.googleapis.com/auth/tagmanager.delete.containers' diff --git a/generated/google/apis/tagmanager_v1/classes.rb b/generated/google/apis/tagmanager_v1/classes.rb index e4163b605..434491200 100644 --- a/generated/google/apis/tagmanager_v1/classes.rb +++ b/generated/google/apis/tagmanager_v1/classes.rb @@ -31,22 +31,20 @@ module Google # @return [String] attr_accessor :account_id - # The fingerprint of the GTM Account as computed at storage time. - # This value is recomputed whenever the account is modified. + # The fingerprint of the GTM Account as computed at storage time. This value is + # recomputed whenever the account is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint - # Account display name. - # @mutable tagmanager.accounts.create - # @mutable tagmanager.accounts.update + # Account display name. @mutable tagmanager.accounts.create @mutable tagmanager. + # accounts.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Whether the account shares data anonymously with Google and others. - # @mutable tagmanager.accounts.create - # @mutable tagmanager.accounts.update + # Whether the account shares data anonymously with Google and others. @mutable + # tagmanager.accounts.create @mutable tagmanager.accounts.update # Corresponds to the JSON property `shareData` # @return [Boolean] attr_accessor :share_data @@ -69,10 +67,9 @@ module Google class AccountAccess include Google::Apis::Core::Hashable - # List of Account permissions. - # Valid account permissions are read and manage. - # @mutable tagmanager.accounts.permissions.create - # @mutable tagmanager.accounts.permissions.update + # List of Account permissions. Valid account permissions are read and manage. @ + # mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts. + # permissions.update # Corresponds to the JSON property `permission` # @return [Array] attr_accessor :permission @@ -92,29 +89,21 @@ module Google include Google::Apis::Core::Hashable # A list of named parameters (key/value), depending on the condition's type. - # Notes:
        - #
      • For binary operators, include parameters named arg0 and - # arg1 for specifying the left and right operands, - # respectively.
        • - #
      • At this time, the left operand (arg0) must be a reference - # to a variable.
        • - #
      • For case-insensitive Regex matching, include a boolean parameter named - # ignore_case that is set to true. + # Notes: - For binary operators, include parameters named arg0 and arg1 for + # specifying the left and right operands, respectively. - At this time, the left + # operand (arg0) must be a reference to a variable. - For case-insensitive Regex + # matching, include a boolean parameter named ignore_case that is set to true. # If not specified or set to any other value, the matching will be case - # sensitive.
        • - #
      • To negate an operator, include a boolean parameter named - # negate boolean parameter that is set to true. - #
        • - #
      - # @mutable tagmanager.accounts.containers.triggers.create - # @mutable tagmanager.accounts.containers.triggers.update + # sensitive. - To negate an operator, include a boolean parameter named negate + # boolean parameter that is set to true. @mutable tagmanager.accounts.containers. + # triggers.create @mutable tagmanager.accounts.containers.triggers.update # Corresponds to the JSON property `parameter` # @return [Array] attr_accessor :parameter - # The type of operator for this condition. - # @mutable tagmanager.accounts.containers.triggers.create - # @mutable tagmanager.accounts.containers.triggers.update + # The type of operator for this condition. @mutable tagmanager.accounts. + # containers.triggers.create @mutable tagmanager.accounts.containers.triggers. + # update # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -144,42 +133,38 @@ module Google # @return [String] attr_accessor :container_id - # Optional list of domain names associated with the Container. - # @mutable tagmanager.accounts.containers.create - # @mutable tagmanager.accounts.containers.update + # Optional list of domain names associated with the Container. @mutable + # tagmanager.accounts.containers.create @mutable tagmanager.accounts.containers. + # update # Corresponds to the JSON property `domainName` # @return [Array] attr_accessor :domain_name - # List of enabled built-in variables. Valid values include: pageUrl, - # pageHostname, pagePath, referrer, event, clickElement, clickClasses, - # clickId, clickTarget, clickUrl, clickText, formElement, formClasses, - # formId, formTarget, formUrl, formText, errorMessage, errorUrl, errorLine, - # newHistoryFragment, oldHistoryFragment, newHistoryState, oldHistoryState, - # historySource, containerVersion, debugMode, randomNumber, - # containerId. - # @mutable tagmanager.accounts.containers.create - # @mutable tagmanager.accounts.containers.update + # List of enabled built-in variables. Valid values include: pageUrl, + # pageHostname, pagePath, referrer, event, clickElement, clickClasses, clickId, + # clickTarget, clickUrl, clickText, formElement, formClasses, formId, formTarget, + # formUrl, formText, errorMessage, errorUrl, errorLine, newHistoryFragment, + # oldHistoryFragment, newHistoryState, oldHistoryState, historySource, + # containerVersion, debugMode, randomNumber, containerId. @mutable tagmanager. + # accounts.containers.create @mutable tagmanager.accounts.containers.update # Corresponds to the JSON property `enabledBuiltInVariable` # @return [Array] attr_accessor :enabled_built_in_variable - # The fingerprint of the GTM Container as computed at storage time. This - # value is recomputed whenever the account is modified. + # The fingerprint of the GTM Container as computed at storage time. This value + # is recomputed whenever the account is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint - # Container display name. - # @mutable tagmanager.accounts.containers.create - # @mutable tagmanager.accounts.containers.update + # Container display name. @mutable tagmanager.accounts.containers.create @ + # mutable tagmanager.accounts.containers.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Container Notes. - # @mutable tagmanager.accounts.containers.create - # @mutable tagmanager.accounts.containers.update + # Container Notes. @mutable tagmanager.accounts.containers.create @mutable + # tagmanager.accounts.containers.update # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes @@ -189,24 +174,21 @@ module Google # @return [String] attr_accessor :public_id - # Container Country ID. - # @mutable tagmanager.accounts.containers.create - # @mutable tagmanager.accounts.containers.update + # Container Country ID. @mutable tagmanager.accounts.containers.create @mutable + # tagmanager.accounts.containers.update # Corresponds to the JSON property `timeZoneCountryId` # @return [String] attr_accessor :time_zone_country_id - # Container Time Zone ID. - # @mutable tagmanager.accounts.containers.create - # @mutable tagmanager.accounts.containers.update + # Container Time Zone ID. @mutable tagmanager.accounts.containers.create @ + # mutable tagmanager.accounts.containers.update # Corresponds to the JSON property `timeZoneId` # @return [String] attr_accessor :time_zone_id - # List of Usage Contexts for the Container. Valid values include: web, - # android, ios. - # @mutable tagmanager.accounts.containers.create - # @mutable tagmanager.accounts.containers.update + # List of Usage Contexts for the Container. Valid values include: web, android, + # ios. @mutable tagmanager.accounts.containers.create @mutable tagmanager. + # accounts.containers.update # Corresponds to the JSON property `usageContext` # @return [Array] attr_accessor :usage_context @@ -235,17 +217,15 @@ module Google class ContainerAccess include Google::Apis::Core::Hashable - # GTM Container ID. - # @mutable tagmanager.accounts.permissions.create - # @mutable tagmanager.accounts.permissions.update + # GTM Container ID. @mutable tagmanager.accounts.permissions.create @mutable + # tagmanager.accounts.permissions.update # Corresponds to the JSON property `containerId` # @return [String] attr_accessor :container_id - # List of Container permissions. - # Valid container permissions are: read, edit, delete, publish. - # @mutable tagmanager.accounts.permissions.create - # @mutable tagmanager.accounts.permissions.update + # List of Container permissions. Valid container permissions are: read, edit, + # delete, publish. @mutable tagmanager.accounts.permissions.create @mutable + # tagmanager.accounts.permissions.update # Corresponds to the JSON property `permission` # @return [Array] attr_accessor :permission @@ -291,9 +271,8 @@ module Google attr_accessor :deleted alias_method :deleted?, :deleted - # The fingerprint of the GTM Container Version as computed at - # storage time. This value is recomputed whenever the container version is - # modified. + # The fingerprint of the GTM Container Version as computed at storage time. This + # value is recomputed whenever the container version is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint @@ -308,15 +287,14 @@ module Google # @return [Array] attr_accessor :macro - # Container version display name. - # @mutable tagmanager.accounts.containers.versions.update + # Container version display name. @mutable tagmanager.accounts.containers. + # versions.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # User notes on how to apply this container version in the - # container. - # @mutable tagmanager.accounts.containers.versions.update + # User notes on how to apply this container version in the container. @mutable + # tagmanager.accounts.containers.versions.update # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes @@ -452,8 +430,7 @@ module Google # @return [String] attr_accessor :notes - # The creation of this version may be for quick preview and - # shouldn't be saved. + # The creation of this version may be for quick preview and shouldn't be saved. # Corresponds to the JSON property `quickPreview` # @return [Boolean] attr_accessor :quick_preview @@ -529,16 +506,15 @@ module Google attr_accessor :container_version_id # The environment description. Can be set or changed only on USER type - # environments. - # @mutable tagmanager.accounts.containers.environments.create - # @mutable tagmanager.accounts.containers.environments.update + # environments. @mutable tagmanager.accounts.containers.environments.create @ + # mutable tagmanager.accounts.containers.environments.update # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Whether or not to enable debug by default on for the environment. - # @mutable tagmanager.accounts.containers.environments.create - # @mutable tagmanager.accounts.containers.environments.update + # Whether or not to enable debug by default on for the environment. @mutable + # tagmanager.accounts.containers.environments.create @mutable tagmanager. + # accounts.containers.environments.update # Corresponds to the JSON property `enableDebug` # @return [Boolean] attr_accessor :enable_debug @@ -549,16 +525,15 @@ module Google # @return [String] attr_accessor :environment_id - # The fingerprint of the GTM environment as computed at storage time. - # This value is recomputed whenever the environment is modified. + # The fingerprint of the GTM environment as computed at storage time. This value + # is recomputed whenever the environment is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint # The environment display name. Can be set or changed only on USER type - # environments. - # @mutable tagmanager.accounts.containers.environments.create - # @mutable tagmanager.accounts.containers.environments.update + # environments. @mutable tagmanager.accounts.containers.environments.create @ + # mutable tagmanager.accounts.containers.environments.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -568,9 +543,9 @@ module Google # @return [String] attr_accessor :type - # Default preview page url for the environment. - # @mutable tagmanager.accounts.containers.environments.create - # @mutable tagmanager.accounts.containers.environments.update + # Default preview page url for the environment. @mutable tagmanager.accounts. + # containers.environments.create @mutable tagmanager.accounts.containers. + # environments.update # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -610,8 +585,8 @@ module Google # @return [String] attr_accessor :container_id - # The fingerprint of the GTM Folder as computed at storage time. - # This value is recomputed whenever the folder is modified. + # The fingerprint of the GTM Folder as computed at storage time. This value is + # recomputed whenever the folder is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint @@ -621,9 +596,8 @@ module Google # @return [String] attr_accessor :folder_id - # Folder display name. - # @mutable tagmanager.accounts.containers.folders.create - # @mutable tagmanager.accounts.containers.folders.update + # Folder display name. @mutable tagmanager.accounts.containers.folders.create @ + # mutable tagmanager.accounts.containers.folders.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -866,24 +840,24 @@ module Google # For mobile containers only: A list of rule IDs for disabling conditional # macros; the macro is enabled if one of the enabling rules is true while all - # the disabling rules are false. Treated as an unordered set. - # @mutable tagmanager.accounts.containers.macros.create - # @mutable tagmanager.accounts.containers.macros.update + # the disabling rules are false. Treated as an unordered set. @mutable + # tagmanager.accounts.containers.macros.create @mutable tagmanager.accounts. + # containers.macros.update # Corresponds to the JSON property `disablingRuleId` # @return [Array] attr_accessor :disabling_rule_id - # For mobile containers only: A list of rule IDs for enabling conditional - # macros; the macro is enabled if one of the enabling rules is true while all - # the disabling rules are false. Treated as an unordered set. - # @mutable tagmanager.accounts.containers.macros.create - # @mutable tagmanager.accounts.containers.macros.update + # For mobile containers only: A list of rule IDs for enabling conditional macros; + # the macro is enabled if one of the enabling rules is true while all the + # disabling rules are false. Treated as an unordered set. @mutable tagmanager. + # accounts.containers.macros.create @mutable tagmanager.accounts.containers. + # macros.update # Corresponds to the JSON property `enablingRuleId` # @return [Array] attr_accessor :enabling_rule_id - # The fingerprint of the GTM Macro as computed at storage time. - # This value is recomputed whenever the macro is modified. + # The fingerprint of the GTM Macro as computed at storage time. This value is + # recomputed whenever the macro is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint @@ -893,23 +867,21 @@ module Google # @return [String] attr_accessor :macro_id - # Macro display name. - # @mutable tagmanager.accounts.containers.macros.create - # @mutable tagmanager.accounts.containers.macros.update + # Macro display name. @mutable tagmanager.accounts.containers.macros.create @ + # mutable tagmanager.accounts.containers.macros.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # User notes on how to apply this macro in the container. - # @mutable tagmanager.accounts.containers.macros.create - # @mutable tagmanager.accounts.containers.macros.update + # User notes on how to apply this macro in the container. @mutable tagmanager. + # accounts.containers.macros.create @mutable tagmanager.accounts.containers. + # macros.update # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes - # The macro's parameters. - # @mutable tagmanager.accounts.containers.macros.create - # @mutable tagmanager.accounts.containers.macros.update + # The macro's parameters. @mutable tagmanager.accounts.containers.macros.create @ + # mutable tagmanager.accounts.containers.macros.update # Corresponds to the JSON property `parameter` # @return [Array] attr_accessor :parameter @@ -919,23 +891,22 @@ module Google # @return [String] attr_accessor :parent_folder_id - # The end timestamp in milliseconds to schedule a macro. - # @mutable tagmanager.accounts.containers.macros.create - # @mutable tagmanager.accounts.containers.macros.update + # The end timestamp in milliseconds to schedule a macro. @mutable tagmanager. + # accounts.containers.macros.create @mutable tagmanager.accounts.containers. + # macros.update # Corresponds to the JSON property `scheduleEndMs` # @return [Fixnum] attr_accessor :schedule_end_ms - # The start timestamp in milliseconds to schedule a macro. - # @mutable tagmanager.accounts.containers.macros.create - # @mutable tagmanager.accounts.containers.macros.update + # The start timestamp in milliseconds to schedule a macro. @mutable tagmanager. + # accounts.containers.macros.create @mutable tagmanager.accounts.containers. + # macros.update # Corresponds to the JSON property `scheduleStartMs` # @return [Fixnum] attr_accessor :schedule_start_ms - # GTM Macro Type. - # @mutable tagmanager.accounts.containers.macros.create - # @mutable tagmanager.accounts.containers.macros.update + # GTM Macro Type. @mutable tagmanager.accounts.containers.macros.create @mutable + # tagmanager.accounts.containers.macros.update # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -966,74 +937,59 @@ module Google class Parameter include Google::Apis::Core::Hashable - # The named key that uniquely identifies a parameter. Required for top-level - # parameters, as well as map values. Ignored for list values. - # @mutable tagmanager.accounts.containers.variables.create - # @mutable tagmanager.accounts.containers.variables.update - # @mutable tagmanager.accounts.containers.triggers.create - # @mutable tagmanager.accounts.containers.triggers.update - # @mutable tagmanager.accounts.containers.tags.create - # @mutable tagmanager.accounts.containers.tags.update + # The named key that uniquely identifies a parameter. Required for top-level + # parameters, as well as map values. Ignored for list values. @mutable + # tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts. + # containers.variables.update @mutable tagmanager.accounts.containers.triggers. + # create @mutable tagmanager.accounts.containers.triggers.update @mutable + # tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts. + # containers.tags.update # Corresponds to the JSON property `key` # @return [String] attr_accessor :key - # This list parameter's parameters (keys will be ignored). - # @mutable tagmanager.accounts.containers.variables.create - # @mutable tagmanager.accounts.containers.variables.update - # @mutable tagmanager.accounts.containers.triggers.create - # @mutable tagmanager.accounts.containers.triggers.update - # @mutable tagmanager.accounts.containers.tags.create - # @mutable tagmanager.accounts.containers.tags.update + # This list parameter's parameters (keys will be ignored). @mutable tagmanager. + # accounts.containers.variables.create @mutable tagmanager.accounts.containers. + # variables.update @mutable tagmanager.accounts.containers.triggers.create @ + # mutable tagmanager.accounts.containers.triggers.update @mutable tagmanager. + # accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags. + # update # Corresponds to the JSON property `list` # @return [Array] attr_accessor :list - # This map parameter's parameters (must have keys; keys must be unique). - # @mutable tagmanager.accounts.containers.variables.create - # @mutable tagmanager.accounts.containers.variables.update - # @mutable tagmanager.accounts.containers.triggers.create - # @mutable tagmanager.accounts.containers.triggers.update - # @mutable tagmanager.accounts.containers.tags.create - # @mutable tagmanager.accounts.containers.tags.update + # This map parameter's parameters (must have keys; keys must be unique). @ + # mutable tagmanager.accounts.containers.variables.create @mutable tagmanager. + # accounts.containers.variables.update @mutable tagmanager.accounts.containers. + # triggers.create @mutable tagmanager.accounts.containers.triggers.update @ + # mutable tagmanager.accounts.containers.tags.create @mutable tagmanager. + # accounts.containers.tags.update # Corresponds to the JSON property `map` # @return [Array] attr_accessor :map - # The parameter type. Valid values are:
        - #
      • boolean: The value represents a boolean, represented as - # 'true' or 'false'
        • - #
      • integer: The value represents a 64-bit signed integer - # value, in base 10
        • - #
      • list: A list of parameters should be specified
        • - #
      • map: A map of parameters should be specified
        • - #
      • template: The value represents any text; this can include - # variable references (even variable references that might return - # non-string types)
        • - #
      • trigger_reference: The value represents a trigger, - # represented as the trigger id
        • - #
      • tag_reference: The value represents a tag, represented as - # the tag name
        • - #
      - # @mutable tagmanager.accounts.containers.variables.create - # @mutable tagmanager.accounts.containers.variables.update - # @mutable tagmanager.accounts.containers.triggers.create - # @mutable tagmanager.accounts.containers.triggers.update - # @mutable tagmanager.accounts.containers.tags.create - # @mutable tagmanager.accounts.containers.tags.update + # The parameter type. Valid values are: - boolean: The value represents a + # boolean, represented as 'true' or 'false' - integer: The value represents a 64- + # bit signed integer value, in base 10 - list: A list of parameters should be + # specified - map: A map of parameters should be specified - template: The value + # represents any text; this can include variable references (even variable + # references that might return non-string types) - trigger_reference: The value + # represents a trigger, represented as the trigger id - tag_reference: The value + # represents a tag, represented as the tag name @mutable tagmanager.accounts. + # containers.variables.create @mutable tagmanager.accounts.containers.variables. + # update @mutable tagmanager.accounts.containers.triggers.create @mutable + # tagmanager.accounts.containers.triggers.update @mutable tagmanager.accounts. + # containers.tags.create @mutable tagmanager.accounts.containers.tags.update # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # A parameter's value (may contain variable references such as - # "``myVariable``") - # as appropriate to the specified type. - # @mutable tagmanager.accounts.containers.variables.create - # @mutable tagmanager.accounts.containers.variables.update - # @mutable tagmanager.accounts.containers.triggers.create - # @mutable tagmanager.accounts.containers.triggers.update - # @mutable tagmanager.accounts.containers.tags.create - # @mutable tagmanager.accounts.containers.tags.update + # A parameter's value (may contain variable references such as "``myVariable``") + # as appropriate to the specified type. @mutable tagmanager.accounts.containers. + # variables.create @mutable tagmanager.accounts.containers.variables.update @ + # mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager. + # accounts.containers.triggers.update @mutable tagmanager.accounts.containers. + # tags.create @mutable tagmanager.accounts.containers.tags.update # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -1087,9 +1043,9 @@ module Google # @return [String] attr_accessor :account_id - # The list of conditions that make up this rule (implicit AND between them). - # @mutable tagmanager.accounts.containers.rules.create - # @mutable tagmanager.accounts.containers.rules.update + # The list of conditions that make up this rule (implicit AND between them). @ + # mutable tagmanager.accounts.containers.rules.create @mutable tagmanager. + # accounts.containers.rules.update # Corresponds to the JSON property `condition` # @return [Array] attr_accessor :condition @@ -1099,22 +1055,21 @@ module Google # @return [String] attr_accessor :container_id - # The fingerprint of the GTM Rule as computed at storage time. - # This value is recomputed whenever the rule is modified. + # The fingerprint of the GTM Rule as computed at storage time. This value is + # recomputed whenever the rule is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint - # Rule display name. - # @mutable tagmanager.accounts.containers.rules.create - # @mutable tagmanager.accounts.containers.rules.update + # Rule display name. @mutable tagmanager.accounts.containers.rules.create @ + # mutable tagmanager.accounts.containers.rules.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # User notes on how to apply this rule in the container. - # @mutable tagmanager.accounts.containers.rules.create - # @mutable tagmanager.accounts.containers.rules.update + # User notes on how to apply this rule in the container. @mutable tagmanager. + # accounts.containers.rules.create @mutable tagmanager.accounts.containers.rules. + # update # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes @@ -1144,9 +1099,8 @@ module Google class SetupTag include Google::Apis::Core::Hashable - # If true, fire the main tag if and only if the setup tag fires - # successfully. - # If false, fire the main tag regardless of setup tag firing status. + # If true, fire the main tag if and only if the setup tag fires successfully. If + # false, fire the main tag regardless of setup tag firing status. # Corresponds to the JSON property `stopOnSetupFailure` # @return [Boolean] attr_accessor :stop_on_setup_failure @@ -1177,19 +1131,16 @@ module Google # @return [String] attr_accessor :account_id - # Blocking rule IDs. If any of the listed rules evaluate to true, the tag - # will not fire. - # @mutable tagmanager.accounts.containers.tags.create - # @mutable tagmanager.accounts.containers.tags.update + # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will + # not fire. @mutable tagmanager.accounts.containers.tags.create @mutable + # tagmanager.accounts.containers.tags.update # Corresponds to the JSON property `blockingRuleId` # @return [Array] attr_accessor :blocking_rule_id - # Blocking trigger IDs. If any of the listed triggers evaluate to true, the - # tag - # will not fire. - # @mutable tagmanager.accounts.containers.tags.create - # @mutable tagmanager.accounts.containers.tags.update + # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag + # will not fire. @mutable tagmanager.accounts.containers.tags.create @mutable + # tagmanager.accounts.containers.tags.update # Corresponds to the JSON property `blockingTriggerId` # @return [Array] attr_accessor :blocking_trigger_id @@ -1199,55 +1150,51 @@ module Google # @return [String] attr_accessor :container_id - # The fingerprint of the GTM Tag as computed at storage time. - # This value is recomputed whenever the tag is modified. + # The fingerprint of the GTM Tag as computed at storage time. This value is + # recomputed whenever the tag is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint - # Firing rule IDs. A tag will fire when any of the listed rules are true and - # all of its blockingRuleIds (if any specified) are false. - # @mutable tagmanager.accounts.containers.tags.create - # @mutable tagmanager.accounts.containers.tags.update + # Firing rule IDs. A tag will fire when any of the listed rules are true and all + # of its blockingRuleIds (if any specified) are false. @mutable tagmanager. + # accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags. + # update # Corresponds to the JSON property `firingRuleId` # @return [Array] attr_accessor :firing_rule_id - # Firing trigger IDs. A tag will fire when any of the listed triggers are - # true and all of its blockingTriggerIds (if any specified) are - # false. - # @mutable tagmanager.accounts.containers.tags.create - # @mutable tagmanager.accounts.containers.tags.update + # Firing trigger IDs. A tag will fire when any of the listed triggers are true + # and all of its blockingTriggerIds (if any specified) are false. @mutable + # tagmanager.accounts.containers.tags.create @mutable tagmanager.accounts. + # containers.tags.update # Corresponds to the JSON property `firingTriggerId` # @return [Array] attr_accessor :firing_trigger_id - # If set to true, this tag will only fire in the live environment (e.g. not - # in preview or debug mode). - # @mutable tagmanager.accounts.containers.tags.create - # @mutable tagmanager.accounts.containers.tags.update + # If set to true, this tag will only fire in the live environment (e.g. not in + # preview or debug mode). @mutable tagmanager.accounts.containers.tags.create @ + # mutable tagmanager.accounts.containers.tags.update # Corresponds to the JSON property `liveOnly` # @return [Boolean] attr_accessor :live_only alias_method :live_only?, :live_only - # Tag display name. - # @mutable tagmanager.accounts.containers.tags.create - # @mutable tagmanager.accounts.containers.tags.update + # Tag display name. @mutable tagmanager.accounts.containers.tags.create @mutable + # tagmanager.accounts.containers.tags.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # User notes on how to apply this tag in the container. - # @mutable tagmanager.accounts.containers.tags.create - # @mutable tagmanager.accounts.containers.tags.update + # User notes on how to apply this tag in the container. @mutable tagmanager. + # accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags. + # update # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes - # The tag's parameters. - # @mutable tagmanager.accounts.containers.tags.create - # @mutable tagmanager.accounts.containers.tags.update + # The tag's parameters. @mutable tagmanager.accounts.containers.tags.create @ + # mutable tagmanager.accounts.containers.tags.update # Corresponds to the JSON property `parameter` # @return [Array] attr_accessor :parameter @@ -1257,8 +1204,7 @@ module Google # @return [String] attr_accessor :parent_folder_id - # True if the tag is paused. - # @mutable tagmanager.accounts.containers.tags.create + # True if the tag is paused. @mutable tagmanager.accounts.containers.tags.create # @mutable tagmanager.accounts.containers.tags.update # Corresponds to the JSON property `paused` # @return [Boolean] @@ -1270,16 +1216,16 @@ module Google # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :priority - # The end timestamp in milliseconds to schedule a tag. - # @mutable tagmanager.accounts.containers.tags.create - # @mutable tagmanager.accounts.containers.tags.update + # The end timestamp in milliseconds to schedule a tag. @mutable tagmanager. + # accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags. + # update # Corresponds to the JSON property `scheduleEndMs` # @return [Fixnum] attr_accessor :schedule_end_ms - # The start timestamp in milliseconds to schedule a tag. - # @mutable tagmanager.accounts.containers.tags.create - # @mutable tagmanager.accounts.containers.tags.update + # The start timestamp in milliseconds to schedule a tag. @mutable tagmanager. + # accounts.containers.tags.create @mutable tagmanager.accounts.containers.tags. + # update # Corresponds to the JSON property `scheduleStartMs` # @return [Fixnum] attr_accessor :schedule_start_ms @@ -1304,9 +1250,8 @@ module Google # @return [Array] attr_accessor :teardown_tag - # GTM Tag Type. - # @mutable tagmanager.accounts.containers.tags.create - # @mutable tagmanager.accounts.containers.tags.update + # GTM Tag Type. @mutable tagmanager.accounts.containers.tags.create @mutable + # tagmanager.accounts.containers.tags.update # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -1345,8 +1290,7 @@ module Google class TeardownTag include Google::Apis::Core::Hashable - # If true, fire the teardown tag if and only if the main tag fires - # successfully. + # If true, fire the teardown tag if and only if the main tag fires successfully. # If false, fire the teardown tag regardless of main tag firing status. # Corresponds to the JSON property `stopTeardownOnFailure` # @return [Boolean] @@ -1378,9 +1322,9 @@ module Google # @return [String] attr_accessor :account_id - # Used in the case of auto event tracking. - # @mutable tagmanager.accounts.containers.triggers.create - # @mutable tagmanager.accounts.containers.triggers.update + # Used in the case of auto event tracking. @mutable tagmanager.accounts. + # containers.triggers.create @mutable tagmanager.accounts.containers.triggers. + # update # Corresponds to the JSON property `autoEventFilter` # @return [Array] attr_accessor :auto_event_filter @@ -1400,10 +1344,9 @@ module Google # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :continuous_time_min_milliseconds - # Used in the case of custom event, which is fired iff all Conditions are - # true. - # @mutable tagmanager.accounts.containers.triggers.create - # @mutable tagmanager.accounts.containers.triggers.update + # Used in the case of custom event, which is fired iff all Conditions are true. @ + # mutable tagmanager.accounts.containers.triggers.create @mutable tagmanager. + # accounts.containers.triggers.update # Corresponds to the JSON property `customEventFilter` # @return [Array] attr_accessor :custom_event_filter @@ -1413,15 +1356,15 @@ module Google # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :event_name - # The trigger will only fire iff all Conditions are true. - # @mutable tagmanager.accounts.containers.triggers.create - # @mutable tagmanager.accounts.containers.triggers.update + # The trigger will only fire iff all Conditions are true. @mutable tagmanager. + # accounts.containers.triggers.create @mutable tagmanager.accounts.containers. + # triggers.update # Corresponds to the JSON property `filter` # @return [Array] attr_accessor :filter - # The fingerprint of the GTM Trigger as computed at storage time. - # This value is recomputed whenever the trigger is modified. + # The fingerprint of the GTM Trigger as computed at storage time. This value is + # recomputed whenever the trigger is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint @@ -1451,16 +1394,15 @@ module Google # @return [Google::Apis::TagmanagerV1::Parameter] attr_accessor :max_timer_length_seconds - # Trigger display name. - # @mutable tagmanager.accounts.containers.triggers.create - # @mutable tagmanager.accounts.containers.triggers.update + # Trigger display name. @mutable tagmanager.accounts.containers.triggers.create @ + # mutable tagmanager.accounts.containers.triggers.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Additional parameters. - # @mutable tagmanager.accounts.containers.workspaces.triggers.create - # @mutable tagmanager.accounts.containers.workspaces.triggers.update + # Additional parameters. @mutable tagmanager.accounts.containers.workspaces. + # triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers. + # update # Corresponds to the JSON property `parameter` # @return [Array] attr_accessor :parameter @@ -1485,9 +1427,9 @@ module Google # @return [String] attr_accessor :trigger_id - # Defines the data layer event that causes this trigger. - # @mutable tagmanager.accounts.containers.triggers.create - # @mutable tagmanager.accounts.containers.triggers.update + # Defines the data layer event that causes this trigger. @mutable tagmanager. + # accounts.containers.triggers.create @mutable tagmanager.accounts.containers. + # triggers.update # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -1578,15 +1520,13 @@ module Google # @return [String] attr_accessor :account_id - # GTM Container access permissions. - # @mutable tagmanager.accounts.permissions.create - # @mutable tagmanager.accounts.permissions.update + # GTM Container access permissions. @mutable tagmanager.accounts.permissions. + # create @mutable tagmanager.accounts.permissions.update # Corresponds to the JSON property `containerAccess` # @return [Array] attr_accessor :container_access - # User's email address. - # @mutable tagmanager.accounts.permissions.create + # User's email address. @mutable tagmanager.accounts.permissions.create # Corresponds to the JSON property `emailAddress` # @return [String] attr_accessor :email_address @@ -1626,45 +1566,43 @@ module Google # For mobile containers only: A list of trigger IDs for disabling conditional # variables; the variable is enabled if one of the enabling trigger is true - # while all the disabling trigger are false. Treated as an unordered set. - # @mutable tagmanager.accounts.containers.variables.create - # @mutable tagmanager.accounts.containers.variables.update + # while all the disabling trigger are false. Treated as an unordered set. @ + # mutable tagmanager.accounts.containers.variables.create @mutable tagmanager. + # accounts.containers.variables.update # Corresponds to the JSON property `disablingTriggerId` # @return [Array] attr_accessor :disabling_trigger_id # For mobile containers only: A list of trigger IDs for enabling conditional # variables; the variable is enabled if one of the enabling triggers is true - # while all the disabling triggers are false. Treated as an unordered set. - # @mutable tagmanager.accounts.containers.variables.create - # @mutable tagmanager.accounts.containers.variables.update + # while all the disabling triggers are false. Treated as an unordered set. @ + # mutable tagmanager.accounts.containers.variables.create @mutable tagmanager. + # accounts.containers.variables.update # Corresponds to the JSON property `enablingTriggerId` # @return [Array] attr_accessor :enabling_trigger_id - # The fingerprint of the GTM Variable as computed at storage time. - # This value is recomputed whenever the variable is modified. + # The fingerprint of the GTM Variable as computed at storage time. This value is + # recomputed whenever the variable is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint - # Variable display name. - # @mutable tagmanager.accounts.containers.variables.create - # @mutable tagmanager.accounts.containers.variables.update + # Variable display name. @mutable tagmanager.accounts.containers.variables. + # create @mutable tagmanager.accounts.containers.variables.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # User notes on how to apply this variable in the container. - # @mutable tagmanager.accounts.containers.variables.create - # @mutable tagmanager.accounts.containers.variables.update + # User notes on how to apply this variable in the container. @mutable tagmanager. + # accounts.containers.variables.create @mutable tagmanager.accounts.containers. + # variables.update # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes - # The variable's parameters. - # @mutable tagmanager.accounts.containers.variables.create - # @mutable tagmanager.accounts.containers.variables.update + # The variable's parameters. @mutable tagmanager.accounts.containers.variables. + # create @mutable tagmanager.accounts.containers.variables.update # Corresponds to the JSON property `parameter` # @return [Array] attr_accessor :parameter @@ -1674,23 +1612,22 @@ module Google # @return [String] attr_accessor :parent_folder_id - # The end timestamp in milliseconds to schedule a variable. - # @mutable tagmanager.accounts.containers.variables.create - # @mutable tagmanager.accounts.containers.variables.update + # The end timestamp in milliseconds to schedule a variable. @mutable tagmanager. + # accounts.containers.variables.create @mutable tagmanager.accounts.containers. + # variables.update # Corresponds to the JSON property `scheduleEndMs` # @return [Fixnum] attr_accessor :schedule_end_ms - # The start timestamp in milliseconds to schedule a variable. - # @mutable tagmanager.accounts.containers.variables.create - # @mutable tagmanager.accounts.containers.variables.update + # The start timestamp in milliseconds to schedule a variable. @mutable + # tagmanager.accounts.containers.variables.create @mutable tagmanager.accounts. + # containers.variables.update # Corresponds to the JSON property `scheduleStartMs` # @return [Fixnum] attr_accessor :schedule_start_ms - # GTM Variable Type. - # @mutable tagmanager.accounts.containers.variables.create - # @mutable tagmanager.accounts.containers.variables.update + # GTM Variable Type. @mutable tagmanager.accounts.containers.variables.create @ + # mutable tagmanager.accounts.containers.variables.update # Corresponds to the JSON property `type` # @return [String] attr_accessor :type diff --git a/generated/google/apis/tagmanager_v1/service.rb b/generated/google/apis/tagmanager_v1/service.rb index 22797467e..b6682aa36 100644 --- a/generated/google/apis/tagmanager_v1/service.rb +++ b/generated/google/apis/tagmanager_v1/service.rb @@ -22,8 +22,7 @@ module Google module TagmanagerV1 # Tag Manager API # - # This API allows clients to access and modify container and tag - # configuration. + # This API allows clients to access and modify container and tag configuration. # # @example # require 'google/apis/tagmanager_v1' @@ -110,8 +109,8 @@ module Google # The GTM Account ID. # @param [Google::Apis::TagmanagerV1::Account] account_object # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the account - # in storage. + # When provided, this fingerprint must match the fingerprint of the account in + # storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -276,8 +275,8 @@ module Google # The GTM Container ID. # @param [Google::Apis::TagmanagerV1::Container] container_object # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the - # container in storage. + # When provided, this fingerprint must match the fingerprint of the container in + # storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -457,8 +456,8 @@ module Google # The GTM Environment ID. # @param [Google::Apis::TagmanagerV1::Environment] environment_object # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the - # environment in storage. + # When provided, this fingerprint must match the fingerprint of the environment + # in storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1124,8 +1123,8 @@ module Google # The GTM Trigger ID. # @param [Google::Apis::TagmanagerV1::Trigger] trigger_object # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the trigger - # in storage. + # When provided, this fingerprint must match the fingerprint of the trigger in + # storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1306,8 +1305,8 @@ module Google # The GTM Variable ID. # @param [Google::Apis::TagmanagerV1::Variable] variable_object # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the variable - # in storage. + # When provided, this fingerprint must match the fingerprint of the variable in + # storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1416,8 +1415,8 @@ module Google # @param [String] container_id # The GTM Container ID. # @param [String] container_version_id - # The GTM Container Version ID. Specify published to retrieve - # the currently published version. + # The GTM Container Version ID. Specify published to retrieve the currently + # published version. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1494,8 +1493,8 @@ module Google # @param [String] container_version_id # The GTM Container Version ID. # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the - # container version in storage. + # When provided, this fingerprint must match the fingerprint of the container + # version in storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1527,9 +1526,9 @@ module Google end # Restores a Container Version. This will overwrite the container's current - # configuration (including its variables, triggers and tags). The operation - # will not have any effect on the version that is being served (i.e. the - # published version). + # configuration (including its variables, triggers and tags). The operation will + # not have any effect on the version that is being served (i.e. the published + # version). # @param [String] account_id # The GTM Account ID. # @param [String] container_id @@ -1610,8 +1609,8 @@ module Google # The GTM Container Version ID. # @param [Google::Apis::TagmanagerV1::ContainerVersion] container_version_object # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the - # container version in storage. + # When provided, this fingerprint must match the fingerprint of the container + # version in storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/tagmanager_v2.rb b/generated/google/apis/tagmanager_v2.rb index 366a474e6..2ee8544f1 100644 --- a/generated/google/apis/tagmanager_v2.rb +++ b/generated/google/apis/tagmanager_v2.rb @@ -20,13 +20,12 @@ module Google module Apis # Tag Manager API # - # This API allows clients to access and modify container and tag - # configuration. + # This API allows clients to access and modify container and tag configuration. # # @see https://developers.google.com/tag-manager module TagmanagerV2 VERSION = 'V2' - REVISION = '20200728' + REVISION = '20200803' # Delete your Google Tag Manager containers AUTH_TAGMANAGER_DELETE_CONTAINERS = 'https://www.googleapis.com/auth/tagmanager.delete.containers' diff --git a/generated/google/apis/tagmanager_v2/classes.rb b/generated/google/apis/tagmanager_v2/classes.rb index 5760b58db..e85ca3d29 100644 --- a/generated/google/apis/tagmanager_v2/classes.rb +++ b/generated/google/apis/tagmanager_v2/classes.rb @@ -31,15 +31,14 @@ module Google # @return [String] attr_accessor :account_id - # The fingerprint of the GTM Account as computed at storage time. - # This value is recomputed whenever the account is modified. + # The fingerprint of the GTM Account as computed at storage time. This value is + # recomputed whenever the account is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint - # Account display name. - # @mutable tagmanager.accounts.create - # @mutable tagmanager.accounts.update + # Account display name. @mutable tagmanager.accounts.create @mutable tagmanager. + # accounts.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -49,13 +48,12 @@ module Google # @return [String] attr_accessor :path - # Whether the account shares data anonymously with Google and others. - # This flag enables benchmarking by sharing your data in an anonymous form. - # Google will remove all identifiable information about your website, combine - # the data with hundreds of other anonymous sites and report aggregate trends - # in the benchmarking service. - # @mutable tagmanager.accounts.create - # @mutable tagmanager.accounts.update + # Whether the account shares data anonymously with Google and others. This flag + # enables benchmarking by sharing your data in an anonymous form. Google will + # remove all identifiable information about your website, combine the data with + # hundreds of other anonymous sites and report aggregate trends in the + # benchmarking service. @mutable tagmanager.accounts.create @mutable tagmanager. + # accounts.update # Corresponds to the JSON property `shareData` # @return [Boolean] attr_accessor :share_data @@ -85,9 +83,9 @@ module Google class AccountAccess include Google::Apis::Core::Hashable - # Whether the user has no access, user access, or admin access to an account. - # @mutable tagmanager.accounts.permissions.create - # @mutable tagmanager.accounts.permissions.update + # Whether the user has no access, user access, or admin access to an account. @ + # mutable tagmanager.accounts.permissions.create @mutable tagmanager.accounts. + # permissions.update # Corresponds to the JSON property `permission` # @return [String] attr_accessor :permission @@ -104,8 +102,8 @@ module Google # Built-in variables are a special category of variables that are pre-created # and non-customizable. They provide common functionality like accessing - # propeties of the gtm data layer, monitoring clicks, or accessing elements - # of a page URL. + # propeties of the gtm data layer, monitoring clicks, or accessing elements of a + # page URL. class BuiltInVariable include Google::Apis::Core::Hashable @@ -129,9 +127,9 @@ module Google # @return [String] attr_accessor :path - # Type of built-in variable. - # @required.tagmanager.accounts.containers.workspaces.built_in_variable.update - # @mutable tagmanager.accounts.containers.workspaces.built_in_variable.update + # Type of built-in variable. @required.tagmanager.accounts.containers.workspaces. + # built_in_variable.update @mutable tagmanager.accounts.containers.workspaces. + # built_in_variable.update # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -175,22 +173,22 @@ module Google # @return [String] attr_accessor :container_id - # The fingerprint of the GTM Client as computed at storage time. - # This value is recomputed whenever the client is modified. + # The fingerprint of the GTM Client as computed at storage time. This value is + # recomputed whenever the client is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint - # Client display name. - # @mutable tagmanager.accounts.containers.workspaces.clients.create - # @mutable tagmanager.accounts.containers.workspaces.clients.update + # Client display name. @mutable tagmanager.accounts.containers.workspaces. + # clients.create @mutable tagmanager.accounts.containers.workspaces.clients. + # update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The client's parameters. - # @mutable tagmanager.accounts.containers.workspaces.clients.create - # @mutable tagmanager.accounts.containers.workspaces.clients.update + # The client's parameters. @mutable tagmanager.accounts.containers.workspaces. + # clients.create @mutable tagmanager.accounts.containers.workspaces.clients. + # update # Corresponds to the JSON property `parameter` # @return [Array] attr_accessor :parameter @@ -205,9 +203,9 @@ module Google # @return [String] attr_accessor :path - # Priority determines relative firing order. - # @mutable tagmanager.accounts.containers.workspaces.clients.create - # @mutable tagmanager.accounts.containers.workspaces.clients.update + # Priority determines relative firing order. @mutable tagmanager.accounts. + # containers.workspaces.clients.create @mutable tagmanager.accounts.containers. + # workspaces.clients.update # Corresponds to the JSON property `priority` # @return [Fixnum] attr_accessor :priority @@ -217,8 +215,7 @@ module Google # @return [String] attr_accessor :tag_manager_url - # Client type. - # @mutable tagmanager.accounts.containers.workspaces.clients.create + # Client type. @mutable tagmanager.accounts.containers.workspaces.clients.create # @mutable tagmanager.accounts.containers.workspaces.clients.update # Corresponds to the JSON property `type` # @return [String] @@ -255,29 +252,22 @@ module Google include Google::Apis::Core::Hashable # A list of named parameters (key/value), depending on the condition's type. - # Notes:
        - #
      • For binary operators, include parameters named arg0 and - # arg1 for specifying the left and right operands, - # respectively.
        • - #
      • At this time, the left operand (arg0) must be a reference - # to a variable.
        • - #
      • For case-insensitive Regex matching, include a boolean parameter named - # ignore_case that is set to true. + # Notes: - For binary operators, include parameters named arg0 and arg1 for + # specifying the left and right operands, respectively. - At this time, the left + # operand (arg0) must be a reference to a variable. - For case-insensitive Regex + # matching, include a boolean parameter named ignore_case that is set to true. # If not specified or set to any other value, the matching will be case - # sensitive.
        • - #
      • To negate an operator, include a boolean parameter named - # negate boolean parameter that is set to true. - #
        • - #
      - # @mutable tagmanager.accounts.containers.workspaces.triggers.create - # @mutable tagmanager.accounts.containers.workspaces.triggers.update + # sensitive. - To negate an operator, include a boolean parameter named negate + # boolean parameter that is set to true. @mutable tagmanager.accounts.containers. + # workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces. + # triggers.update # Corresponds to the JSON property `parameter` # @return [Array] attr_accessor :parameter - # The type of operator for this condition. - # @mutable tagmanager.accounts.containers.workspaces.triggers.create - # @mutable tagmanager.accounts.containers.workspaces.triggers.update + # The type of operator for this condition. @mutable tagmanager.accounts. + # containers.workspaces.triggers.create @mutable tagmanager.accounts.containers. + # workspaces.triggers.update # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -308,29 +298,26 @@ module Google # @return [String] attr_accessor :container_id - # List of domain names associated with the Container. - # @mutable tagmanager.accounts.containers.create - # @mutable tagmanager.accounts.containers.update + # List of domain names associated with the Container. @mutable tagmanager. + # accounts.containers.create @mutable tagmanager.accounts.containers.update # Corresponds to the JSON property `domainName` # @return [Array] attr_accessor :domain_name - # The fingerprint of the GTM Container as computed at storage time. This - # value is recomputed whenever the account is modified. + # The fingerprint of the GTM Container as computed at storage time. This value + # is recomputed whenever the account is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint - # Container display name. - # @mutable tagmanager.accounts.containers.create - # @mutable tagmanager.accounts.containers.update + # Container display name. @mutable tagmanager.accounts.containers.create @ + # mutable tagmanager.accounts.containers.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Container Notes. - # @mutable tagmanager.accounts.containers.create - # @mutable tagmanager.accounts.containers.update + # Container Notes. @mutable tagmanager.accounts.containers.create @mutable + # tagmanager.accounts.containers.update # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes @@ -350,10 +337,9 @@ module Google # @return [String] attr_accessor :tag_manager_url - # List of Usage Contexts for the Container. Valid values include: web, - # android, or ios. - # @mutable tagmanager.accounts.containers.create - # @mutable tagmanager.accounts.containers.update + # List of Usage Contexts for the Container. Valid values include: web, android, + # or ios. @mutable tagmanager.accounts.containers.create @mutable tagmanager. + # accounts.containers.update # Corresponds to the JSON property `usageContext` # @return [Array] attr_accessor :usage_context @@ -381,15 +367,13 @@ module Google class ContainerAccess include Google::Apis::Core::Hashable - # GTM Container ID. - # @mutable tagmanager.accounts.permissions.create - # @mutable tagmanager.accounts.permissions.update + # GTM Container ID. @mutable tagmanager.accounts.permissions.create @mutable + # tagmanager.accounts.permissions.update # Corresponds to the JSON property `containerId` # @return [String] attr_accessor :container_id - # List of Container permissions. - # @mutable tagmanager.accounts.permissions.create + # List of Container permissions. @mutable tagmanager.accounts.permissions.create # @mutable tagmanager.accounts.permissions.update # Corresponds to the JSON property `permission` # @return [String] @@ -452,15 +436,14 @@ module Google attr_accessor :deleted alias_method :deleted?, :deleted - # Container version description. - # @mutable tagmanager.accounts.containers.versions.update + # Container version description. @mutable tagmanager.accounts.containers. + # versions.update # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # The fingerprint of the GTM Container Version as computed at - # storage time. This value is recomputed whenever the container version is - # modified. + # The fingerprint of the GTM Container Version as computed at storage time. This + # value is recomputed whenever the container version is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint @@ -470,8 +453,8 @@ module Google # @return [Array] attr_accessor :folder - # Container version display name. - # @mutable tagmanager.accounts.containers.versions.update + # Container version display name. @mutable tagmanager.accounts.containers. + # versions.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -685,8 +668,7 @@ module Google attr_accessor :container_version # Auto generated workspace path created as a result of version creation. This - # field should only be populated if the created version was not a quick - # preview. + # field should only be populated if the created version was not a quick preview. # Corresponds to the JSON property `newWorkspacePath` # @return [String] attr_accessor :new_workspace_path @@ -723,8 +705,8 @@ module Google # @return [String] attr_accessor :container_id - # The fingerprint of the GTM Custom Template as computed at storage time. - # This value is recomputed whenever the template is modified. + # The fingerprint of the GTM Custom Template as computed at storage time. This + # value is recomputed whenever the template is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint @@ -860,16 +842,15 @@ module Google attr_accessor :container_version_id # The environment description. Can be set or changed only on USER type - # environments. - # @mutable tagmanager.accounts.containers.environments.create - # @mutable tagmanager.accounts.containers.environments.update + # environments. @mutable tagmanager.accounts.containers.environments.create @ + # mutable tagmanager.accounts.containers.environments.update # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Whether or not to enable debug by default for the environment. - # @mutable tagmanager.accounts.containers.environments.create - # @mutable tagmanager.accounts.containers.environments.update + # Whether or not to enable debug by default for the environment. @mutable + # tagmanager.accounts.containers.environments.create @mutable tagmanager. + # accounts.containers.environments.update # Corresponds to the JSON property `enableDebug` # @return [Boolean] attr_accessor :enable_debug @@ -880,16 +861,15 @@ module Google # @return [String] attr_accessor :environment_id - # The fingerprint of the GTM environment as computed at storage time. - # This value is recomputed whenever the environment is modified. + # The fingerprint of the GTM environment as computed at storage time. This value + # is recomputed whenever the environment is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint # The environment display name. Can be set or changed only on USER type - # environments. - # @mutable tagmanager.accounts.containers.environments.create - # @mutable tagmanager.accounts.containers.environments.update + # environments. @mutable tagmanager.accounts.containers.environments.create @ + # mutable tagmanager.accounts.containers.environments.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -909,9 +889,9 @@ module Google # @return [String] attr_accessor :type - # Default preview page url for the environment. - # @mutable tagmanager.accounts.containers.environments.create - # @mutable tagmanager.accounts.containers.environments.update + # Default preview page url for the environment. @mutable tagmanager.accounts. + # containers.environments.create @mutable tagmanager.accounts.containers. + # environments.update # Corresponds to the JSON property `url` # @return [String] attr_accessor :url @@ -959,8 +939,8 @@ module Google # @return [String] attr_accessor :container_id - # The fingerprint of the GTM Folder as computed at storage time. - # This value is recomputed whenever the folder is modified. + # The fingerprint of the GTM Folder as computed at storage time. This value is + # recomputed whenever the folder is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint @@ -970,16 +950,16 @@ module Google # @return [String] attr_accessor :folder_id - # Folder display name. - # @mutable tagmanager.accounts.containers.workspaces.folders.create - # @mutable tagmanager.accounts.containers.workspaces.folders.update + # Folder display name. @mutable tagmanager.accounts.containers.workspaces. + # folders.create @mutable tagmanager.accounts.containers.workspaces.folders. + # update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # User notes on how to apply this folder in the container. - # @mutable tagmanager.accounts.containers.workspaces.folders.create - # @mutable tagmanager.accounts.containers.workspaces.folders.update + # User notes on how to apply this folder in the container. @mutable tagmanager. + # accounts.containers.workspaces.folders.create @mutable tagmanager.accounts. + # containers.workspaces.folders.update # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes @@ -1064,7 +1044,7 @@ module Google # @return [String] attr_accessor :host - # If a user has manually edited the community gallery template. + # If a user has manually edited the community gallery template. # Corresponds to the JSON property `isModified` # @return [Boolean] attr_accessor :is_modified @@ -1488,74 +1468,62 @@ module Google class Parameter include Google::Apis::Core::Hashable - # The named key that uniquely identifies a parameter. Required for top-level - # parameters, as well as map values. Ignored for list values. - # @mutable tagmanager.accounts.containers.workspaces.variables.create - # @mutable tagmanager.accounts.containers.workspaces.variables.update - # @mutable tagmanager.accounts.containers.workspaces.triggers.create - # @mutable tagmanager.accounts.containers.workspaces.triggers.update - # @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update + # The named key that uniquely identifies a parameter. Required for top-level + # parameters, as well as map values. Ignored for list values. @mutable + # tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager. + # accounts.containers.workspaces.variables.update @mutable tagmanager.accounts. + # containers.workspaces.triggers.create @mutable tagmanager.accounts.containers. + # workspaces.triggers.update @mutable tagmanager.accounts.containers.workspaces. + # tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update # Corresponds to the JSON property `key` # @return [String] attr_accessor :key - # This list parameter's parameters (keys will be ignored). - # @mutable tagmanager.accounts.containers.workspaces.variables.create - # @mutable tagmanager.accounts.containers.workspaces.variables.update - # @mutable tagmanager.accounts.containers.workspaces.triggers.create - # @mutable tagmanager.accounts.containers.workspaces.triggers.update - # @mutable tagmanager.accounts.containers.workspaces.tags.create + # This list parameter's parameters (keys will be ignored). @mutable tagmanager. + # accounts.containers.workspaces.variables.create @mutable tagmanager.accounts. + # containers.workspaces.variables.update @mutable tagmanager.accounts.containers. + # workspaces.triggers.create @mutable tagmanager.accounts.containers.workspaces. + # triggers.update @mutable tagmanager.accounts.containers.workspaces.tags.create # @mutable tagmanager.accounts.containers.workspaces.tags.update # Corresponds to the JSON property `list` # @return [Array] attr_accessor :list - # This map parameter's parameters (must have keys; keys must be unique). - # @mutable tagmanager.accounts.containers.workspaces.variables.create - # @mutable tagmanager.accounts.containers.workspaces.variables.update - # @mutable tagmanager.accounts.containers.workspaces.triggers.create - # @mutable tagmanager.accounts.containers.workspaces.triggers.update - # @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update + # This map parameter's parameters (must have keys; keys must be unique). @ + # mutable tagmanager.accounts.containers.workspaces.variables.create @mutable + # tagmanager.accounts.containers.workspaces.variables.update @mutable tagmanager. + # accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts. + # containers.workspaces.triggers.update @mutable tagmanager.accounts.containers. + # workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags. + # update # Corresponds to the JSON property `map` # @return [Array] attr_accessor :map - # The parameter type. Valid values are:
        - #
      • boolean: The value represents a boolean, represented as - # 'true' or 'false'
        • - #
      • integer: The value represents a 64-bit signed integer - # value, in base 10
        • - #
      • list: A list of parameters should be specified
        • - #
      • map: A map of parameters should be specified
        • - #
      • template: The value represents any text; this can include - # variable references (even variable references that might return - # non-string types)
        • - #
      • trigger_reference: The value represents a trigger, - # represented as the trigger id
        • - #
      • tag_reference: The value represents a tag, represented as - # the tag name
        • - #
      - # @mutable tagmanager.accounts.containers.workspaces.variables.create - # @mutable tagmanager.accounts.containers.workspaces.variables.update - # @mutable tagmanager.accounts.containers.workspaces.triggers.create - # @mutable tagmanager.accounts.containers.workspaces.triggers.update - # @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update + # The parameter type. Valid values are: - boolean: The value represents a + # boolean, represented as 'true' or 'false' - integer: The value represents a 64- + # bit signed integer value, in base 10 - list: A list of parameters should be + # specified - map: A map of parameters should be specified - template: The value + # represents any text; this can include variable references (even variable + # references that might return non-string types) - trigger_reference: The value + # represents a trigger, represented as the trigger id - tag_reference: The value + # represents a tag, represented as the tag name @mutable tagmanager.accounts. + # containers.workspaces.variables.create @mutable tagmanager.accounts.containers. + # workspaces.variables.update @mutable tagmanager.accounts.containers.workspaces. + # triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers. + # update @mutable tagmanager.accounts.containers.workspaces.tags.create @mutable + # tagmanager.accounts.containers.workspaces.tags.update # Corresponds to the JSON property `type` # @return [String] attr_accessor :type - # A parameter's value (may contain variable references such as - # "``myVariable``") - # as appropriate to the specified type. - # @mutable tagmanager.accounts.containers.workspaces.variables.create - # @mutable tagmanager.accounts.containers.workspaces.variables.update - # @mutable tagmanager.accounts.containers.workspaces.triggers.create - # @mutable tagmanager.accounts.containers.workspaces.triggers.update - # @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update + # A parameter's value (may contain variable references such as "``myVariable``") + # as appropriate to the specified type. @mutable tagmanager.accounts.containers. + # workspaces.variables.create @mutable tagmanager.accounts.containers.workspaces. + # variables.update @mutable tagmanager.accounts.containers.workspaces.triggers. + # create @mutable tagmanager.accounts.containers.workspaces.triggers.update @ + # mutable tagmanager.accounts.containers.workspaces.tags.create @mutable + # tagmanager.accounts.containers.workspaces.tags.update # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -1766,14 +1734,13 @@ module Google end end - # Represents a reference to atag that fires before another tag in order to - # set up dependencies. + # Represents a reference to atag that fires before another tag in order to set + # up dependencies. class SetupTag include Google::Apis::Core::Hashable - # If true, fire the main tag if and only if the setup tag fires - # successfully. - # If false, fire the main tag regardless of setup tag firing status. + # If true, fire the main tag if and only if the setup tag fires successfully. If + # false, fire the main tag regardless of setup tag firing status. # Corresponds to the JSON property `stopOnSetupFailure` # @return [Boolean] attr_accessor :stop_on_setup_failure @@ -1826,9 +1793,9 @@ module Google class SyncWorkspaceResponse include Google::Apis::Core::Hashable - # The merge conflict after sync. - # If this field is not empty, the sync is still treated as successful. - # But a version cannot be created until all conflicts are resolved. + # The merge conflict after sync. If this field is not empty, the sync is still + # treated as successful. But a version cannot be created until all conflicts are + # resolved. # Corresponds to the JSON property `mergeConflict` # @return [Array] attr_accessor :merge_conflict @@ -1858,18 +1825,16 @@ module Google # @return [String] attr_accessor :account_id - # Blocking rule IDs. If any of the listed rules evaluate to true, the tag - # will not fire. - # @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update + # Blocking rule IDs. If any of the listed rules evaluate to true, the tag will + # not fire. @mutable tagmanager.accounts.containers.workspaces.tags.create @ + # mutable tagmanager.accounts.containers.workspaces.tags.update # Corresponds to the JSON property `blockingRuleId` # @return [Array] attr_accessor :blocking_rule_id - # Blocking trigger IDs. If any of the listed triggers evaluate to true, the - # tag will not fire. - # @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update + # Blocking trigger IDs. If any of the listed triggers evaluate to true, the tag + # will not fire. @mutable tagmanager.accounts.containers.workspaces.tags.create @ + # mutable tagmanager.accounts.containers.workspaces.tags.update # Corresponds to the JSON property `blockingTriggerId` # @return [Array] attr_accessor :blocking_trigger_id @@ -1879,33 +1844,31 @@ module Google # @return [String] attr_accessor :container_id - # The fingerprint of the GTM Tag as computed at storage time. - # This value is recomputed whenever the tag is modified. + # The fingerprint of the GTM Tag as computed at storage time. This value is + # recomputed whenever the tag is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint - # Firing rule IDs. A tag will fire when any of the listed rules are true and - # all of its blockingRuleIds (if any specified) are false. - # @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update + # Firing rule IDs. A tag will fire when any of the listed rules are true and all + # of its blockingRuleIds (if any specified) are false. @mutable tagmanager. + # accounts.containers.workspaces.tags.create @mutable tagmanager.accounts. + # containers.workspaces.tags.update # Corresponds to the JSON property `firingRuleId` # @return [Array] attr_accessor :firing_rule_id - # Firing trigger IDs. A tag will fire when any of the listed triggers are - # true and all of its blockingTriggerIds (if any specified) are - # false. - # @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update + # Firing trigger IDs. A tag will fire when any of the listed triggers are true + # and all of its blockingTriggerIds (if any specified) are false. @mutable + # tagmanager.accounts.containers.workspaces.tags.create @mutable tagmanager. + # accounts.containers.workspaces.tags.update # Corresponds to the JSON property `firingTriggerId` # @return [Array] attr_accessor :firing_trigger_id - # If set to true, this tag will only fire in the live environment (e.g. not - # in preview or debug mode). - # @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update + # If set to true, this tag will only fire in the live environment (e.g. not in + # preview or debug mode). @mutable tagmanager.accounts.containers.workspaces. + # tags.create @mutable tagmanager.accounts.containers.workspaces.tags.update # Corresponds to the JSON property `liveOnly` # @return [Boolean] attr_accessor :live_only @@ -1917,30 +1880,28 @@ module Google attr_accessor :monitoring_metadata # If non-empty, then the tag display name will be included in the monitoring - # metadata map using the key specified. - # @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update + # metadata map using the key specified. @mutable tagmanager.accounts.containers. + # workspaces.tags.create @mutable tagmanager.accounts.containers.workspaces.tags. + # update # Corresponds to the JSON property `monitoringMetadataTagNameKey` # @return [String] attr_accessor :monitoring_metadata_tag_name_key - # Tag display name. - # @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update + # Tag display name. @mutable tagmanager.accounts.containers.workspaces.tags. + # create @mutable tagmanager.accounts.containers.workspaces.tags.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # User notes on how to apply this tag in the container. - # @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update + # User notes on how to apply this tag in the container. @mutable tagmanager. + # accounts.containers.workspaces.tags.create @mutable tagmanager.accounts. + # containers.workspaces.tags.update # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes - # The tag's parameters. - # @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update + # The tag's parameters. @mutable tagmanager.accounts.containers.workspaces.tags. + # create @mutable tagmanager.accounts.containers.workspaces.tags.update # Corresponds to the JSON property `parameter` # @return [Array] attr_accessor :parameter @@ -1955,9 +1916,9 @@ module Google # @return [String] attr_accessor :path - # Indicates whether the tag is paused, which prevents the tag from firing. - # @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update + # Indicates whether the tag is paused, which prevents the tag from firing. @ + # mutable tagmanager.accounts.containers.workspaces.tags.create @mutable + # tagmanager.accounts.containers.workspaces.tags.update # Corresponds to the JSON property `paused` # @return [Boolean] attr_accessor :paused @@ -1968,16 +1929,16 @@ module Google # @return [Google::Apis::TagmanagerV2::Parameter] attr_accessor :priority - # The end timestamp in milliseconds to schedule a tag. - # @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update + # The end timestamp in milliseconds to schedule a tag. @mutable tagmanager. + # accounts.containers.workspaces.tags.create @mutable tagmanager.accounts. + # containers.workspaces.tags.update # Corresponds to the JSON property `scheduleEndMs` # @return [Fixnum] attr_accessor :schedule_end_ms - # The start timestamp in milliseconds to schedule a tag. - # @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update + # The start timestamp in milliseconds to schedule a tag. @mutable tagmanager. + # accounts.containers.workspaces.tags.create @mutable tagmanager.accounts. + # containers.workspaces.tags.update # Corresponds to the JSON property `scheduleStartMs` # @return [Fixnum] attr_accessor :schedule_start_ms @@ -2007,9 +1968,8 @@ module Google # @return [Array] attr_accessor :teardown_tag - # GTM Tag Type. - # @mutable tagmanager.accounts.containers.workspaces.tags.create - # @mutable tagmanager.accounts.containers.workspaces.tags.update + # GTM Tag Type. @mutable tagmanager.accounts.containers.workspaces.tags.create @ + # mutable tagmanager.accounts.containers.workspaces.tags.update # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -2059,8 +2019,7 @@ module Google class TeardownTag include Google::Apis::Core::Hashable - # If true, fire the teardown tag if and only if the main tag fires - # successfully. + # If true, fire the teardown tag if and only if the main tag fires successfully. # If false, fire the teardown tag regardless of main tag firing status. # Corresponds to the JSON property `stopTeardownOnFailure` # @return [Boolean] @@ -2092,9 +2051,9 @@ module Google # @return [String] attr_accessor :account_id - # Used in the case of auto event tracking. - # @mutable tagmanager.accounts.containers.workspaces.triggers.create - # @mutable tagmanager.accounts.containers.workspaces.triggers.update + # Used in the case of auto event tracking. @mutable tagmanager.accounts. + # containers.workspaces.triggers.create @mutable tagmanager.accounts.containers. + # workspaces.triggers.update # Corresponds to the JSON property `autoEventFilter` # @return [Array] attr_accessor :auto_event_filter @@ -2114,10 +2073,9 @@ module Google # @return [Google::Apis::TagmanagerV2::Parameter] attr_accessor :continuous_time_min_milliseconds - # Used in the case of custom event, which is fired iff all Conditions are - # true. - # @mutable tagmanager.accounts.containers.workspaces.triggers.create - # @mutable tagmanager.accounts.containers.workspaces.triggers.update + # Used in the case of custom event, which is fired iff all Conditions are true. @ + # mutable tagmanager.accounts.containers.workspaces.triggers.create @mutable + # tagmanager.accounts.containers.workspaces.triggers.update # Corresponds to the JSON property `customEventFilter` # @return [Array] attr_accessor :custom_event_filter @@ -2127,15 +2085,15 @@ module Google # @return [Google::Apis::TagmanagerV2::Parameter] attr_accessor :event_name - # The trigger will only fire iff all Conditions are true. - # @mutable tagmanager.accounts.containers.workspaces.triggers.create - # @mutable tagmanager.accounts.containers.workspaces.triggers.update + # The trigger will only fire iff all Conditions are true. @mutable tagmanager. + # accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts. + # containers.workspaces.triggers.update # Corresponds to the JSON property `filter` # @return [Array] attr_accessor :filter - # The fingerprint of the GTM Trigger as computed at storage time. - # This value is recomputed whenever the trigger is modified. + # The fingerprint of the GTM Trigger as computed at storage time. This value is + # recomputed whenever the trigger is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint @@ -2165,23 +2123,23 @@ module Google # @return [Google::Apis::TagmanagerV2::Parameter] attr_accessor :max_timer_length_seconds - # Trigger display name. - # @mutable tagmanager.accounts.containers.workspaces.triggers.create - # @mutable tagmanager.accounts.containers.workspaces.triggers.update + # Trigger display name. @mutable tagmanager.accounts.containers.workspaces. + # triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers. + # update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # User notes on how to apply this trigger in the container. - # @mutable tagmanager.accounts.containers.workspaces.triggers.create - # @mutable tagmanager.accounts.containers.workspaces.triggers.update + # User notes on how to apply this trigger in the container. @mutable tagmanager. + # accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts. + # containers.workspaces.triggers.update # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes - # Additional parameters. - # @mutable tagmanager.accounts.containers.workspaces.triggers.create - # @mutable tagmanager.accounts.containers.workspaces.triggers.update + # Additional parameters. @mutable tagmanager.accounts.containers.workspaces. + # triggers.create @mutable tagmanager.accounts.containers.workspaces.triggers. + # update # Corresponds to the JSON property `parameter` # @return [Array] attr_accessor :parameter @@ -2216,9 +2174,9 @@ module Google # @return [String] attr_accessor :trigger_id - # Defines the data layer event that causes this trigger. - # @mutable tagmanager.accounts.containers.workspaces.triggers.create - # @mutable tagmanager.accounts.containers.workspaces.triggers.update + # Defines the data layer event that causes this trigger. @mutable tagmanager. + # accounts.containers.workspaces.triggers.create @mutable tagmanager.accounts. + # containers.workspaces.triggers.update # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -2318,15 +2276,13 @@ module Google # @return [String] attr_accessor :account_id - # GTM Container access permissions. - # @mutable tagmanager.accounts.permissions.create - # @mutable tagmanager.accounts.permissions.update + # GTM Container access permissions. @mutable tagmanager.accounts.permissions. + # create @mutable tagmanager.accounts.permissions.update # Corresponds to the JSON property `containerAccess` # @return [Array] attr_accessor :container_access - # User's email address. - # @mutable tagmanager.accounts.permissions.create + # User's email address. @mutable tagmanager.accounts.permissions.create # Corresponds to the JSON property `emailAddress` # @return [String] attr_accessor :email_address @@ -2366,24 +2322,24 @@ module Google # For mobile containers only: A list of trigger IDs for disabling conditional # variables; the variable is enabled if one of the enabling trigger is true - # while all the disabling trigger are false. Treated as an unordered set. - # @mutable tagmanager.accounts.containers.workspaces.variables.create - # @mutable tagmanager.accounts.containers.workspaces.variables.update + # while all the disabling trigger are false. Treated as an unordered set. @ + # mutable tagmanager.accounts.containers.workspaces.variables.create @mutable + # tagmanager.accounts.containers.workspaces.variables.update # Corresponds to the JSON property `disablingTriggerId` # @return [Array] attr_accessor :disabling_trigger_id # For mobile containers only: A list of trigger IDs for enabling conditional # variables; the variable is enabled if one of the enabling triggers is true - # while all the disabling triggers are false. Treated as an unordered set. - # @mutable tagmanager.accounts.containers.workspaces.variables.create - # @mutable tagmanager.accounts.containers.workspaces.variables.update + # while all the disabling triggers are false. Treated as an unordered set. @ + # mutable tagmanager.accounts.containers.workspaces.variables.create @mutable + # tagmanager.accounts.containers.workspaces.variables.update # Corresponds to the JSON property `enablingTriggerId` # @return [Array] attr_accessor :enabling_trigger_id - # The fingerprint of the GTM Variable as computed at storage time. - # This value is recomputed whenever the variable is modified. + # The fingerprint of the GTM Variable as computed at storage time. This value is + # recomputed whenever the variable is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint @@ -2393,23 +2349,23 @@ module Google # @return [Google::Apis::TagmanagerV2::VariableFormatValue] attr_accessor :format_value - # Variable display name. - # @mutable tagmanager.accounts.containers.workspaces.variables.create - # @mutable tagmanager.accounts.containers.workspaces.variables.update + # Variable display name. @mutable tagmanager.accounts.containers.workspaces. + # variables.create @mutable tagmanager.accounts.containers.workspaces.variables. + # update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # User notes on how to apply this variable in the container. - # @mutable tagmanager.accounts.containers.workspaces.variables.create - # @mutable tagmanager.accounts.containers.workspaces.variables.update + # User notes on how to apply this variable in the container. @mutable tagmanager. + # accounts.containers.workspaces.variables.create @mutable tagmanager.accounts. + # containers.workspaces.variables.update # Corresponds to the JSON property `notes` # @return [String] attr_accessor :notes - # The variable's parameters. - # @mutable tagmanager.accounts.containers.workspaces.variables.create - # @mutable tagmanager.accounts.containers.workspaces.variables.update + # The variable's parameters. @mutable tagmanager.accounts.containers.workspaces. + # variables.create @mutable tagmanager.accounts.containers.workspaces.variables. + # update # Corresponds to the JSON property `parameter` # @return [Array] attr_accessor :parameter @@ -2424,16 +2380,16 @@ module Google # @return [String] attr_accessor :path - # The end timestamp in milliseconds to schedule a variable. - # @mutable tagmanager.accounts.containers.workspaces.variables.create - # @mutable tagmanager.accounts.containers.workspaces.variables.update + # The end timestamp in milliseconds to schedule a variable. @mutable tagmanager. + # accounts.containers.workspaces.variables.create @mutable tagmanager.accounts. + # containers.workspaces.variables.update # Corresponds to the JSON property `scheduleEndMs` # @return [Fixnum] attr_accessor :schedule_end_ms - # The start timestamp in milliseconds to schedule a variable. - # @mutable tagmanager.accounts.containers.workspaces.variables.create - # @mutable tagmanager.accounts.containers.workspaces.variables.update + # The start timestamp in milliseconds to schedule a variable. @mutable + # tagmanager.accounts.containers.workspaces.variables.create @mutable tagmanager. + # accounts.containers.workspaces.variables.update # Corresponds to the JSON property `scheduleStartMs` # @return [Fixnum] attr_accessor :schedule_start_ms @@ -2443,9 +2399,9 @@ module Google # @return [String] attr_accessor :tag_manager_url - # GTM Variable Type. - # @mutable tagmanager.accounts.containers.workspaces.variables.create - # @mutable tagmanager.accounts.containers.workspaces.variables.update + # GTM Variable Type. @mutable tagmanager.accounts.containers.workspaces. + # variables.create @mutable tagmanager.accounts.containers.workspaces.variables. + # update # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -2544,22 +2500,20 @@ module Google # @return [String] attr_accessor :container_id - # Workspace description. - # @mutable tagmanager.accounts.containers.workspaces.create - # @mutable tagmanager.accounts.containers.workspaces.update + # Workspace description. @mutable tagmanager.accounts.containers.workspaces. + # create @mutable tagmanager.accounts.containers.workspaces.update # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # The fingerprint of the GTM Workspace as computed at storage time. This - # value is recomputed whenever the workspace is modified. + # The fingerprint of the GTM Workspace as computed at storage time. This value + # is recomputed whenever the workspace is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint - # Workspace display name. - # @mutable tagmanager.accounts.containers.workspaces.create - # @mutable tagmanager.accounts.containers.workspaces.update + # Workspace display name. @mutable tagmanager.accounts.containers.workspaces. + # create @mutable tagmanager.accounts.containers.workspaces.update # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -2620,8 +2574,8 @@ module Google # @return [String] attr_accessor :container_id - # The fingerprint of the GTM Zone as computed at storage time. - # This value is recomputed whenever the zone is modified. + # The fingerprint of the GTM Zone as computed at storage time. This value is + # recomputed whenever the zone is modified. # Corresponds to the JSON property `fingerprint` # @return [String] attr_accessor :fingerprint @@ -2691,8 +2645,8 @@ module Google # @return [Array] attr_accessor :condition - # Custom evaluation trigger IDs. A zone will evaluate its boundary - # conditions when any of the listed triggers are true. + # Custom evaluation trigger IDs. A zone will evaluate its boundary conditions + # when any of the listed triggers are true. # Corresponds to the JSON property `customEvaluationTriggerId` # @return [Array] attr_accessor :custom_evaluation_trigger_id diff --git a/generated/google/apis/tagmanager_v2/service.rb b/generated/google/apis/tagmanager_v2/service.rb index ea9f3a9c0..f581b8253 100644 --- a/generated/google/apis/tagmanager_v2/service.rb +++ b/generated/google/apis/tagmanager_v2/service.rb @@ -22,8 +22,7 @@ module Google module TagmanagerV2 # Tag Manager API # - # This API allows clients to access and modify container and tag - # configuration. + # This API allows clients to access and modify container and tag configuration. # # @example # require 'google/apis/tagmanager_v2' @@ -50,8 +49,7 @@ module Google # Gets a GTM Account. # @param [String] path - # GTM Accounts's API relative path. - # Example: accounts/`account_id` + # GTM Accounts's API relative path. Example: accounts/`account_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -111,12 +109,11 @@ module Google # Updates a GTM Account. # @param [String] path - # GTM Accounts's API relative path. - # Example: accounts/`account_id` + # GTM Accounts's API relative path. Example: accounts/`account_id` # @param [Google::Apis::TagmanagerV2::Account] account_object # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the account - # in storage. + # When provided, this fingerprint must match the fingerprint of the account in + # storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -149,8 +146,7 @@ module Google # Creates a Container. # @param [String] parent - # GTM Account's API relative path. - # Example: accounts/`account_id`. + # GTM Account's API relative path. Example: accounts/`account_id`. # @param [Google::Apis::TagmanagerV2::Container] container_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -183,8 +179,8 @@ module Google # Deletes a Container. # @param [String] path - # GTM Container's API relative path. - # Example: accounts/`account_id`/containers/`container_id` + # GTM Container's API relative path. Example: accounts/`account_id`/containers/` + # container_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -212,8 +208,8 @@ module Google # Gets a Container. # @param [String] path - # GTM Container's API relative path. - # Example: accounts/`account_id`/containers/`container_id` + # GTM Container's API relative path. Example: accounts/`account_id`/containers/` + # container_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -243,8 +239,7 @@ module Google # Lists all Containers that belongs to a GTM Account. # @param [String] parent - # GTM Accounts's API relative path. - # Example: accounts/`account_id`. + # GTM Accounts's API relative path. Example: accounts/`account_id`. # @param [String] page_token # Continuation token for fetching the next page of results. # @param [String] fields @@ -277,12 +272,12 @@ module Google # Updates a Container. # @param [String] path - # GTM Container's API relative path. - # Example: accounts/`account_id`/containers/`container_id` + # GTM Container's API relative path. Example: accounts/`account_id`/containers/` + # container_id` # @param [Google::Apis::TagmanagerV2::Container] container_object # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the - # container in storage. + # When provided, this fingerprint must match the fingerprint of the container in + # storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -315,8 +310,8 @@ module Google # Creates a GTM Environment. # @param [String] parent - # GTM Container's API relative path. - # Example: accounts/`account_id`/containers/`container_id` + # GTM Container's API relative path. Example: accounts/`account_id`/containers/` + # container_id` # @param [Google::Apis::TagmanagerV2::Environment] environment_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -349,9 +344,8 @@ module Google # Deletes a GTM Environment. # @param [String] path - # GTM Environment's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/environments/`environment_id` + # GTM Environment's API relative path. Example: accounts/`account_id`/containers/ + # `container_id`/environments/`environment_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -379,9 +373,8 @@ module Google # Gets a GTM Environment. # @param [String] path - # GTM Environment's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/environments/`environment_id` + # GTM Environment's API relative path. Example: accounts/`account_id`/containers/ + # `container_id`/environments/`environment_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -411,8 +404,8 @@ module Google # Lists all GTM Environments of a GTM Container. # @param [String] parent - # GTM Container's API relative path. - # Example: accounts/`account_id`/containers/`container_id` + # GTM Container's API relative path. Example: accounts/`account_id`/containers/` + # container_id` # @param [String] page_token # Continuation token for fetching the next page of results. # @param [String] fields @@ -445,9 +438,8 @@ module Google # Re-generates the authorization code for a GTM Environment. # @param [String] path - # GTM Environment's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/environments/`environment_id` + # GTM Environment's API relative path. Example: accounts/`account_id`/containers/ + # `container_id`/environments/`environment_id` # @param [Google::Apis::TagmanagerV2::Environment] environment_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -480,13 +472,12 @@ module Google # Updates a GTM Environment. # @param [String] path - # GTM Environment's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/environments/`environment_id` + # GTM Environment's API relative path. Example: accounts/`account_id`/containers/ + # `container_id`/environments/`environment_id` # @param [Google::Apis::TagmanagerV2::Environment] environment_object # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the - # environment in storage. + # When provided, this fingerprint must match the fingerprint of the environment + # in storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -519,8 +510,8 @@ module Google # Gets the latest container version header # @param [String] parent - # GTM Container's API relative path. - # Example: accounts/`account_id`/containers/`container_id` + # GTM Container's API relative path. Example: accounts/`account_id`/containers/` + # container_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -550,8 +541,8 @@ module Google # Lists all Container Versions of a GTM Container. # @param [String] parent - # GTM Container's API relative path. - # Example: accounts/`account_id`/containers/`container_id` + # GTM Container's API relative path. Example: accounts/`account_id`/containers/` + # container_id` # @param [Boolean] include_deleted # Also retrieve deleted (archived) versions when true. # @param [String] page_token @@ -587,9 +578,8 @@ module Google # Deletes a Container Version. # @param [String] path - # GTM ContainerVersion's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/versions/`version_id` + # GTM ContainerVersion's API relative path. Example: accounts/`account_id`/ + # containers/`container_id`/versions/`version_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -617,12 +607,11 @@ module Google # Gets a Container Version. # @param [String] path - # GTM ContainerVersion's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/versions/`version_id` + # GTM ContainerVersion's API relative path. Example: accounts/`account_id`/ + # containers/`container_id`/versions/`version_id` # @param [String] container_version_id - # The GTM ContainerVersion ID. Specify published to retrieve - # the currently published version. + # The GTM ContainerVersion ID. Specify published to retrieve the currently + # published version. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -653,8 +642,8 @@ module Google # Gets the live (i.e. published) container version # @param [String] parent - # GTM Container's API relative path. - # Example: accounts/`account_id`/containers/`container_id` + # GTM Container's API relative path. Example: accounts/`account_id`/containers/` + # container_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -684,12 +673,11 @@ module Google # Publishes a Container Version. # @param [String] path - # GTM ContainerVersion's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/versions/`version_id` + # GTM ContainerVersion's API relative path. Example: accounts/`account_id`/ + # containers/`container_id`/versions/`version_id` # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the - # container version in storage. + # When provided, this fingerprint must match the fingerprint of the container + # version in storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -718,12 +706,11 @@ module Google execute_or_queue_command(command, &block) end - # Sets the latest version used for synchronization of workspaces when - # detecting conflicts and errors. + # Sets the latest version used for synchronization of workspaces when detecting + # conflicts and errors. # @param [String] path - # GTM ContainerVersion's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/versions/`version_id` + # GTM ContainerVersion's API relative path. Example: accounts/`account_id`/ + # containers/`container_id`/versions/`version_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -753,9 +740,8 @@ module Google # Undeletes a Container Version. # @param [String] path - # GTM ContainerVersion's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/versions/`version_id` + # GTM ContainerVersion's API relative path. Example: accounts/`account_id`/ + # containers/`container_id`/versions/`version_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -785,13 +771,12 @@ module Google # Updates a Container Version. # @param [String] path - # GTM ContainerVersion's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/versions/`version_id` + # GTM ContainerVersion's API relative path. Example: accounts/`account_id`/ + # containers/`container_id`/versions/`version_id` # @param [Google::Apis::TagmanagerV2::ContainerVersion] container_version_object # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the - # container version in storage. + # When provided, this fingerprint must match the fingerprint of the container + # version in storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -824,8 +809,8 @@ module Google # Creates a Workspace. # @param [String] parent - # GTM parent Container's API relative path. - # Example: accounts/`account_id`/containers/`container_id` + # GTM parent Container's API relative path. Example: accounts/`account_id`/ + # containers/`container_id` # @param [Google::Apis::TagmanagerV2::Workspace] workspace_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -860,9 +845,8 @@ module Google # deletes the workspace, and sets the base container version to the newly # created version. # @param [String] path - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [Google::Apis::TagmanagerV2::CreateContainerVersionRequestVersionOptions] create_container_version_request_version_options_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -895,9 +879,8 @@ module Google # Deletes a Workspace. # @param [String] path - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -925,9 +908,8 @@ module Google # Gets a Workspace. # @param [String] path - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -957,9 +939,8 @@ module Google # Finds conflicting and modified entities in the workspace. # @param [String] path - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -989,8 +970,8 @@ module Google # Lists all Workspaces that belong to a GTM Container. # @param [String] parent - # GTM parent Container's API relative path. - # Example: accounts/`account_id`/containers/`container_id` + # GTM parent Container's API relative path. Example: accounts/`account_id`/ + # containers/`container_id` # @param [String] page_token # Continuation token for fetching the next page of results. # @param [String] fields @@ -1024,9 +1005,8 @@ module Google # Quick previews a workspace by creating a fake container version from all # entities in the provided workspace. # @param [String] path - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1057,9 +1037,8 @@ module Google # Resolves a merge conflict for a workspace entity by updating it to the # resolved entity passed in the request. # @param [String] path - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [Google::Apis::TagmanagerV2::Entity] entity_object # @param [String] fingerprint # When provided, this fingerprint must match the fingerprint of the @@ -1092,13 +1071,11 @@ module Google execute_or_queue_command(command, &block) end - # Syncs a workspace to the latest container version by updating all - # unmodified workspace entities and displaying conflicts for modified - # entities. + # Syncs a workspace to the latest container version by updating all unmodified + # workspace entities and displaying conflicts for modified entities. # @param [String] path - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1128,13 +1105,12 @@ module Google # Updates a Workspace. # @param [String] path - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [Google::Apis::TagmanagerV2::Workspace] workspace_object # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the - # workspace in storage. + # When provided, this fingerprint must match the fingerprint of the workspace in + # storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1167,9 +1143,8 @@ module Google # Creates one or more GTM Built-In Variables. # @param [String] parent - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [Array, String] type # The types of built-in variables to enable. # @param [String] fields @@ -1202,10 +1177,8 @@ module Google # Deletes one or more GTM Built-In Variables. # @param [String] path - # GTM BuiltInVariable's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # built_in_variables + # GTM BuiltInVariable's API relative path. Example: accounts/`account_id`/ + # containers/`container_id`/workspaces/`workspace_id`/built_in_variables # @param [Array, String] type # The types of built-in variables to delete. # @param [String] fields @@ -1236,9 +1209,8 @@ module Google # Lists all the enabled Built-In Variables of a GTM Container. # @param [String] parent - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [String] page_token # Continuation token for fetching the next page of results. # @param [String] fields @@ -1271,10 +1243,8 @@ module Google # Reverts changes to a GTM Built-In Variables in a GTM Workspace. # @param [String] path - # GTM BuiltInVariable's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # built_in_variables + # GTM BuiltInVariable's API relative path. Example: accounts/`account_id`/ + # containers/`container_id`/workspaces/`workspace_id`/built_in_variables # @param [String] type # The type of built-in variable to revert. # @param [String] fields @@ -1307,9 +1277,8 @@ module Google # Creates a GTM Folder. # @param [String] parent - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [Google::Apis::TagmanagerV2::Folder] folder_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1342,10 +1311,8 @@ module Google # Deletes a GTM Folder. # @param [String] path - # GTM Folder's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # folders/`folder_id` + # GTM Folder's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/folders/`folder_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1373,10 +1340,8 @@ module Google # List all entities in a GTM Folder. # @param [String] path - # GTM Folder's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # folders/`folder_id` + # GTM Folder's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/folders/`folder_id` # @param [String] page_token # Continuation token for fetching the next page of results. # @param [String] fields @@ -1409,10 +1374,8 @@ module Google # Gets a GTM Folder. # @param [String] path - # GTM Folder's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # folders/`folder_id` + # GTM Folder's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/folders/`folder_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1442,9 +1405,8 @@ module Google # Lists all GTM Folders of a Container. # @param [String] parent - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [String] page_token # Continuation token for fetching the next page of results. # @param [String] fields @@ -1477,10 +1439,8 @@ module Google # Moves entities to a GTM Folder. # @param [String] path - # GTM Folder's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # folders/`folder_id` + # GTM Folder's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/folders/`folder_id` # @param [Google::Apis::TagmanagerV2::Folder] folder_object # @param [Array, String] tag_id # The tags to be moved to the folder. @@ -1520,13 +1480,11 @@ module Google # Reverts changes to a GTM Folder in a GTM Workspace. # @param [String] path - # GTM Folder's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # folders/`folder_id` + # GTM Folder's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/folders/`folder_id` # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the tag - # in storage. + # When provided, this fingerprint must match the fingerprint of the tag in + # storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1557,10 +1515,8 @@ module Google # Updates a GTM Folder. # @param [String] path - # GTM Folder's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # folders/`folder_id` + # GTM Folder's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/folders/`folder_id` # @param [Google::Apis::TagmanagerV2::Folder] folder_object # @param [String] fingerprint # When provided, this fingerprint must match the fingerprint of the folder in @@ -1597,9 +1553,8 @@ module Google # Creates a GTM Tag. # @param [String] parent - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [Google::Apis::TagmanagerV2::Tag] tag_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1632,10 +1587,8 @@ module Google # Deletes a GTM Tag. # @param [String] path - # GTM Tag's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/tags/ - # `tag_id` + # GTM Tag's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/tags/`tag_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1663,10 +1616,8 @@ module Google # Gets a GTM Tag. # @param [String] path - # GTM Tag's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/tags/ - # `tag_id` + # GTM Tag's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/tags/`tag_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1696,9 +1647,8 @@ module Google # Lists all GTM Tags of a Container. # @param [String] parent - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [String] page_token # Continuation token for fetching the next page of results. # @param [String] fields @@ -1731,13 +1681,11 @@ module Google # Reverts changes to a GTM Tag in a GTM Workspace. # @param [String] path - # GTM Tag's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/tags/ - # `tag_id` + # GTM Tag's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/tags/`tag_id` # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of thetag - # in storage. + # When provided, this fingerprint must match the fingerprint of thetag in + # storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1768,10 +1716,8 @@ module Google # Updates a GTM Tag. # @param [String] path - # GTM Tag's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/tags/ - # `tag_id` + # GTM Tag's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/tags/`tag_id` # @param [Google::Apis::TagmanagerV2::Tag] tag_object # @param [String] fingerprint # When provided, this fingerprint must match the fingerprint of the tag in @@ -1808,9 +1754,8 @@ module Google # Creates a GTM Custom Template. # @param [String] parent - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [Google::Apis::TagmanagerV2::CustomTemplate] custom_template_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1843,10 +1788,8 @@ module Google # Deletes a GTM Template. # @param [String] path - # GTM Custom Template's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # templates/`template_id` + # GTM Custom Template's API relative path. Example: accounts/`account_id`/ + # containers/`container_id`/workspaces/`workspace_id`/templates/`template_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1874,10 +1817,8 @@ module Google # Gets a GTM Template. # @param [String] path - # GTM Custom Template's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # templates/`template_id` + # GTM Custom Template's API relative path. Example: accounts/`account_id`/ + # containers/`container_id`/workspaces/`workspace_id`/templates/`template_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1907,9 +1848,8 @@ module Google # Lists all GTM Templates of a GTM container workspace. # @param [String] parent - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [String] page_token # Continuation token for fetching the next page of results. # @param [String] fields @@ -1942,13 +1882,11 @@ module Google # Reverts changes to a GTM Template in a GTM Workspace. # @param [String] path - # GTM Custom Template's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # templates/`template_id` + # GTM Custom Template's API relative path. Example: accounts/`account_id`/ + # containers/`container_id`/workspaces/`workspace_id`/templates/`template_id` # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the template - # in storage. + # When provided, this fingerprint must match the fingerprint of the template in + # storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1979,14 +1917,12 @@ module Google # Updates a GTM Template. # @param [String] path - # GTM Custom Template's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # templates/`template_id` + # GTM Custom Template's API relative path. Example: accounts/`account_id`/ + # containers/`container_id`/workspaces/`workspace_id`/templates/`template_id` # @param [Google::Apis::TagmanagerV2::CustomTemplate] custom_template_object # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the templates - # in storage. + # When provided, this fingerprint must match the fingerprint of the templates in + # storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2019,9 +1955,8 @@ module Google # Creates a GTM Trigger. # @param [String] parent - # GTM Workspaces's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspaces's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [Google::Apis::TagmanagerV2::Trigger] trigger_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2054,10 +1989,8 @@ module Google # Deletes a GTM Trigger. # @param [String] path - # GTM Trigger's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # triggers/`trigger_id` + # GTM Trigger's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/triggers/`trigger_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2085,10 +2018,8 @@ module Google # Gets a GTM Trigger. # @param [String] path - # GTM Trigger's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # triggers/`trigger_id` + # GTM Trigger's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/triggers/`trigger_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2118,9 +2049,8 @@ module Google # Lists all GTM Triggers of a Container. # @param [String] parent - # GTM Workspaces's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspaces's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [String] page_token # Continuation token for fetching the next page of results. # @param [String] fields @@ -2153,13 +2083,11 @@ module Google # Reverts changes to a GTM Trigger in a GTM Workspace. # @param [String] path - # GTM Trigger's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # triggers/`trigger_id` + # GTM Trigger's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/triggers/`trigger_id` # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the trigger - # in storage. + # When provided, this fingerprint must match the fingerprint of the trigger in + # storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2190,14 +2118,12 @@ module Google # Updates a GTM Trigger. # @param [String] path - # GTM Trigger's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # triggers/`trigger_id` + # GTM Trigger's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/triggers/`trigger_id` # @param [Google::Apis::TagmanagerV2::Trigger] trigger_object # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the trigger - # in storage. + # When provided, this fingerprint must match the fingerprint of the trigger in + # storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2230,9 +2156,8 @@ module Google # Creates a GTM Variable. # @param [String] parent - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [Google::Apis::TagmanagerV2::Variable] variable_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2265,10 +2190,8 @@ module Google # Deletes a GTM Variable. # @param [String] path - # GTM Variable's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # variables/`variable_id` + # GTM Variable's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/variables/`variable_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2296,10 +2219,8 @@ module Google # Gets a GTM Variable. # @param [String] path - # GTM Variable's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # variables/`variable_id` + # GTM Variable's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/variables/`variable_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2329,9 +2250,8 @@ module Google # Lists all GTM Variables of a Container. # @param [String] parent - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [String] page_token # Continuation token for fetching the next page of results. # @param [String] fields @@ -2364,13 +2284,11 @@ module Google # Reverts changes to a GTM Variable in a GTM Workspace. # @param [String] path - # GTM Variable's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # variables/`variable_id` + # GTM Variable's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/variables/`variable_id` # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the variable - # in storage. + # When provided, this fingerprint must match the fingerprint of the variable in + # storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2401,14 +2319,12 @@ module Google # Updates a GTM Variable. # @param [String] path - # GTM Variable's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # variables/`variable_id` + # GTM Variable's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/variables/`variable_id` # @param [Google::Apis::TagmanagerV2::Variable] variable_object # @param [String] fingerprint - # When provided, this fingerprint must match the fingerprint of the variable - # in storage. + # When provided, this fingerprint must match the fingerprint of the variable in + # storage. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2441,9 +2357,8 @@ module Google # Creates a GTM Zone. # @param [String] parent - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [Google::Apis::TagmanagerV2::Zone] zone_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2476,10 +2391,8 @@ module Google # Deletes a GTM Zone. # @param [String] path - # GTM Zone's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # zones/`zone_id` + # GTM Zone's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/zones/`zone_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2507,10 +2420,8 @@ module Google # Gets a GTM Zone. # @param [String] path - # GTM Zone's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # zones/`zone_id` + # GTM Zone's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/zones/`zone_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2540,9 +2451,8 @@ module Google # Lists all GTM Zones of a GTM container workspace. # @param [String] parent - # GTM Workspace's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id` + # GTM Workspace's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id` # @param [String] page_token # Continuation token for fetching the next page of results. # @param [String] fields @@ -2575,10 +2485,8 @@ module Google # Reverts changes to a GTM Zone in a GTM Workspace. # @param [String] path - # GTM Zone's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # zones/`zone_id` + # GTM Zone's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/zones/`zone_id` # @param [String] fingerprint # When provided, this fingerprint must match the fingerprint of the zone in # storage. @@ -2612,10 +2520,8 @@ module Google # Updates a GTM Zone. # @param [String] path - # GTM Zone's API relative path. - # Example: - # accounts/`account_id`/containers/`container_id`/workspaces/`workspace_id`/ - # zones/`zone_id` + # GTM Zone's API relative path. Example: accounts/`account_id`/containers/` + # container_id`/workspaces/`workspace_id`/zones/`zone_id` # @param [Google::Apis::TagmanagerV2::Zone] zone_object # @param [String] fingerprint # When provided, this fingerprint must match the fingerprint of the zone in @@ -2652,8 +2558,7 @@ module Google # Creates a user's Account & Container access. # @param [String] parent - # GTM Account's API relative path. - # Example: accounts/`account_id` + # GTM Account's API relative path. Example: accounts/`account_id` # @param [Google::Apis::TagmanagerV2::UserPermission] user_permission_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -2687,8 +2592,8 @@ module Google # Removes a user from the account, revoking access to it and all of its # containers. # @param [String] path - # GTM UserPermission's API relative path. - # Example: accounts/`account_id`/user_permissions/`user_permission_id` + # GTM UserPermission's API relative path. Example: accounts/`account_id`/ + # user_permissions/`user_permission_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2716,8 +2621,8 @@ module Google # Gets a user's Account & Container access. # @param [String] path - # GTM UserPermission's API relative path. - # Example: accounts/`account_id`/user_permissions/`user_permission_id` + # GTM UserPermission's API relative path. Example: accounts/`account_id`/ + # user_permissions/`user_permission_id` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -2748,8 +2653,7 @@ module Google # List all users that have access to the account along with Account and # Container user access granted to each of them. # @param [String] parent - # GTM Accounts's API relative path. - # Example: accounts/`account_id` + # GTM Accounts's API relative path. Example: accounts/`account_id` # @param [String] page_token # Continuation token for fetching the next page of results. # @param [String] fields @@ -2782,8 +2686,8 @@ module Google # Updates a user's Account & Container access. # @param [String] path - # GTM UserPermission's API relative path. - # Example: accounts/`account_id`/user_permissions/`user_permission_id` + # GTM UserPermission's API relative path. Example: accounts/`account_id`/ + # user_permissions/`user_permission_id` # @param [Google::Apis::TagmanagerV2::UserPermission] user_permission_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/vision_v1.rb b/generated/google/apis/vision_v1.rb index 1ee2a488e..41a9cdfed 100644 --- a/generated/google/apis/vision_v1.rb +++ b/generated/google/apis/vision_v1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/vision/ module VisionV1 VERSION = 'V1' - REVISION = '20200710' + 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/vision_v1/classes.rb b/generated/google/apis/vision_v1/classes.rb index b127dd2b0..885d1789a 100644 --- a/generated/google/apis/vision_v1/classes.rb +++ b/generated/google/apis/vision_v1/classes.rb @@ -27,8 +27,7 @@ module Google include Google::Apis::Core::Hashable # Required. The resource name for the Product to be added to this ProductSet. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + # Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` # Corresponds to the JSON property `product` # @return [String] attr_accessor :product @@ -62,16 +61,13 @@ module Google # @return [Google::Apis::VisionV1::InputConfig] attr_accessor :input_config - # Pages of the file to perform image annotation. - # Pages starts from 1, we assume the first page of the file is page 1. - # At most 5 pages are supported per request. Pages can be negative. - # Page 1 means the first page. - # Page 2 means the second page. - # Page -1 means the last page. - # Page -2 means the second to the last page. - # If the file is GIF instead of PDF or TIFF, page refers to GIF frames. - # If this field is empty, by default the service performs image annotation - # for the first 5 pages of the file. + # Pages of the file to perform image annotation. Pages starts from 1, we assume + # the first page of the file is page 1. At most 5 pages are supported per + # request. Pages can be negative. Page 1 means the first page. Page 2 means the + # second page. Page -1 means the last page. Page -2 means the second to the last + # page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If + # this field is empty, by default the service performs image annotation for the + # first 5 pages of the file. # Corresponds to the JSON property `pages` # @return [Array] attr_accessor :pages @@ -94,12 +90,12 @@ module Google class AnnotateFileResponse 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::VisionV1::Status] attr_accessor :error @@ -109,8 +105,8 @@ module Google # @return [Google::Apis::VisionV1::InputConfig] attr_accessor :input_config - # Individual responses to images found within the file. This field will be - # empty if the `error` field is set. + # Individual responses to images found within the file. This field will be empty + # if the `error` field is set. # Corresponds to the JSON property `responses` # @return [Array] attr_accessor :responses @@ -180,12 +176,12 @@ module Google # @return [Google::Apis::VisionV1::CropHintsAnnotation] attr_accessor :crop_hints_annotation - # 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::VisionV1::Status] attr_accessor :error @@ -195,13 +191,12 @@ module Google # @return [Array] attr_accessor :face_annotations - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. # Corresponds to the JSON property `fullTextAnnotation` # @return [Google::Apis::VisionV1::TextAnnotation] attr_accessor :full_text_annotation @@ -221,8 +216,8 @@ module Google # @return [Array] attr_accessor :landmark_annotations - # If present, localized object detection has completed successfully. - # This will be sorted descending by confidence score. + # If present, localized object detection has completed successfully. This will + # be sorted descending by confidence score. # Corresponds to the JSON property `localizedObjectAnnotations` # @return [Array] attr_accessor :localized_object_annotations @@ -237,9 +232,8 @@ module Google # @return [Google::Apis::VisionV1::ProductSearchResults] attr_accessor :product_search_results - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). # Corresponds to the JSON property `safeSearchAnnotation` # @return [Google::Apis::VisionV1::SafeSearchAnnotation] attr_accessor :safe_search_annotation @@ -333,19 +327,15 @@ module Google end end - # Multiple async file annotation requests are batched into a single service - # call. + # Multiple async file annotation requests are batched into a single service call. class AsyncBatchAnnotateFilesRequest include Google::Apis::Core::Hashable - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -395,14 +385,11 @@ module Google # @return [Google::Apis::VisionV1::OutputConfig] attr_accessor :output_config - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -447,14 +434,11 @@ module Google class BatchAnnotateFilesRequest include Google::Apis::Core::Hashable - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -500,14 +484,11 @@ module Google class BatchAnnotateImagesRequest include Google::Apis::Core::Hashable - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -547,14 +528,14 @@ module Google end end - # Metadata for the batch operations such as the current state. - # This is included in the `metadata` field of the `Operation` returned by the - # `GetOperation` call of the `google::longrunning::Operations` service. + # Metadata for the batch operations such as the current state. This is included + # in the `metadata` field of the `Operation` returned by the `GetOperation` call + # of the `google::longrunning::Operations` service. class BatchOperationMetadata include Google::Apis::Core::Hashable - # The time when the batch request is finished and - # google.longrunning.Operation.done is set to true. + # The time when the batch request is finished and google.longrunning.Operation. + # done is set to true. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -664,122 +645,61 @@ module Google # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... class Color include Google::Apis::Core::Hashable - # The fraction of this color that should be applied to the pixel. That is, - # the final pixel color is defined by the equation: - # pixel color = alpha * (this color) + (1.0 - alpha) * (background color) - # This means that a value of 1.0 corresponds to a solid color, whereas - # a value of 0.0 corresponds to a completely transparent color. This - # uses a wrapper message rather than a simple float scalar so that it is - # possible to distinguish between a default value and the value being unset. - # If omitted, this color object is to be rendered as a solid color - # (as if the alpha value had been explicitly given with a value of 1.0). + # The fraction of this color that should be applied to the pixel. That is, the + # final pixel color is defined by the equation: pixel color = alpha * (this + # color) + (1.0 - alpha) * (background color) This means that a value of 1.0 + # corresponds to a solid color, whereas a value of 0.0 corresponds to a + # completely transparent color. This uses a wrapper message rather than a simple + # float scalar so that it is possible to distinguish between a default value and + # the value being unset. If omitted, this color object is to be rendered as a + # solid color (as if the alpha value had been explicitly given with a value of 1. + # 0). # Corresponds to the JSON property `alpha` # @return [Float] attr_accessor :alpha @@ -812,123 +732,61 @@ module Google end end - # Color information consists of RGB channels, score, and the fraction of - # the image that the color occupies in the image. + # Color information consists of RGB channels, score, and the fraction of the + # image that the color occupies in the image. class ColorInfo include Google::Apis::Core::Hashable # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... # Corresponds to the JSON property `color` # @return [Google::Apis::VisionV1::Color] attr_accessor :color - # The fraction of pixels the color occupies in the image. - # Value in range [0, 1]. + # The fraction of pixels the color occupies in the image. Value in range [0, 1]. # Corresponds to the JSON property `pixelFraction` # @return [Float] attr_accessor :pixel_fraction @@ -959,7 +817,7 @@ module Google # @return [Google::Apis::VisionV1::BoundingPoly] attr_accessor :bounding_poly - # Confidence of this being a salient region. Range [0, 1]. + # Confidence of this being a salient region. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -1005,12 +863,11 @@ module Google class CropHintsParams include Google::Apis::Core::Hashable - # Aspect ratios in floats, representing the ratio of the width to the height - # of the image. For example, if the desired aspect ratio is 4/3, the - # corresponding float value should be 1.33333. If not specified, the - # best possible crop is returned. The number of provided aspect ratios is - # limited to a maximum of 16; any aspect ratios provided after the 16th are - # ignored. + # Aspect ratios in floats, representing the ratio of the width to the height of + # the image. For example, if the desired aspect ratio is 4/3, the corresponding + # float value should be 1.33333. If not specified, the best possible crop is + # returned. The number of provided aspect ratios is limited to a maximum of 16; + # any aspect ratios provided after the 16th are ignored. # Corresponds to the JSON property `aspectRatios` # @return [Array] attr_accessor :aspect_ratios @@ -1060,9 +917,8 @@ module Google # @return [Float] attr_accessor :confidence - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -1097,13 +953,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 @@ -1125,11 +979,10 @@ module Google # @return [Google::Apis::VisionV1::BoundingPoly] attr_accessor :bounding_poly - # **Deprecated. Use `score` instead.** - # The accuracy of the entity detection in an image. - # For example, for an image in which the "Eiffel Tower" entity is detected, - # this field represents the confidence that there is a tower in the query - # image. Range [0, 1]. + # **Deprecated. Use `score` instead.** The accuracy of the entity detection in + # an image. For example, for an image in which the "Eiffel Tower" entity is + # detected, this field represents the confidence that there is a tower in the + # query image. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -1139,30 +992,29 @@ module Google # @return [String] attr_accessor :description - # The language code for the locale in which the entity textual - # `description` is expressed. + # The language code for the locale in which the entity textual `description` is + # expressed. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale - # The location information for the detected entity. Multiple - # `LocationInfo` elements can be present because one location may - # indicate the location of the scene in the image, and another location - # may indicate the location of the place where the image was taken. - # Location information is usually present for landmarks. + # The location information for the detected entity. Multiple `LocationInfo` + # elements can be present because one location may indicate the location of the + # scene in the image, and another location may indicate the location of the + # place where the image was taken. Location information is usually present for + # landmarks. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `mid` # @return [String] attr_accessor :mid - # Some entities may have optional user-supplied `Property` (name/value) - # fields, such a score or string that qualifies the entity. + # Some entities may have optional user-supplied `Property` (name/value) fields, + # such a score or string that qualifies the entity. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -1172,11 +1024,11 @@ module Google # @return [Float] attr_accessor :score - # The relevancy of the ICA (Image Content Annotation) label to the - # image. For example, the relevancy of "tower" is likely higher to an image - # containing the detected "Eiffel Tower" than to an image containing a - # detected distant towering building, even though the confidence that - # there is a tower in each image may be the same. Range [0, 1]. + # The relevancy of the ICA (Image Content Annotation) label to the image. For + # example, the relevancy of "tower" is likely higher to an image containing the + # detected "Eiffel Tower" than to an image containing a detected distant + # towering building, even though the confidence that there is a tower in each + # image may be the same. Range [0, 1]. # Corresponds to the JSON property `topicality` # @return [Float] attr_accessor :topicality @@ -1249,15 +1101,15 @@ module Google attr_accessor :landmarks # Yaw angle, which indicates the leftward/rightward angle that the face is - # pointing relative to the vertical plane perpendicular to the image. Range - # [-180,180]. + # pointing relative to the vertical plane perpendicular to the image. Range [- + # 180,180]. # Corresponds to the JSON property `panAngle` # @return [Float] attr_accessor :pan_angle - # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation - # of the face relative to the image vertical about the axis perpendicular to - # the face. Range [-180,180]. + # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of + # the face relative to the image vertical about the axis perpendicular to the + # face. Range [-180,180]. # Corresponds to the JSON property `rollAngle` # @return [Float] attr_accessor :roll_angle @@ -1308,20 +1160,19 @@ module Google end # The type of Google Cloud Vision API detection to perform, and the maximum - # number of results to return for that type. Multiple `Feature` objects can - # be specified in the `features` list. + # number of results to return for that type. Multiple `Feature` objects can be + # specified in the `features` list. class Feature include Google::Apis::Core::Hashable - # Maximum number of results of this type. Does not apply to - # `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. + # Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, ` + # DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. # Corresponds to the JSON property `maxResults` # @return [Fixnum] attr_accessor :max_results - # Model to use for the feature. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for the feature. Supported values: "builtin/stable" (the default + # if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -1347,24 +1198,20 @@ module Google class GcsDestination include Google::Apis::Core::Hashable - # Google Cloud Storage URI prefix where the results will be stored. Results - # will be in JSON format and preceded by its corresponding input URI prefix. - # This field can either represent a gcs file prefix or gcs directory. In - # either case, the uri should be unique because in order to get all of the - # output files, you will need to do a wildcard gcs search on the uri prefix - # you provide. - # Examples: - # * File Prefix: gs://bucket-name/here/filenameprefix The output files - # will be created in gs://bucket-name/here/ and the names of the - # output files will begin with "filenameprefix". - # * Directory Prefix: gs://bucket-name/some/location/ The output files - # will be created in gs://bucket-name/some/location/ and the names of the - # output files could be anything because there was no filename prefix - # specified. - # If multiple outputs, each response is still AnnotateFileResponse, each of - # which contains some subset of the full list of AnnotateImageResponse. - # Multiple outputs can happen if, for example, the output JSON is too large - # and overflows into multiple sharded files. + # Google Cloud Storage URI prefix where the results will be stored. Results will + # be in JSON format and preceded by its corresponding input URI prefix. This + # field can either represent a gcs file prefix or gcs directory. In either case, + # the uri should be unique because in order to get all of the output files, you + # will need to do a wildcard gcs search on the uri prefix you provide. Examples: + # * File Prefix: gs://bucket-name/here/filenameprefix The output files will be + # created in gs://bucket-name/here/ and the names of the output files will begin + # with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The + # output files will be created in gs://bucket-name/some/location/ and the names + # of the output files could be anything because there was no filename prefix + # specified. If multiple outputs, each response is still AnnotateFileResponse, + # each of which contains some subset of the full list of AnnotateImageResponse. + # Multiple outputs can happen if, for example, the output JSON is too large and + # overflows into multiple sharded files. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -1383,8 +1230,8 @@ module Google class GcsSource include Google::Apis::Core::Hashable - # Google Cloud Storage URI for the input file. This must only be a - # Google Cloud Storage object. Wildcards are not currently supported. + # Google Cloud Storage URI for the input file. This must only be a Google Cloud + # Storage object. Wildcards are not currently supported. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -1404,12 +1251,12 @@ module Google class GoogleCloudVisionV1p1beta1AnnotateFileResponse 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::VisionV1::Status] attr_accessor :error @@ -1419,8 +1266,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1InputConfig] attr_accessor :input_config - # Individual responses to images found within the file. This field will be - # empty if the `error` field is set. + # Individual responses to images found within the file. This field will be empty + # if the `error` field is set. # Corresponds to the JSON property `responses` # @return [Array] attr_accessor :responses @@ -1458,12 +1305,12 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1CropHintsAnnotation] attr_accessor :crop_hints_annotation - # 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::VisionV1::Status] attr_accessor :error @@ -1473,13 +1320,12 @@ module Google # @return [Array] attr_accessor :face_annotations - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. # Corresponds to the JSON property `fullTextAnnotation` # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1TextAnnotation] attr_accessor :full_text_annotation @@ -1499,8 +1345,8 @@ module Google # @return [Array] attr_accessor :landmark_annotations - # If present, localized object detection has completed successfully. - # This will be sorted descending by confidence score. + # If present, localized object detection has completed successfully. This will + # be sorted descending by confidence score. # Corresponds to the JSON property `localizedObjectAnnotations` # @return [Array] attr_accessor :localized_object_annotations @@ -1515,9 +1361,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1ProductSearchResults] attr_accessor :product_search_results - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). # Corresponds to the JSON property `safeSearchAnnotation` # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1SafeSearchAnnotation] attr_accessor :safe_search_annotation @@ -1662,123 +1507,61 @@ module Google end end - # Color information consists of RGB channels, score, and the fraction of - # the image that the color occupies in the image. + # Color information consists of RGB channels, score, and the fraction of the + # image that the color occupies in the image. class GoogleCloudVisionV1p1beta1ColorInfo include Google::Apis::Core::Hashable # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... # Corresponds to the JSON property `color` # @return [Google::Apis::VisionV1::Color] attr_accessor :color - # The fraction of pixels the color occupies in the image. - # Value in range [0, 1]. + # The fraction of pixels the color occupies in the image. Value in range [0, 1]. # Corresponds to the JSON property `pixelFraction` # @return [Float] attr_accessor :pixel_fraction @@ -1809,7 +1592,7 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1BoundingPoly] attr_accessor :bounding_poly - # Confidence of this being a salient region. Range [0, 1]. + # Confidence of this being a salient region. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -1879,11 +1662,10 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1BoundingPoly] attr_accessor :bounding_poly - # **Deprecated. Use `score` instead.** - # The accuracy of the entity detection in an image. - # For example, for an image in which the "Eiffel Tower" entity is detected, - # this field represents the confidence that there is a tower in the query - # image. Range [0, 1]. + # **Deprecated. Use `score` instead.** The accuracy of the entity detection in + # an image. For example, for an image in which the "Eiffel Tower" entity is + # detected, this field represents the confidence that there is a tower in the + # query image. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -1893,30 +1675,29 @@ module Google # @return [String] attr_accessor :description - # The language code for the locale in which the entity textual - # `description` is expressed. + # The language code for the locale in which the entity textual `description` is + # expressed. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale - # The location information for the detected entity. Multiple - # `LocationInfo` elements can be present because one location may - # indicate the location of the scene in the image, and another location - # may indicate the location of the place where the image was taken. - # Location information is usually present for landmarks. + # The location information for the detected entity. Multiple `LocationInfo` + # elements can be present because one location may indicate the location of the + # scene in the image, and another location may indicate the location of the + # place where the image was taken. Location information is usually present for + # landmarks. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `mid` # @return [String] attr_accessor :mid - # Some entities may have optional user-supplied `Property` (name/value) - # fields, such a score or string that qualifies the entity. + # Some entities may have optional user-supplied `Property` (name/value) fields, + # such a score or string that qualifies the entity. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -1926,11 +1707,11 @@ module Google # @return [Float] attr_accessor :score - # The relevancy of the ICA (Image Content Annotation) label to the - # image. For example, the relevancy of "tower" is likely higher to an image - # containing the detected "Eiffel Tower" than to an image containing a - # detected distant towering building, even though the confidence that - # there is a tower in each image may be the same. Range [0, 1]. + # The relevancy of the ICA (Image Content Annotation) label to the image. For + # example, the relevancy of "tower" is likely higher to an image containing the + # detected "Eiffel Tower" than to an image containing a detected distant + # towering building, even though the confidence that there is a tower in each + # image may be the same. Range [0, 1]. # Corresponds to the JSON property `topicality` # @return [Float] attr_accessor :topicality @@ -2003,15 +1784,15 @@ module Google attr_accessor :landmarks # Yaw angle, which indicates the leftward/rightward angle that the face is - # pointing relative to the vertical plane perpendicular to the image. Range - # [-180,180]. + # pointing relative to the vertical plane perpendicular to the image. Range [- + # 180,180]. # Corresponds to the JSON property `panAngle` # @return [Float] attr_accessor :pan_angle - # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation - # of the face relative to the image vertical about the axis perpendicular to - # the face. Range [-180,180]. + # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of + # the face relative to the image vertical about the axis perpendicular to the + # face. Range [-180,180]. # Corresponds to the JSON property `rollAngle` # @return [Float] attr_accessor :roll_angle @@ -2065,9 +1846,9 @@ module Google class GoogleCloudVisionV1p1beta1FaceAnnotationLandmark include Google::Apis::Core::Hashable - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. # Corresponds to the JSON property `position` # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1Position] attr_accessor :position @@ -2092,24 +1873,20 @@ module Google class GoogleCloudVisionV1p1beta1GcsDestination include Google::Apis::Core::Hashable - # Google Cloud Storage URI prefix where the results will be stored. Results - # will be in JSON format and preceded by its corresponding input URI prefix. - # This field can either represent a gcs file prefix or gcs directory. In - # either case, the uri should be unique because in order to get all of the - # output files, you will need to do a wildcard gcs search on the uri prefix - # you provide. - # Examples: - # * File Prefix: gs://bucket-name/here/filenameprefix The output files - # will be created in gs://bucket-name/here/ and the names of the - # output files will begin with "filenameprefix". - # * Directory Prefix: gs://bucket-name/some/location/ The output files - # will be created in gs://bucket-name/some/location/ and the names of the - # output files could be anything because there was no filename prefix - # specified. - # If multiple outputs, each response is still AnnotateFileResponse, each of - # which contains some subset of the full list of AnnotateImageResponse. - # Multiple outputs can happen if, for example, the output JSON is too large - # and overflows into multiple sharded files. + # Google Cloud Storage URI prefix where the results will be stored. Results will + # be in JSON format and preceded by its corresponding input URI prefix. This + # field can either represent a gcs file prefix or gcs directory. In either case, + # the uri should be unique because in order to get all of the output files, you + # will need to do a wildcard gcs search on the uri prefix you provide. Examples: + # * File Prefix: gs://bucket-name/here/filenameprefix The output files will be + # created in gs://bucket-name/here/ and the names of the output files will begin + # with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The + # output files will be created in gs://bucket-name/some/location/ and the names + # of the output files could be anything because there was no filename prefix + # specified. If multiple outputs, each response is still AnnotateFileResponse, + # each of which contains some subset of the full list of AnnotateImageResponse. + # Multiple outputs can happen if, for example, the output JSON is too large and + # overflows into multiple sharded files. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -2128,8 +1905,8 @@ module Google class GoogleCloudVisionV1p1beta1GcsSource include Google::Apis::Core::Hashable - # Google Cloud Storage URI for the input file. This must only be a - # Google Cloud Storage object. Wildcards are not currently supported. + # Google Cloud Storage URI for the input file. This must only be a Google Cloud + # Storage object. Wildcards are not currently supported. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -2149,8 +1926,8 @@ module Google class GoogleCloudVisionV1p1beta1ImageAnnotationContext include Google::Apis::Core::Hashable - # If the file was a PDF or TIFF, this field gives the page number within - # the file used to produce the image. + # If the file was a PDF or TIFF, this field gives the page number within the + # file used to produce the image. # Corresponds to the JSON property `pageNumber` # @return [Fixnum] attr_accessor :page_number @@ -2194,11 +1971,11 @@ module Google class GoogleCloudVisionV1p1beta1InputConfig include Google::Apis::Core::Hashable - # File content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateFiles requests. It does - # not work for AsyncBatchAnnotateFiles requests. + # File content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -2209,8 +1986,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1GcsSource] attr_accessor :gcs_source - # The type of the file. Currently only "application/pdf", "image/tiff" and - # "image/gif" are supported. Wildcards are not supported. + # The type of the file. Currently only "application/pdf", "image/tiff" and " + # image/gif" are supported. Wildcards are not supported. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -2236,9 +2013,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1BoundingPoly] attr_accessor :bounding_poly - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -2278,9 +2054,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::VisionV1::LatLng] attr_accessor :lat_lng @@ -2295,9 +2070,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVisionV1p1beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -2357,13 +2131,11 @@ module Google class GoogleCloudVisionV1p1beta1OutputConfig include Google::Apis::Core::Hashable - # The max number of response protos to put into each output JSON file on - # Google Cloud Storage. - # The valid range is [1, 100]. If not specified, the default value is 20. - # For example, for one pdf file with 100 pages, 100 response protos will - # be generated. If `batch_size` = 20, then 5 json files each - # containing 20 response protos will be written under the prefix - # `gcs_destination`.`uri`. + # The max number of response protos to put into each output JSON file on Google + # Cloud Storage. The valid range is [1, 100]. If not specified, the default + # value is 20. For example, for one pdf file with 100 pages, 100 response protos + # will be generated. If `batch_size` = 20, then 5 json files each containing 20 + # response protos will be written under the prefix `gcs_destination`.`uri`. # Currently, batch_size only applies to GcsDestination, with potential future # support for other output configurations. # Corresponds to the JSON property `batchSize` @@ -2400,8 +2172,8 @@ module Google # @return [Float] attr_accessor :confidence - # Page height. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page height. For PDFs the unit is points. For images (including TIFFs) the + # unit is pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -2411,8 +2183,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty] attr_accessor :property - # Page width. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page width. For PDFs the unit is points. For images (including TIFFs) the unit + # is pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -2468,9 +2240,9 @@ module Google end end - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. class GoogleCloudVisionV1p1beta1Position include Google::Apis::Core::Hashable @@ -2517,33 +2289,28 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the product. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - # This field is ignored when creating a product. + # The resource name of the product. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Immutable. The category for the product identified by the reference image. - # This should - # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories - # "homegoods", "apparel", and "toys" are still supported, but these should - # not be used for new products. + # This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods- + # v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" + # are still supported, but these should not be used for new products. # Corresponds to the JSON property `productCategory` # @return [String] attr_accessor :product_category - # Key-value pairs that can be attached to a product. At query time, - # constraints can be specified based on the product_labels. - # Note that integer values can be provided as strings, e.g. "1199". Only - # strings with integer values can match a range-based restriction which is - # to be supported soon. - # Multiple values can be assigned to the same key. One product may have up to - # 500 product_labels. - # Notice that the total number of distinct product_labels over all products - # in one ProductSet cannot exceed 1M, otherwise the product search pipeline - # will refuse to work for that ProductSet. + # Key-value pairs that can be attached to a product. At query time, constraints + # can be specified based on the product_labels. Note that integer values can be + # provided as strings, e.g. "1199". Only strings with integer values can match a + # range-based restriction which is to be supported soon. Multiple values can be + # assigned to the same key. One product may have up to 500 product_labels. + # Notice that the total number of distinct product_labels over all products in + # one ProductSet cannot exceed 1M, otherwise the product search pipeline will + # refuse to work for that ProductSet. # Corresponds to the JSON property `productLabels` # @return [Array] attr_accessor :product_labels @@ -2572,8 +2339,8 @@ module Google # @return [String] attr_accessor :key - # The value of the label attached to the product. Cannot be empty and - # cannot exceed 128 bytes. + # The value of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -2594,8 +2361,8 @@ module Google include Google::Apis::Core::Hashable # Timestamp of the index which provided these results. Products added to the - # product set and products removed from the product set after this time are - # not reflected in the current results. + # product set and products removed from the product set after this time are not + # reflected in the current results. # Corresponds to the JSON property `indexTime` # @return [String] attr_accessor :index_time @@ -2625,8 +2392,7 @@ module Google end end - # Information about the products similar to a single product in a query - # image. + # Information about the products similar to a single product in a query image. class GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult include Google::Apis::Core::Hashable @@ -2661,9 +2427,8 @@ module Google class GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation include Google::Apis::Core::Hashable - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -2700,8 +2465,8 @@ module Google class GoogleCloudVisionV1p1beta1ProductSearchResultsResult include Google::Apis::Core::Hashable - # The resource name of the image from the product that is the closest match - # to the query. + # The resource name of the image from the product that is the closest match to + # the query. # Corresponds to the JSON property `image` # @return [String] attr_accessor :image @@ -2711,8 +2476,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1Product] attr_accessor :product - # A confidence level on the match, ranging from 0 (no confidence) to - # 1 (full confidence). + # A confidence level on the match, ranging from 0 (no confidence) to 1 (full + # confidence). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -2760,15 +2525,14 @@ module Google end end - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). class GoogleCloudVisionV1p1beta1SafeSearchAnnotation include Google::Apis::Core::Hashable # Represents the adult content likelihood for the image. Adult content may - # contain elements such as nudity, pornographic images or cartoons, or - # sexual activities. + # contain elements such as nudity, pornographic images or cartoons, or sexual + # activities. # Corresponds to the JSON property `adult` # @return [String] attr_accessor :adult @@ -2780,15 +2544,14 @@ module Google # Likelihood that the request image contains racy content. Racy content may # include (but is not limited to) skimpy or sheer clothing, strategically - # covered nudity, lewd or provocative poses, or close-ups of sensitive - # body areas. + # covered nudity, lewd or provocative poses, or close-ups of sensitive body + # areas. # Corresponds to the JSON property `racy` # @return [String] attr_accessor :racy - # Spoof likelihood. The likelihood that an modification - # was made to the image's canonical version to make it appear - # funny or offensive. + # Spoof likelihood. The likelihood that an modification was made to the image's + # canonical version to make it appear funny or offensive. # Corresponds to the JSON property `spoof` # @return [String] attr_accessor :spoof @@ -2849,13 +2612,12 @@ module Google end end - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. class GoogleCloudVisionV1p1beta1TextAnnotation include Google::Apis::Core::Hashable @@ -2915,9 +2677,8 @@ module Google # @return [Float] attr_accessor :confidence - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -2958,8 +2719,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the vertex coordinates are in the same scale as the original image. + # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are + # in the same scale as the original image. class GoogleCloudVisionV1p1beta1Vertex include Google::Apis::Core::Hashable @@ -2988,14 +2749,14 @@ module Google class GoogleCloudVisionV1p1beta1WebDetection include Google::Apis::Core::Hashable - # The service's best guess as to the topic of the request image. - # Inferred from similar images on the open web. + # The service's best guess as to the topic of the request image. Inferred from + # similar images on the open web. # Corresponds to the JSON property `bestGuessLabels` # @return [Array] attr_accessor :best_guess_labels - # Fully matching images from the Internet. - # Can include resized copies of the query image. + # Fully matching images from the Internet. Can include resized copies of the + # query image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -3005,9 +2766,9 @@ module Google # @return [Array] attr_accessor :pages_with_matching_images - # Partial matching images from the Internet. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its crops. + # Partial matching images from the Internet. Those images are similar enough to + # share some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -3051,8 +2812,8 @@ module Google # @return [String] attr_accessor :entity_id - # Overall relevancy score for the entity. - # Not normalized and not comparable across different image queries. + # Overall relevancy score for the entity. Not normalized and not comparable + # across different image queries. # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -3103,9 +2864,9 @@ module Google # @return [String] attr_accessor :label - # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - # For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more + # information, see http://www.unicode.org/reports/tr35/# + # Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -3125,8 +2886,8 @@ module Google class GoogleCloudVisionV1p1beta1WebDetectionWebPage include Google::Apis::Core::Hashable - # Fully matching images on the page. - # Can include resized copies of the query image. + # Fully matching images on the page. Can include resized copies of the query + # image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -3136,10 +2897,9 @@ module Google # @return [String] attr_accessor :page_title - # Partial matching images on the page. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its - # crops. + # Partial matching images on the page. Those images are similar enough to share + # some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -3187,8 +2947,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty] attr_accessor :property - # List of symbols in the word. - # The order of the symbols follows the natural reading order. + # List of symbols in the word. The order of the symbols follows the natural + # reading order. # Corresponds to the JSON property `symbols` # @return [Array] attr_accessor :symbols @@ -3211,12 +2971,12 @@ module Google class GoogleCloudVisionV1p2beta1AnnotateFileResponse 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::VisionV1::Status] attr_accessor :error @@ -3226,8 +2986,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1InputConfig] attr_accessor :input_config - # Individual responses to images found within the file. This field will be - # empty if the `error` field is set. + # Individual responses to images found within the file. This field will be empty + # if the `error` field is set. # Corresponds to the JSON property `responses` # @return [Array] attr_accessor :responses @@ -3265,12 +3025,12 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1CropHintsAnnotation] attr_accessor :crop_hints_annotation - # 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::VisionV1::Status] attr_accessor :error @@ -3280,13 +3040,12 @@ module Google # @return [Array] attr_accessor :face_annotations - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. # Corresponds to the JSON property `fullTextAnnotation` # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1TextAnnotation] attr_accessor :full_text_annotation @@ -3306,8 +3065,8 @@ module Google # @return [Array] attr_accessor :landmark_annotations - # If present, localized object detection has completed successfully. - # This will be sorted descending by confidence score. + # If present, localized object detection has completed successfully. This will + # be sorted descending by confidence score. # Corresponds to the JSON property `localizedObjectAnnotations` # @return [Array] attr_accessor :localized_object_annotations @@ -3322,9 +3081,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1ProductSearchResults] attr_accessor :product_search_results - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). # Corresponds to the JSON property `safeSearchAnnotation` # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1SafeSearchAnnotation] attr_accessor :safe_search_annotation @@ -3469,123 +3227,61 @@ module Google end end - # Color information consists of RGB channels, score, and the fraction of - # the image that the color occupies in the image. + # Color information consists of RGB channels, score, and the fraction of the + # image that the color occupies in the image. class GoogleCloudVisionV1p2beta1ColorInfo include Google::Apis::Core::Hashable # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... # Corresponds to the JSON property `color` # @return [Google::Apis::VisionV1::Color] attr_accessor :color - # The fraction of pixels the color occupies in the image. - # Value in range [0, 1]. + # The fraction of pixels the color occupies in the image. Value in range [0, 1]. # Corresponds to the JSON property `pixelFraction` # @return [Float] attr_accessor :pixel_fraction @@ -3616,7 +3312,7 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1BoundingPoly] attr_accessor :bounding_poly - # Confidence of this being a salient region. Range [0, 1]. + # Confidence of this being a salient region. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -3686,11 +3382,10 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1BoundingPoly] attr_accessor :bounding_poly - # **Deprecated. Use `score` instead.** - # The accuracy of the entity detection in an image. - # For example, for an image in which the "Eiffel Tower" entity is detected, - # this field represents the confidence that there is a tower in the query - # image. Range [0, 1]. + # **Deprecated. Use `score` instead.** The accuracy of the entity detection in + # an image. For example, for an image in which the "Eiffel Tower" entity is + # detected, this field represents the confidence that there is a tower in the + # query image. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -3700,30 +3395,29 @@ module Google # @return [String] attr_accessor :description - # The language code for the locale in which the entity textual - # `description` is expressed. + # The language code for the locale in which the entity textual `description` is + # expressed. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale - # The location information for the detected entity. Multiple - # `LocationInfo` elements can be present because one location may - # indicate the location of the scene in the image, and another location - # may indicate the location of the place where the image was taken. - # Location information is usually present for landmarks. + # The location information for the detected entity. Multiple `LocationInfo` + # elements can be present because one location may indicate the location of the + # scene in the image, and another location may indicate the location of the + # place where the image was taken. Location information is usually present for + # landmarks. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `mid` # @return [String] attr_accessor :mid - # Some entities may have optional user-supplied `Property` (name/value) - # fields, such a score or string that qualifies the entity. + # Some entities may have optional user-supplied `Property` (name/value) fields, + # such a score or string that qualifies the entity. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -3733,11 +3427,11 @@ module Google # @return [Float] attr_accessor :score - # The relevancy of the ICA (Image Content Annotation) label to the - # image. For example, the relevancy of "tower" is likely higher to an image - # containing the detected "Eiffel Tower" than to an image containing a - # detected distant towering building, even though the confidence that - # there is a tower in each image may be the same. Range [0, 1]. + # The relevancy of the ICA (Image Content Annotation) label to the image. For + # example, the relevancy of "tower" is likely higher to an image containing the + # detected "Eiffel Tower" than to an image containing a detected distant + # towering building, even though the confidence that there is a tower in each + # image may be the same. Range [0, 1]. # Corresponds to the JSON property `topicality` # @return [Float] attr_accessor :topicality @@ -3810,15 +3504,15 @@ module Google attr_accessor :landmarks # Yaw angle, which indicates the leftward/rightward angle that the face is - # pointing relative to the vertical plane perpendicular to the image. Range - # [-180,180]. + # pointing relative to the vertical plane perpendicular to the image. Range [- + # 180,180]. # Corresponds to the JSON property `panAngle` # @return [Float] attr_accessor :pan_angle - # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation - # of the face relative to the image vertical about the axis perpendicular to - # the face. Range [-180,180]. + # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of + # the face relative to the image vertical about the axis perpendicular to the + # face. Range [-180,180]. # Corresponds to the JSON property `rollAngle` # @return [Float] attr_accessor :roll_angle @@ -3872,9 +3566,9 @@ module Google class GoogleCloudVisionV1p2beta1FaceAnnotationLandmark include Google::Apis::Core::Hashable - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. # Corresponds to the JSON property `position` # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1Position] attr_accessor :position @@ -3899,24 +3593,20 @@ module Google class GoogleCloudVisionV1p2beta1GcsDestination include Google::Apis::Core::Hashable - # Google Cloud Storage URI prefix where the results will be stored. Results - # will be in JSON format and preceded by its corresponding input URI prefix. - # This field can either represent a gcs file prefix or gcs directory. In - # either case, the uri should be unique because in order to get all of the - # output files, you will need to do a wildcard gcs search on the uri prefix - # you provide. - # Examples: - # * File Prefix: gs://bucket-name/here/filenameprefix The output files - # will be created in gs://bucket-name/here/ and the names of the - # output files will begin with "filenameprefix". - # * Directory Prefix: gs://bucket-name/some/location/ The output files - # will be created in gs://bucket-name/some/location/ and the names of the - # output files could be anything because there was no filename prefix - # specified. - # If multiple outputs, each response is still AnnotateFileResponse, each of - # which contains some subset of the full list of AnnotateImageResponse. - # Multiple outputs can happen if, for example, the output JSON is too large - # and overflows into multiple sharded files. + # Google Cloud Storage URI prefix where the results will be stored. Results will + # be in JSON format and preceded by its corresponding input URI prefix. This + # field can either represent a gcs file prefix or gcs directory. In either case, + # the uri should be unique because in order to get all of the output files, you + # will need to do a wildcard gcs search on the uri prefix you provide. Examples: + # * File Prefix: gs://bucket-name/here/filenameprefix The output files will be + # created in gs://bucket-name/here/ and the names of the output files will begin + # with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The + # output files will be created in gs://bucket-name/some/location/ and the names + # of the output files could be anything because there was no filename prefix + # specified. If multiple outputs, each response is still AnnotateFileResponse, + # each of which contains some subset of the full list of AnnotateImageResponse. + # Multiple outputs can happen if, for example, the output JSON is too large and + # overflows into multiple sharded files. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -3935,8 +3625,8 @@ module Google class GoogleCloudVisionV1p2beta1GcsSource include Google::Apis::Core::Hashable - # Google Cloud Storage URI for the input file. This must only be a - # Google Cloud Storage object. Wildcards are not currently supported. + # Google Cloud Storage URI for the input file. This must only be a Google Cloud + # Storage object. Wildcards are not currently supported. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -3956,8 +3646,8 @@ module Google class GoogleCloudVisionV1p2beta1ImageAnnotationContext include Google::Apis::Core::Hashable - # If the file was a PDF or TIFF, this field gives the page number within - # the file used to produce the image. + # If the file was a PDF or TIFF, this field gives the page number within the + # file used to produce the image. # Corresponds to the JSON property `pageNumber` # @return [Fixnum] attr_accessor :page_number @@ -4001,11 +3691,11 @@ module Google class GoogleCloudVisionV1p2beta1InputConfig include Google::Apis::Core::Hashable - # File content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateFiles requests. It does - # not work for AsyncBatchAnnotateFiles requests. + # File content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -4016,8 +3706,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1GcsSource] attr_accessor :gcs_source - # The type of the file. Currently only "application/pdf", "image/tiff" and - # "image/gif" are supported. Wildcards are not supported. + # The type of the file. Currently only "application/pdf", "image/tiff" and " + # image/gif" are supported. Wildcards are not supported. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -4043,9 +3733,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1BoundingPoly] attr_accessor :bounding_poly - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -4085,9 +3774,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::VisionV1::LatLng] attr_accessor :lat_lng @@ -4102,9 +3790,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVisionV1p2beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -4164,13 +3851,11 @@ module Google class GoogleCloudVisionV1p2beta1OutputConfig include Google::Apis::Core::Hashable - # The max number of response protos to put into each output JSON file on - # Google Cloud Storage. - # The valid range is [1, 100]. If not specified, the default value is 20. - # For example, for one pdf file with 100 pages, 100 response protos will - # be generated. If `batch_size` = 20, then 5 json files each - # containing 20 response protos will be written under the prefix - # `gcs_destination`.`uri`. + # The max number of response protos to put into each output JSON file on Google + # Cloud Storage. The valid range is [1, 100]. If not specified, the default + # value is 20. For example, for one pdf file with 100 pages, 100 response protos + # will be generated. If `batch_size` = 20, then 5 json files each containing 20 + # response protos will be written under the prefix `gcs_destination`.`uri`. # Currently, batch_size only applies to GcsDestination, with potential future # support for other output configurations. # Corresponds to the JSON property `batchSize` @@ -4207,8 +3892,8 @@ module Google # @return [Float] attr_accessor :confidence - # Page height. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page height. For PDFs the unit is points. For images (including TIFFs) the + # unit is pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -4218,8 +3903,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1TextAnnotationTextProperty] attr_accessor :property - # Page width. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page width. For PDFs the unit is points. For images (including TIFFs) the unit + # is pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -4275,9 +3960,9 @@ module Google end end - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. class GoogleCloudVisionV1p2beta1Position include Google::Apis::Core::Hashable @@ -4324,33 +4009,28 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the product. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - # This field is ignored when creating a product. + # The resource name of the product. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Immutable. The category for the product identified by the reference image. - # This should - # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories - # "homegoods", "apparel", and "toys" are still supported, but these should - # not be used for new products. + # This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods- + # v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" + # are still supported, but these should not be used for new products. # Corresponds to the JSON property `productCategory` # @return [String] attr_accessor :product_category - # Key-value pairs that can be attached to a product. At query time, - # constraints can be specified based on the product_labels. - # Note that integer values can be provided as strings, e.g. "1199". Only - # strings with integer values can match a range-based restriction which is - # to be supported soon. - # Multiple values can be assigned to the same key. One product may have up to - # 500 product_labels. - # Notice that the total number of distinct product_labels over all products - # in one ProductSet cannot exceed 1M, otherwise the product search pipeline - # will refuse to work for that ProductSet. + # Key-value pairs that can be attached to a product. At query time, constraints + # can be specified based on the product_labels. Note that integer values can be + # provided as strings, e.g. "1199". Only strings with integer values can match a + # range-based restriction which is to be supported soon. Multiple values can be + # assigned to the same key. One product may have up to 500 product_labels. + # Notice that the total number of distinct product_labels over all products in + # one ProductSet cannot exceed 1M, otherwise the product search pipeline will + # refuse to work for that ProductSet. # Corresponds to the JSON property `productLabels` # @return [Array] attr_accessor :product_labels @@ -4379,8 +4059,8 @@ module Google # @return [String] attr_accessor :key - # The value of the label attached to the product. Cannot be empty and - # cannot exceed 128 bytes. + # The value of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -4401,8 +4081,8 @@ module Google include Google::Apis::Core::Hashable # Timestamp of the index which provided these results. Products added to the - # product set and products removed from the product set after this time are - # not reflected in the current results. + # product set and products removed from the product set after this time are not + # reflected in the current results. # Corresponds to the JSON property `indexTime` # @return [String] attr_accessor :index_time @@ -4432,8 +4112,7 @@ module Google end end - # Information about the products similar to a single product in a query - # image. + # Information about the products similar to a single product in a query image. class GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult include Google::Apis::Core::Hashable @@ -4468,9 +4147,8 @@ module Google class GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation include Google::Apis::Core::Hashable - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -4507,8 +4185,8 @@ module Google class GoogleCloudVisionV1p2beta1ProductSearchResultsResult include Google::Apis::Core::Hashable - # The resource name of the image from the product that is the closest match - # to the query. + # The resource name of the image from the product that is the closest match to + # the query. # Corresponds to the JSON property `image` # @return [String] attr_accessor :image @@ -4518,8 +4196,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1Product] attr_accessor :product - # A confidence level on the match, ranging from 0 (no confidence) to - # 1 (full confidence). + # A confidence level on the match, ranging from 0 (no confidence) to 1 (full + # confidence). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -4567,15 +4245,14 @@ module Google end end - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). class GoogleCloudVisionV1p2beta1SafeSearchAnnotation include Google::Apis::Core::Hashable # Represents the adult content likelihood for the image. Adult content may - # contain elements such as nudity, pornographic images or cartoons, or - # sexual activities. + # contain elements such as nudity, pornographic images or cartoons, or sexual + # activities. # Corresponds to the JSON property `adult` # @return [String] attr_accessor :adult @@ -4587,15 +4264,14 @@ module Google # Likelihood that the request image contains racy content. Racy content may # include (but is not limited to) skimpy or sheer clothing, strategically - # covered nudity, lewd or provocative poses, or close-ups of sensitive - # body areas. + # covered nudity, lewd or provocative poses, or close-ups of sensitive body + # areas. # Corresponds to the JSON property `racy` # @return [String] attr_accessor :racy - # Spoof likelihood. The likelihood that an modification - # was made to the image's canonical version to make it appear - # funny or offensive. + # Spoof likelihood. The likelihood that an modification was made to the image's + # canonical version to make it appear funny or offensive. # Corresponds to the JSON property `spoof` # @return [String] attr_accessor :spoof @@ -4656,13 +4332,12 @@ module Google end end - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. class GoogleCloudVisionV1p2beta1TextAnnotation include Google::Apis::Core::Hashable @@ -4722,9 +4397,8 @@ module Google # @return [Float] attr_accessor :confidence - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -4765,8 +4439,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the vertex coordinates are in the same scale as the original image. + # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are + # in the same scale as the original image. class GoogleCloudVisionV1p2beta1Vertex include Google::Apis::Core::Hashable @@ -4795,14 +4469,14 @@ module Google class GoogleCloudVisionV1p2beta1WebDetection include Google::Apis::Core::Hashable - # The service's best guess as to the topic of the request image. - # Inferred from similar images on the open web. + # The service's best guess as to the topic of the request image. Inferred from + # similar images on the open web. # Corresponds to the JSON property `bestGuessLabels` # @return [Array] attr_accessor :best_guess_labels - # Fully matching images from the Internet. - # Can include resized copies of the query image. + # Fully matching images from the Internet. Can include resized copies of the + # query image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -4812,9 +4486,9 @@ module Google # @return [Array] attr_accessor :pages_with_matching_images - # Partial matching images from the Internet. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its crops. + # Partial matching images from the Internet. Those images are similar enough to + # share some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -4858,8 +4532,8 @@ module Google # @return [String] attr_accessor :entity_id - # Overall relevancy score for the entity. - # Not normalized and not comparable across different image queries. + # Overall relevancy score for the entity. Not normalized and not comparable + # across different image queries. # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -4910,9 +4584,9 @@ module Google # @return [String] attr_accessor :label - # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - # For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more + # information, see http://www.unicode.org/reports/tr35/# + # Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -4932,8 +4606,8 @@ module Google class GoogleCloudVisionV1p2beta1WebDetectionWebPage include Google::Apis::Core::Hashable - # Fully matching images on the page. - # Can include resized copies of the query image. + # Fully matching images on the page. Can include resized copies of the query + # image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -4943,10 +4617,9 @@ module Google # @return [String] attr_accessor :page_title - # Partial matching images on the page. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its - # crops. + # Partial matching images on the page. Those images are similar enough to share + # some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -4994,8 +4667,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p2beta1TextAnnotationTextProperty] attr_accessor :property - # List of symbols in the word. - # The order of the symbols follows the natural reading order. + # List of symbols in the word. The order of the symbols follows the natural + # reading order. # Corresponds to the JSON property `symbols` # @return [Array] attr_accessor :symbols @@ -5018,12 +4691,12 @@ module Google class GoogleCloudVisionV1p3beta1AnnotateFileResponse 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::VisionV1::Status] attr_accessor :error @@ -5033,8 +4706,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1InputConfig] attr_accessor :input_config - # Individual responses to images found within the file. This field will be - # empty if the `error` field is set. + # Individual responses to images found within the file. This field will be empty + # if the `error` field is set. # Corresponds to the JSON property `responses` # @return [Array] attr_accessor :responses @@ -5072,12 +4745,12 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1CropHintsAnnotation] attr_accessor :crop_hints_annotation - # 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::VisionV1::Status] attr_accessor :error @@ -5087,13 +4760,12 @@ module Google # @return [Array] attr_accessor :face_annotations - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. # Corresponds to the JSON property `fullTextAnnotation` # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1TextAnnotation] attr_accessor :full_text_annotation @@ -5113,8 +4785,8 @@ module Google # @return [Array] attr_accessor :landmark_annotations - # If present, localized object detection has completed successfully. - # This will be sorted descending by confidence score. + # If present, localized object detection has completed successfully. This will + # be sorted descending by confidence score. # Corresponds to the JSON property `localizedObjectAnnotations` # @return [Array] attr_accessor :localized_object_annotations @@ -5129,9 +4801,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1ProductSearchResults] attr_accessor :product_search_results - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). # Corresponds to the JSON property `safeSearchAnnotation` # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1SafeSearchAnnotation] attr_accessor :safe_search_annotation @@ -5208,14 +4879,14 @@ module Google end end - # Metadata for the batch operations such as the current state. - # This is included in the `metadata` field of the `Operation` returned by the - # `GetOperation` call of the `google::longrunning::Operations` service. + # Metadata for the batch operations such as the current state. This is included + # in the `metadata` field of the `Operation` returned by the `GetOperation` call + # of the `google::longrunning::Operations` service. class GoogleCloudVisionV1p3beta1BatchOperationMetadata include Google::Apis::Core::Hashable - # The time when the batch request is finished and - # google.longrunning.Operation.done is set to true. + # The time when the batch request is finished and google.longrunning.Operation. + # done is set to true. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -5310,123 +4981,61 @@ module Google end end - # Color information consists of RGB channels, score, and the fraction of - # the image that the color occupies in the image. + # Color information consists of RGB channels, score, and the fraction of the + # image that the color occupies in the image. class GoogleCloudVisionV1p3beta1ColorInfo include Google::Apis::Core::Hashable # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... # Corresponds to the JSON property `color` # @return [Google::Apis::VisionV1::Color] attr_accessor :color - # The fraction of pixels the color occupies in the image. - # Value in range [0, 1]. + # The fraction of pixels the color occupies in the image. Value in range [0, 1]. # Corresponds to the JSON property `pixelFraction` # @return [Float] attr_accessor :pixel_fraction @@ -5457,7 +5066,7 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1BoundingPoly] attr_accessor :bounding_poly - # Confidence of this being a salient region. Range [0, 1]. + # Confidence of this being a salient region. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -5527,11 +5136,10 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1BoundingPoly] attr_accessor :bounding_poly - # **Deprecated. Use `score` instead.** - # The accuracy of the entity detection in an image. - # For example, for an image in which the "Eiffel Tower" entity is detected, - # this field represents the confidence that there is a tower in the query - # image. Range [0, 1]. + # **Deprecated. Use `score` instead.** The accuracy of the entity detection in + # an image. For example, for an image in which the "Eiffel Tower" entity is + # detected, this field represents the confidence that there is a tower in the + # query image. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -5541,30 +5149,29 @@ module Google # @return [String] attr_accessor :description - # The language code for the locale in which the entity textual - # `description` is expressed. + # The language code for the locale in which the entity textual `description` is + # expressed. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale - # The location information for the detected entity. Multiple - # `LocationInfo` elements can be present because one location may - # indicate the location of the scene in the image, and another location - # may indicate the location of the place where the image was taken. - # Location information is usually present for landmarks. + # The location information for the detected entity. Multiple `LocationInfo` + # elements can be present because one location may indicate the location of the + # scene in the image, and another location may indicate the location of the + # place where the image was taken. Location information is usually present for + # landmarks. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `mid` # @return [String] attr_accessor :mid - # Some entities may have optional user-supplied `Property` (name/value) - # fields, such a score or string that qualifies the entity. + # Some entities may have optional user-supplied `Property` (name/value) fields, + # such a score or string that qualifies the entity. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -5574,11 +5181,11 @@ module Google # @return [Float] attr_accessor :score - # The relevancy of the ICA (Image Content Annotation) label to the - # image. For example, the relevancy of "tower" is likely higher to an image - # containing the detected "Eiffel Tower" than to an image containing a - # detected distant towering building, even though the confidence that - # there is a tower in each image may be the same. Range [0, 1]. + # The relevancy of the ICA (Image Content Annotation) label to the image. For + # example, the relevancy of "tower" is likely higher to an image containing the + # detected "Eiffel Tower" than to an image containing a detected distant + # towering building, even though the confidence that there is a tower in each + # image may be the same. Range [0, 1]. # Corresponds to the JSON property `topicality` # @return [Float] attr_accessor :topicality @@ -5651,15 +5258,15 @@ module Google attr_accessor :landmarks # Yaw angle, which indicates the leftward/rightward angle that the face is - # pointing relative to the vertical plane perpendicular to the image. Range - # [-180,180]. + # pointing relative to the vertical plane perpendicular to the image. Range [- + # 180,180]. # Corresponds to the JSON property `panAngle` # @return [Float] attr_accessor :pan_angle - # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation - # of the face relative to the image vertical about the axis perpendicular to - # the face. Range [-180,180]. + # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of + # the face relative to the image vertical about the axis perpendicular to the + # face. Range [-180,180]. # Corresponds to the JSON property `rollAngle` # @return [Float] attr_accessor :roll_angle @@ -5713,9 +5320,9 @@ module Google class GoogleCloudVisionV1p3beta1FaceAnnotationLandmark include Google::Apis::Core::Hashable - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. # Corresponds to the JSON property `position` # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1Position] attr_accessor :position @@ -5740,24 +5347,20 @@ module Google class GoogleCloudVisionV1p3beta1GcsDestination include Google::Apis::Core::Hashable - # Google Cloud Storage URI prefix where the results will be stored. Results - # will be in JSON format and preceded by its corresponding input URI prefix. - # This field can either represent a gcs file prefix or gcs directory. In - # either case, the uri should be unique because in order to get all of the - # output files, you will need to do a wildcard gcs search on the uri prefix - # you provide. - # Examples: - # * File Prefix: gs://bucket-name/here/filenameprefix The output files - # will be created in gs://bucket-name/here/ and the names of the - # output files will begin with "filenameprefix". - # * Directory Prefix: gs://bucket-name/some/location/ The output files - # will be created in gs://bucket-name/some/location/ and the names of the - # output files could be anything because there was no filename prefix - # specified. - # If multiple outputs, each response is still AnnotateFileResponse, each of - # which contains some subset of the full list of AnnotateImageResponse. - # Multiple outputs can happen if, for example, the output JSON is too large - # and overflows into multiple sharded files. + # Google Cloud Storage URI prefix where the results will be stored. Results will + # be in JSON format and preceded by its corresponding input URI prefix. This + # field can either represent a gcs file prefix or gcs directory. In either case, + # the uri should be unique because in order to get all of the output files, you + # will need to do a wildcard gcs search on the uri prefix you provide. Examples: + # * File Prefix: gs://bucket-name/here/filenameprefix The output files will be + # created in gs://bucket-name/here/ and the names of the output files will begin + # with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The + # output files will be created in gs://bucket-name/some/location/ and the names + # of the output files could be anything because there was no filename prefix + # specified. If multiple outputs, each response is still AnnotateFileResponse, + # each of which contains some subset of the full list of AnnotateImageResponse. + # Multiple outputs can happen if, for example, the output JSON is too large and + # overflows into multiple sharded files. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -5776,8 +5379,8 @@ module Google class GoogleCloudVisionV1p3beta1GcsSource include Google::Apis::Core::Hashable - # Google Cloud Storage URI for the input file. This must only be a - # Google Cloud Storage object. Wildcards are not currently supported. + # Google Cloud Storage URI for the input file. This must only be a Google Cloud + # Storage object. Wildcards are not currently supported. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -5797,8 +5400,8 @@ module Google class GoogleCloudVisionV1p3beta1ImageAnnotationContext include Google::Apis::Core::Hashable - # If the file was a PDF or TIFF, this field gives the page number within - # the file used to produce the image. + # If the file was a PDF or TIFF, this field gives the page number within the + # file used to produce the image. # Corresponds to the JSON property `pageNumber` # @return [Fixnum] attr_accessor :page_number @@ -5838,9 +5441,8 @@ module Google end end - # Response message for the `ImportProductSets` method. - # This message is returned by the - # google.longrunning.Operations.GetOperation method in the returned + # Response message for the `ImportProductSets` method. This message is returned + # by the google.longrunning.Operations.GetOperation method in the returned # google.longrunning.Operation.response field. class GoogleCloudVisionV1p3beta1ImportProductSetsResponse include Google::Apis::Core::Hashable @@ -5850,11 +5452,10 @@ module Google # @return [Array] attr_accessor :reference_images - # The rpc status for each ImportProductSet request, including both successes - # and errors. - # The number of statuses here matches the number of lines in the csv file, - # and statuses[i] stores the success or failure status of processing the i-th - # line of the csv, starting from line 0. + # The rpc status for each ImportProductSet request, including both successes and + # errors. The number of statuses here matches the number of lines in the csv + # file, and statuses[i] stores the success or failure status of processing the i- + # th line of the csv, starting from line 0. # Corresponds to the JSON property `statuses` # @return [Array] attr_accessor :statuses @@ -5874,11 +5475,11 @@ module Google class GoogleCloudVisionV1p3beta1InputConfig include Google::Apis::Core::Hashable - # File content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateFiles requests. It does - # not work for AsyncBatchAnnotateFiles requests. + # File content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -5889,8 +5490,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1GcsSource] attr_accessor :gcs_source - # The type of the file. Currently only "application/pdf", "image/tiff" and - # "image/gif" are supported. Wildcards are not supported. + # The type of the file. Currently only "application/pdf", "image/tiff" and " + # image/gif" are supported. Wildcards are not supported. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -5916,9 +5517,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1BoundingPoly] attr_accessor :bounding_poly - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -5958,9 +5558,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::VisionV1::LatLng] attr_accessor :lat_lng @@ -5975,9 +5574,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVisionV1p3beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -6037,13 +5635,11 @@ module Google class GoogleCloudVisionV1p3beta1OutputConfig include Google::Apis::Core::Hashable - # The max number of response protos to put into each output JSON file on - # Google Cloud Storage. - # The valid range is [1, 100]. If not specified, the default value is 20. - # For example, for one pdf file with 100 pages, 100 response protos will - # be generated. If `batch_size` = 20, then 5 json files each - # containing 20 response protos will be written under the prefix - # `gcs_destination`.`uri`. + # The max number of response protos to put into each output JSON file on Google + # Cloud Storage. The valid range is [1, 100]. If not specified, the default + # value is 20. For example, for one pdf file with 100 pages, 100 response protos + # will be generated. If `batch_size` = 20, then 5 json files each containing 20 + # response protos will be written under the prefix `gcs_destination`.`uri`. # Currently, batch_size only applies to GcsDestination, with potential future # support for other output configurations. # Corresponds to the JSON property `batchSize` @@ -6080,8 +5676,8 @@ module Google # @return [Float] attr_accessor :confidence - # Page height. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page height. For PDFs the unit is points. For images (including TIFFs) the + # unit is pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -6091,8 +5687,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1TextAnnotationTextProperty] attr_accessor :property - # Page width. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page width. For PDFs the unit is points. For images (including TIFFs) the unit + # is pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -6148,9 +5744,9 @@ module Google end end - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. class GoogleCloudVisionV1p3beta1Position include Google::Apis::Core::Hashable @@ -6197,33 +5793,28 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the product. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - # This field is ignored when creating a product. + # The resource name of the product. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Immutable. The category for the product identified by the reference image. - # This should - # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories - # "homegoods", "apparel", and "toys" are still supported, but these should - # not be used for new products. + # This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods- + # v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" + # are still supported, but these should not be used for new products. # Corresponds to the JSON property `productCategory` # @return [String] attr_accessor :product_category - # Key-value pairs that can be attached to a product. At query time, - # constraints can be specified based on the product_labels. - # Note that integer values can be provided as strings, e.g. "1199". Only - # strings with integer values can match a range-based restriction which is - # to be supported soon. - # Multiple values can be assigned to the same key. One product may have up to - # 500 product_labels. - # Notice that the total number of distinct product_labels over all products - # in one ProductSet cannot exceed 1M, otherwise the product search pipeline - # will refuse to work for that ProductSet. + # Key-value pairs that can be attached to a product. At query time, constraints + # can be specified based on the product_labels. Note that integer values can be + # provided as strings, e.g. "1199". Only strings with integer values can match a + # range-based restriction which is to be supported soon. Multiple values can be + # assigned to the same key. One product may have up to 500 product_labels. + # Notice that the total number of distinct product_labels over all products in + # one ProductSet cannot exceed 1M, otherwise the product search pipeline will + # refuse to work for that ProductSet. # Corresponds to the JSON property `productLabels` # @return [Array] attr_accessor :product_labels @@ -6252,8 +5843,8 @@ module Google # @return [String] attr_accessor :key - # The value of the label attached to the product. Cannot be empty and - # cannot exceed 128 bytes. + # The value of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -6274,8 +5865,8 @@ module Google include Google::Apis::Core::Hashable # Timestamp of the index which provided these results. Products added to the - # product set and products removed from the product set after this time are - # not reflected in the current results. + # product set and products removed from the product set after this time are not + # reflected in the current results. # Corresponds to the JSON property `indexTime` # @return [String] attr_accessor :index_time @@ -6305,8 +5896,7 @@ module Google end end - # Information about the products similar to a single product in a query - # image. + # Information about the products similar to a single product in a query image. class GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult include Google::Apis::Core::Hashable @@ -6341,9 +5931,8 @@ module Google class GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation include Google::Apis::Core::Hashable - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -6380,8 +5969,8 @@ module Google class GoogleCloudVisionV1p3beta1ProductSearchResultsResult include Google::Apis::Core::Hashable - # The resource name of the image from the product that is the closest match - # to the query. + # The resource name of the image from the product that is the closest match to + # the query. # Corresponds to the JSON property `image` # @return [String] attr_accessor :image @@ -6391,8 +5980,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1Product] attr_accessor :product - # A confidence level on the match, ranging from 0 (no confidence) to - # 1 (full confidence). + # A confidence level on the match, ranging from 0 (no confidence) to 1 (full + # confidence). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -6446,28 +6035,24 @@ module Google include Google::Apis::Core::Hashable # Optional. Bounding polygons around the areas of interest in the reference - # image. - # If this field is empty, the system will try to detect regions of - # interest. At most 10 bounding polygons will be used. - # The provided shape is converted into a non-rotated rectangle. Once - # converted, the small edge of the rectangle must be greater than or equal - # to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 - # is not). + # image. If this field is empty, the system will try to detect regions of + # interest. At most 10 bounding polygons will be used. The provided shape is + # converted into a non-rotated rectangle. Once converted, the small edge of the + # rectangle must be greater than or equal to 300 pixels. The aspect ratio must + # be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). # Corresponds to the JSON property `boundingPolys` # @return [Array] attr_accessor :bounding_polys - # The resource name of the reference image. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ - # IMAGE_ID`. - # This field is ignored when creating a reference image. + # The resource name of the reference image. Format is: `projects/PROJECT_ID/ + # locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is + # ignored when creating a reference image. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The Google Cloud Storage URI of the reference image. - # The URI must start with `gs://`. + # Required. The Google Cloud Storage URI of the reference image. The URI must + # start with `gs://`. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -6484,15 +6069,14 @@ module Google end end - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). class GoogleCloudVisionV1p3beta1SafeSearchAnnotation include Google::Apis::Core::Hashable # Represents the adult content likelihood for the image. Adult content may - # contain elements such as nudity, pornographic images or cartoons, or - # sexual activities. + # contain elements such as nudity, pornographic images or cartoons, or sexual + # activities. # Corresponds to the JSON property `adult` # @return [String] attr_accessor :adult @@ -6504,15 +6088,14 @@ module Google # Likelihood that the request image contains racy content. Racy content may # include (but is not limited to) skimpy or sheer clothing, strategically - # covered nudity, lewd or provocative poses, or close-ups of sensitive - # body areas. + # covered nudity, lewd or provocative poses, or close-ups of sensitive body + # areas. # Corresponds to the JSON property `racy` # @return [String] attr_accessor :racy - # Spoof likelihood. The likelihood that an modification - # was made to the image's canonical version to make it appear - # funny or offensive. + # Spoof likelihood. The likelihood that an modification was made to the image's + # canonical version to make it appear funny or offensive. # Corresponds to the JSON property `spoof` # @return [String] attr_accessor :spoof @@ -6573,13 +6156,12 @@ module Google end end - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. class GoogleCloudVisionV1p3beta1TextAnnotation include Google::Apis::Core::Hashable @@ -6639,9 +6221,8 @@ module Google # @return [Float] attr_accessor :confidence - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -6682,8 +6263,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the vertex coordinates are in the same scale as the original image. + # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are + # in the same scale as the original image. class GoogleCloudVisionV1p3beta1Vertex include Google::Apis::Core::Hashable @@ -6712,14 +6293,14 @@ module Google class GoogleCloudVisionV1p3beta1WebDetection include Google::Apis::Core::Hashable - # The service's best guess as to the topic of the request image. - # Inferred from similar images on the open web. + # The service's best guess as to the topic of the request image. Inferred from + # similar images on the open web. # Corresponds to the JSON property `bestGuessLabels` # @return [Array] attr_accessor :best_guess_labels - # Fully matching images from the Internet. - # Can include resized copies of the query image. + # Fully matching images from the Internet. Can include resized copies of the + # query image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -6729,9 +6310,9 @@ module Google # @return [Array] attr_accessor :pages_with_matching_images - # Partial matching images from the Internet. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its crops. + # Partial matching images from the Internet. Those images are similar enough to + # share some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -6775,8 +6356,8 @@ module Google # @return [String] attr_accessor :entity_id - # Overall relevancy score for the entity. - # Not normalized and not comparable across different image queries. + # Overall relevancy score for the entity. Not normalized and not comparable + # across different image queries. # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -6827,9 +6408,9 @@ module Google # @return [String] attr_accessor :label - # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - # For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more + # information, see http://www.unicode.org/reports/tr35/# + # Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -6849,8 +6430,8 @@ module Google class GoogleCloudVisionV1p3beta1WebDetectionWebPage include Google::Apis::Core::Hashable - # Fully matching images on the page. - # Can include resized copies of the query image. + # Fully matching images on the page. Can include resized copies of the query + # image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -6860,10 +6441,9 @@ module Google # @return [String] attr_accessor :page_title - # Partial matching images on the page. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its - # crops. + # Partial matching images on the page. Those images are similar enough to share + # some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -6911,8 +6491,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p3beta1TextAnnotationTextProperty] attr_accessor :property - # List of symbols in the word. - # The order of the symbols follows the natural reading order. + # List of symbols in the word. The order of the symbols follows the natural + # reading order. # Corresponds to the JSON property `symbols` # @return [Array] attr_accessor :symbols @@ -6935,12 +6515,12 @@ module Google class GoogleCloudVisionV1p4beta1AnnotateFileResponse 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::VisionV1::Status] attr_accessor :error @@ -6950,8 +6530,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1InputConfig] attr_accessor :input_config - # Individual responses to images found within the file. This field will be - # empty if the `error` field is set. + # Individual responses to images found within the file. This field will be empty + # if the `error` field is set. # Corresponds to the JSON property `responses` # @return [Array] attr_accessor :responses @@ -6989,12 +6569,12 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1CropHintsAnnotation] attr_accessor :crop_hints_annotation - # 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::VisionV1::Status] attr_accessor :error @@ -7004,13 +6584,12 @@ module Google # @return [Array] attr_accessor :face_annotations - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. # Corresponds to the JSON property `fullTextAnnotation` # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1TextAnnotation] attr_accessor :full_text_annotation @@ -7030,8 +6609,8 @@ module Google # @return [Array] attr_accessor :landmark_annotations - # If present, localized object detection has completed successfully. - # This will be sorted descending by confidence score. + # If present, localized object detection has completed successfully. This will + # be sorted descending by confidence score. # Corresponds to the JSON property `localizedObjectAnnotations` # @return [Array] attr_accessor :localized_object_annotations @@ -7046,9 +6625,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1ProductSearchResults] attr_accessor :product_search_results - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). # Corresponds to the JSON property `safeSearchAnnotation` # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1SafeSearchAnnotation] attr_accessor :safe_search_annotation @@ -7164,14 +6742,14 @@ module Google end end - # Metadata for the batch operations such as the current state. - # This is included in the `metadata` field of the `Operation` returned by the - # `GetOperation` call of the `google::longrunning::Operations` service. + # Metadata for the batch operations such as the current state. This is included + # in the `metadata` field of the `Operation` returned by the `GetOperation` call + # of the `google::longrunning::Operations` service. class GoogleCloudVisionV1p4beta1BatchOperationMetadata include Google::Apis::Core::Hashable - # The time when the batch request is finished and - # google.longrunning.Operation.done is set to true. + # The time when the batch request is finished and google.longrunning.Operation. + # done is set to true. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -7280,8 +6858,7 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the preloaded Celebrity. Has the format - # `builtin/`mid``. + # The resource name of the preloaded Celebrity. Has the format `builtin/`mid``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -7298,123 +6875,61 @@ module Google end end - # Color information consists of RGB channels, score, and the fraction of - # the image that the color occupies in the image. + # Color information consists of RGB channels, score, and the fraction of the + # image that the color occupies in the image. class GoogleCloudVisionV1p4beta1ColorInfo include Google::Apis::Core::Hashable # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... # Corresponds to the JSON property `color` # @return [Google::Apis::VisionV1::Color] attr_accessor :color - # The fraction of pixels the color occupies in the image. - # Value in range [0, 1]. + # The fraction of pixels the color occupies in the image. Value in range [0, 1]. # Corresponds to the JSON property `pixelFraction` # @return [Float] attr_accessor :pixel_fraction @@ -7445,7 +6960,7 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1BoundingPoly] attr_accessor :bounding_poly - # Confidence of this being a salient region. Range [0, 1]. + # Confidence of this being a salient region. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -7515,11 +7030,10 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1BoundingPoly] attr_accessor :bounding_poly - # **Deprecated. Use `score` instead.** - # The accuracy of the entity detection in an image. - # For example, for an image in which the "Eiffel Tower" entity is detected, - # this field represents the confidence that there is a tower in the query - # image. Range [0, 1]. + # **Deprecated. Use `score` instead.** The accuracy of the entity detection in + # an image. For example, for an image in which the "Eiffel Tower" entity is + # detected, this field represents the confidence that there is a tower in the + # query image. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -7529,30 +7043,29 @@ module Google # @return [String] attr_accessor :description - # The language code for the locale in which the entity textual - # `description` is expressed. + # The language code for the locale in which the entity textual `description` is + # expressed. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale - # The location information for the detected entity. Multiple - # `LocationInfo` elements can be present because one location may - # indicate the location of the scene in the image, and another location - # may indicate the location of the place where the image was taken. - # Location information is usually present for landmarks. + # The location information for the detected entity. Multiple `LocationInfo` + # elements can be present because one location may indicate the location of the + # scene in the image, and another location may indicate the location of the + # place where the image was taken. Location information is usually present for + # landmarks. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `mid` # @return [String] attr_accessor :mid - # Some entities may have optional user-supplied `Property` (name/value) - # fields, such a score or string that qualifies the entity. + # Some entities may have optional user-supplied `Property` (name/value) fields, + # such a score or string that qualifies the entity. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -7562,11 +7075,11 @@ module Google # @return [Float] attr_accessor :score - # The relevancy of the ICA (Image Content Annotation) label to the - # image. For example, the relevancy of "tower" is likely higher to an image - # containing the detected "Eiffel Tower" than to an image containing a - # detected distant towering building, even though the confidence that - # there is a tower in each image may be the same. Range [0, 1]. + # The relevancy of the ICA (Image Content Annotation) label to the image. For + # example, the relevancy of "tower" is likely higher to an image containing the + # detected "Eiffel Tower" than to an image containing a detected distant + # towering building, even though the confidence that there is a tower in each + # image may be the same. Range [0, 1]. # Corresponds to the JSON property `topicality` # @return [Float] attr_accessor :topicality @@ -7639,23 +7152,23 @@ module Google attr_accessor :landmarks # Yaw angle, which indicates the leftward/rightward angle that the face is - # pointing relative to the vertical plane perpendicular to the image. Range - # [-180,180]. + # pointing relative to the vertical plane perpendicular to the image. Range [- + # 180,180]. # Corresponds to the JSON property `panAngle` # @return [Float] attr_accessor :pan_angle - # Additional recognition information. Only computed if - # image_context.face_recognition_params is provided, **and** a match is found - # to a Celebrity in the input CelebritySet. This field is - # sorted in order of decreasing confidence values. + # Additional recognition information. Only computed if image_context. + # face_recognition_params is provided, **and** a match is found to a Celebrity + # in the input CelebritySet. This field is sorted in order of decreasing + # confidence values. # Corresponds to the JSON property `recognitionResult` # @return [Array] attr_accessor :recognition_result - # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation - # of the face relative to the image vertical about the axis perpendicular to - # the face. Range [-180,180]. + # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of + # the face relative to the image vertical about the axis perpendicular to the + # face. Range [-180,180]. # Corresponds to the JSON property `rollAngle` # @return [Float] attr_accessor :roll_angle @@ -7710,9 +7223,9 @@ module Google class GoogleCloudVisionV1p4beta1FaceAnnotationLandmark include Google::Apis::Core::Hashable - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. # Corresponds to the JSON property `position` # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1Position] attr_accessor :position @@ -7762,24 +7275,20 @@ module Google class GoogleCloudVisionV1p4beta1GcsDestination include Google::Apis::Core::Hashable - # Google Cloud Storage URI prefix where the results will be stored. Results - # will be in JSON format and preceded by its corresponding input URI prefix. - # This field can either represent a gcs file prefix or gcs directory. In - # either case, the uri should be unique because in order to get all of the - # output files, you will need to do a wildcard gcs search on the uri prefix - # you provide. - # Examples: - # * File Prefix: gs://bucket-name/here/filenameprefix The output files - # will be created in gs://bucket-name/here/ and the names of the - # output files will begin with "filenameprefix". - # * Directory Prefix: gs://bucket-name/some/location/ The output files - # will be created in gs://bucket-name/some/location/ and the names of the - # output files could be anything because there was no filename prefix - # specified. - # If multiple outputs, each response is still AnnotateFileResponse, each of - # which contains some subset of the full list of AnnotateImageResponse. - # Multiple outputs can happen if, for example, the output JSON is too large - # and overflows into multiple sharded files. + # Google Cloud Storage URI prefix where the results will be stored. Results will + # be in JSON format and preceded by its corresponding input URI prefix. This + # field can either represent a gcs file prefix or gcs directory. In either case, + # the uri should be unique because in order to get all of the output files, you + # will need to do a wildcard gcs search on the uri prefix you provide. Examples: + # * File Prefix: gs://bucket-name/here/filenameprefix The output files will be + # created in gs://bucket-name/here/ and the names of the output files will begin + # with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The + # output files will be created in gs://bucket-name/some/location/ and the names + # of the output files could be anything because there was no filename prefix + # specified. If multiple outputs, each response is still AnnotateFileResponse, + # each of which contains some subset of the full list of AnnotateImageResponse. + # Multiple outputs can happen if, for example, the output JSON is too large and + # overflows into multiple sharded files. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -7798,8 +7307,8 @@ module Google class GoogleCloudVisionV1p4beta1GcsSource include Google::Apis::Core::Hashable - # Google Cloud Storage URI for the input file. This must only be a - # Google Cloud Storage object. Wildcards are not currently supported. + # Google Cloud Storage URI for the input file. This must only be a Google Cloud + # Storage object. Wildcards are not currently supported. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -7819,8 +7328,8 @@ module Google class GoogleCloudVisionV1p4beta1ImageAnnotationContext include Google::Apis::Core::Hashable - # If the file was a PDF or TIFF, this field gives the page number within - # the file used to produce the image. + # If the file was a PDF or TIFF, this field gives the page number within the + # file used to produce the image. # Corresponds to the JSON property `pageNumber` # @return [Fixnum] attr_accessor :page_number @@ -7860,9 +7369,8 @@ module Google end end - # Response message for the `ImportProductSets` method. - # This message is returned by the - # google.longrunning.Operations.GetOperation method in the returned + # Response message for the `ImportProductSets` method. This message is returned + # by the google.longrunning.Operations.GetOperation method in the returned # google.longrunning.Operation.response field. class GoogleCloudVisionV1p4beta1ImportProductSetsResponse include Google::Apis::Core::Hashable @@ -7872,11 +7380,10 @@ module Google # @return [Array] attr_accessor :reference_images - # The rpc status for each ImportProductSet request, including both successes - # and errors. - # The number of statuses here matches the number of lines in the csv file, - # and statuses[i] stores the success or failure status of processing the i-th - # line of the csv, starting from line 0. + # The rpc status for each ImportProductSet request, including both successes and + # errors. The number of statuses here matches the number of lines in the csv + # file, and statuses[i] stores the success or failure status of processing the i- + # th line of the csv, starting from line 0. # Corresponds to the JSON property `statuses` # @return [Array] attr_accessor :statuses @@ -7896,11 +7403,11 @@ module Google class GoogleCloudVisionV1p4beta1InputConfig include Google::Apis::Core::Hashable - # File content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateFiles requests. It does - # not work for AsyncBatchAnnotateFiles requests. + # File content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -7911,8 +7418,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1GcsSource] attr_accessor :gcs_source - # The type of the file. Currently only "application/pdf", "image/tiff" and - # "image/gif" are supported. Wildcards are not supported. + # The type of the file. Currently only "application/pdf", "image/tiff" and " + # image/gif" are supported. Wildcards are not supported. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -7938,9 +7445,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1BoundingPoly] attr_accessor :bounding_poly - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -7980,9 +7486,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::VisionV1::LatLng] attr_accessor :lat_lng @@ -7997,9 +7502,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVisionV1p4beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -8059,13 +7563,11 @@ module Google class GoogleCloudVisionV1p4beta1OutputConfig include Google::Apis::Core::Hashable - # The max number of response protos to put into each output JSON file on - # Google Cloud Storage. - # The valid range is [1, 100]. If not specified, the default value is 20. - # For example, for one pdf file with 100 pages, 100 response protos will - # be generated. If `batch_size` = 20, then 5 json files each - # containing 20 response protos will be written under the prefix - # `gcs_destination`.`uri`. + # The max number of response protos to put into each output JSON file on Google + # Cloud Storage. The valid range is [1, 100]. If not specified, the default + # value is 20. For example, for one pdf file with 100 pages, 100 response protos + # will be generated. If `batch_size` = 20, then 5 json files each containing 20 + # response protos will be written under the prefix `gcs_destination`.`uri`. # Currently, batch_size only applies to GcsDestination, with potential future # support for other output configurations. # Corresponds to the JSON property `batchSize` @@ -8102,8 +7604,8 @@ module Google # @return [Float] attr_accessor :confidence - # Page height. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page height. For PDFs the unit is points. For images (including TIFFs) the + # unit is pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -8113,8 +7615,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1TextAnnotationTextProperty] attr_accessor :property - # Page width. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page width. For PDFs the unit is points. For images (including TIFFs) the unit + # is pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -8170,9 +7672,9 @@ module Google end end - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. class GoogleCloudVisionV1p4beta1Position include Google::Apis::Core::Hashable @@ -8219,33 +7721,28 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the product. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - # This field is ignored when creating a product. + # The resource name of the product. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Immutable. The category for the product identified by the reference image. - # This should - # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories - # "homegoods", "apparel", and "toys" are still supported, but these should - # not be used for new products. + # This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods- + # v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" + # are still supported, but these should not be used for new products. # Corresponds to the JSON property `productCategory` # @return [String] attr_accessor :product_category - # Key-value pairs that can be attached to a product. At query time, - # constraints can be specified based on the product_labels. - # Note that integer values can be provided as strings, e.g. "1199". Only - # strings with integer values can match a range-based restriction which is - # to be supported soon. - # Multiple values can be assigned to the same key. One product may have up to - # 500 product_labels. - # Notice that the total number of distinct product_labels over all products - # in one ProductSet cannot exceed 1M, otherwise the product search pipeline - # will refuse to work for that ProductSet. + # Key-value pairs that can be attached to a product. At query time, constraints + # can be specified based on the product_labels. Note that integer values can be + # provided as strings, e.g. "1199". Only strings with integer values can match a + # range-based restriction which is to be supported soon. Multiple values can be + # assigned to the same key. One product may have up to 500 product_labels. + # Notice that the total number of distinct product_labels over all products in + # one ProductSet cannot exceed 1M, otherwise the product search pipeline will + # refuse to work for that ProductSet. # Corresponds to the JSON property `productLabels` # @return [Array] attr_accessor :product_labels @@ -8274,8 +7771,8 @@ module Google # @return [String] attr_accessor :key - # The value of the label attached to the product. Cannot be empty and - # cannot exceed 128 bytes. + # The value of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -8296,8 +7793,8 @@ module Google include Google::Apis::Core::Hashable # Timestamp of the index which provided these results. Products added to the - # product set and products removed from the product set after this time are - # not reflected in the current results. + # product set and products removed from the product set after this time are not + # reflected in the current results. # Corresponds to the JSON property `indexTime` # @return [String] attr_accessor :index_time @@ -8327,8 +7824,7 @@ module Google end end - # Information about the products similar to a single product in a query - # image. + # Information about the products similar to a single product in a query image. class GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult include Google::Apis::Core::Hashable @@ -8363,9 +7859,8 @@ module Google class GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation include Google::Apis::Core::Hashable - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -8402,8 +7897,8 @@ module Google class GoogleCloudVisionV1p4beta1ProductSearchResultsResult include Google::Apis::Core::Hashable - # The resource name of the image from the product that is the closest match - # to the query. + # The resource name of the image from the product that is the closest match to + # the query. # Corresponds to the JSON property `image` # @return [String] attr_accessor :image @@ -8413,8 +7908,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1Product] attr_accessor :product - # A confidence level on the match, ranging from 0 (no confidence) to - # 1 (full confidence). + # A confidence level on the match, ranging from 0 (no confidence) to 1 (full + # confidence). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -8468,28 +7963,24 @@ module Google include Google::Apis::Core::Hashable # Optional. Bounding polygons around the areas of interest in the reference - # image. - # If this field is empty, the system will try to detect regions of - # interest. At most 10 bounding polygons will be used. - # The provided shape is converted into a non-rotated rectangle. Once - # converted, the small edge of the rectangle must be greater than or equal - # to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 - # is not). + # image. If this field is empty, the system will try to detect regions of + # interest. At most 10 bounding polygons will be used. The provided shape is + # converted into a non-rotated rectangle. Once converted, the small edge of the + # rectangle must be greater than or equal to 300 pixels. The aspect ratio must + # be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). # Corresponds to the JSON property `boundingPolys` # @return [Array] attr_accessor :bounding_polys - # The resource name of the reference image. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ - # IMAGE_ID`. - # This field is ignored when creating a reference image. + # The resource name of the reference image. Format is: `projects/PROJECT_ID/ + # locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is + # ignored when creating a reference image. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The Google Cloud Storage URI of the reference image. - # The URI must start with `gs://`. + # Required. The Google Cloud Storage URI of the reference image. The URI must + # start with `gs://`. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -8506,15 +7997,14 @@ module Google end end - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). class GoogleCloudVisionV1p4beta1SafeSearchAnnotation include Google::Apis::Core::Hashable # Represents the adult content likelihood for the image. Adult content may - # contain elements such as nudity, pornographic images or cartoons, or - # sexual activities. + # contain elements such as nudity, pornographic images or cartoons, or sexual + # activities. # Corresponds to the JSON property `adult` # @return [String] attr_accessor :adult @@ -8526,15 +8016,14 @@ module Google # Likelihood that the request image contains racy content. Racy content may # include (but is not limited to) skimpy or sheer clothing, strategically - # covered nudity, lewd or provocative poses, or close-ups of sensitive - # body areas. + # covered nudity, lewd or provocative poses, or close-ups of sensitive body + # areas. # Corresponds to the JSON property `racy` # @return [String] attr_accessor :racy - # Spoof likelihood. The likelihood that an modification - # was made to the image's canonical version to make it appear - # funny or offensive. + # Spoof likelihood. The likelihood that an modification was made to the image's + # canonical version to make it appear funny or offensive. # Corresponds to the JSON property `spoof` # @return [String] attr_accessor :spoof @@ -8595,13 +8084,12 @@ module Google end end - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. class GoogleCloudVisionV1p4beta1TextAnnotation include Google::Apis::Core::Hashable @@ -8661,9 +8149,8 @@ module Google # @return [Float] attr_accessor :confidence - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -8704,8 +8191,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the vertex coordinates are in the same scale as the original image. + # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are + # in the same scale as the original image. class GoogleCloudVisionV1p4beta1Vertex include Google::Apis::Core::Hashable @@ -8734,14 +8221,14 @@ module Google class GoogleCloudVisionV1p4beta1WebDetection include Google::Apis::Core::Hashable - # The service's best guess as to the topic of the request image. - # Inferred from similar images on the open web. + # The service's best guess as to the topic of the request image. Inferred from + # similar images on the open web. # Corresponds to the JSON property `bestGuessLabels` # @return [Array] attr_accessor :best_guess_labels - # Fully matching images from the Internet. - # Can include resized copies of the query image. + # Fully matching images from the Internet. Can include resized copies of the + # query image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -8751,9 +8238,9 @@ module Google # @return [Array] attr_accessor :pages_with_matching_images - # Partial matching images from the Internet. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its crops. + # Partial matching images from the Internet. Those images are similar enough to + # share some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -8797,8 +8284,8 @@ module Google # @return [String] attr_accessor :entity_id - # Overall relevancy score for the entity. - # Not normalized and not comparable across different image queries. + # Overall relevancy score for the entity. Not normalized and not comparable + # across different image queries. # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -8849,9 +8336,9 @@ module Google # @return [String] attr_accessor :label - # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - # For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more + # information, see http://www.unicode.org/reports/tr35/# + # Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -8871,8 +8358,8 @@ module Google class GoogleCloudVisionV1p4beta1WebDetectionWebPage include Google::Apis::Core::Hashable - # Fully matching images on the page. - # Can include resized copies of the query image. + # Fully matching images on the page. Can include resized copies of the query + # image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -8882,10 +8369,9 @@ module Google # @return [String] attr_accessor :page_title - # Partial matching images on the page. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its - # crops. + # Partial matching images on the page. Those images are similar enough to share + # some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -8933,8 +8419,8 @@ module Google # @return [Google::Apis::VisionV1::GoogleCloudVisionV1p4beta1TextAnnotationTextProperty] attr_accessor :property - # List of symbols in the word. - # The order of the symbols follows the natural reading order. + # List of symbols in the word. The order of the symbols follows the natural + # reading order. # Corresponds to the JSON property `symbols` # @return [Array] attr_accessor :symbols @@ -8952,8 +8438,7 @@ module Google end end - # Information about the products similar to a single product in a query - # image. + # Information about the products similar to a single product in a query image. class GroupedResult include Google::Apis::Core::Hashable @@ -8988,11 +8473,11 @@ module Google class Image include Google::Apis::Core::Hashable - # Image content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateImages requests. It does - # not work for AsyncBatchAnnotateImages requests. + # Image content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateImages requests. It does not work for AsyncBatchAnnotateImages + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -9019,8 +8504,8 @@ module Google class ImageAnnotationContext include Google::Apis::Core::Hashable - # If the file was a PDF or TIFF, this field gives the page number within - # the file used to produce the image. + # If the file was a PDF or TIFF, this field gives the page number within the + # file used to produce the image. # Corresponds to the JSON property `pageNumber` # @return [Fixnum] attr_accessor :page_number @@ -9052,12 +8537,12 @@ module Google # List of languages to use for TEXT_DETECTION. In most cases, an empty value # yields the best results since it enables automatic language detection. For - # languages based on the Latin alphabet, setting `language_hints` is not - # needed. In rare cases, when the language of the text in the image is known, - # setting a hint will help get better results (although it will be a - # significant hindrance if the hint is wrong). Text detection returns an - # error if one or more of the specified languages is not one of the - # [supported languages](https://cloud.google.com/vision/docs/languages). + # languages based on the Latin alphabet, setting `language_hints` is not needed. + # In rare cases, when the language of the text in the image is known, setting a + # hint will help get better results (although it will be a significant hindrance + # if the hint is wrong). Text detection returns an error if one or more of the + # specified languages is not one of the [supported languages](https://cloud. + # google.com/vision/docs/languages). # Corresponds to the JSON property `languageHints` # @return [Array] attr_accessor :language_hints @@ -9114,29 +8599,24 @@ module Google class ImageSource include Google::Apis::Core::Hashable - # **Use `image_uri` instead.** - # The Google Cloud Storage URI of the form - # `gs://bucket_name/object_name`. Object versioning is not supported. See - # [Google Cloud Storage Request - # URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. + # **Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs:// + # bucket_name/object_name`. Object versioning is not supported. See [Google + # Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference- + # uris) for more info. # Corresponds to the JSON property `gcsImageUri` # @return [String] attr_accessor :gcs_image_uri - # The URI of the source image. Can be either: - # 1. A Google Cloud Storage URI of the form - # `gs://bucket_name/object_name`. Object versioning is not supported. See - # [Google Cloud Storage Request - # URIs](https://cloud.google.com/storage/docs/reference-uris) for more - # info. - # 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from - # HTTP/HTTPS URLs, Google cannot guarantee that the request will be - # completed. Your request may fail if the specified host denies the - # request (e.g. due to request throttling or DOS prevention), or if Google - # throttles requests to the site for abuse prevention. You should not - # depend on externally-hosted images for production applications. - # When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes - # precedence. + # The URI of the source image. Can be either: 1. A Google Cloud Storage URI of + # the form `gs://bucket_name/object_name`. Object versioning is not supported. + # See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/ + # reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. + # When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the + # request will be completed. Your request may fail if the specified host denies + # the request (e.g. due to request throttling or DOS prevention), or if Google + # throttles requests to the site for abuse prevention. You should not depend on + # externally-hosted images for production applications. When both `gcs_image_uri` + # and `image_uri` are specified, `image_uri` takes precedence. # Corresponds to the JSON property `imageUri` # @return [String] attr_accessor :image_uri @@ -9157,53 +8637,37 @@ module Google class ImportProductSetsGcsSource include Google::Apis::Core::Hashable - # The Google Cloud Storage URI of the input csv file. - # The URI must start with `gs://`. - # The format of the input csv file should be one image per line. - # In each line, there are 8 columns. - # 1. image-uri - # 2. image-id - # 3. product-set-id - # 4. product-id - # 5. product-category - # 6. product-display-name - # 7. labels - # 8. bounding-poly - # The `image-uri`, `product-set-id`, `product-id`, and `product-category` - # columns are required. All other columns are optional. - # If the `ProductSet` or `Product` specified by the `product-set-id` and - # `product-id` values does not exist, then the system will create a new - # `ProductSet` or `Product` for the image. In this case, the - # `product-display-name` column refers to - # display_name, the - # `product-category` column refers to - # product_category, and the - # `labels` column refers to product_labels. - # The `image-id` column is optional but must be unique if provided. If it is - # empty, the system will automatically assign a unique id to the image. - # The `product-display-name` column is optional. If it is empty, the system - # sets the display_name field for the product to a - # space (" "). You can update the `display_name` later by using the API. - # If a `Product` with the specified `product-id` already exists, then the - # system ignores the `product-display-name`, `product-category`, and `labels` - # columns. - # The `labels` column (optional) is a line containing a list of - # comma-separated key-value pairs, in the following format: - # "key_1=value_1,key_2=value_2,...,key_n=value_n" - # The `bounding-poly` column (optional) identifies one region of - # interest from the image in the same manner as `CreateReferenceImage`. If - # you do not specify the `bounding-poly` column, then the system will try to - # detect regions of interest automatically. - # At most one `bounding-poly` column is allowed per line. If the image - # contains multiple regions of interest, add a line to the CSV file that - # includes the same product information, and the `bounding-poly` values for - # each region of interest. - # The `bounding-poly` column must contain an even number of comma-separated - # numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use - # non-negative integers for absolute bounding polygons, and float values - # in [0, 1] for normalized bounding polygons. - # The system will resize the image if the image resolution is too - # large to process (larger than 20MP). + # The Google Cloud Storage URI of the input csv file. The URI must start with ` + # gs://`. The format of the input csv file should be one image per line. In each + # line, there are 8 columns. 1. image-uri 2. image-id 3. product-set-id 4. + # product-id 5. product-category 6. product-display-name 7. labels 8. bounding- + # poly The `image-uri`, `product-set-id`, `product-id`, and `product-category` + # columns are required. All other columns are optional. If the `ProductSet` or ` + # Product` specified by the `product-set-id` and `product-id` values does not + # exist, then the system will create a new `ProductSet` or `Product` for the + # image. In this case, the `product-display-name` column refers to display_name, + # the `product-category` column refers to product_category, and the `labels` + # column refers to product_labels. The `image-id` column is optional but must be + # unique if provided. If it is empty, the system will automatically assign a + # unique id to the image. The `product-display-name` column is optional. If it + # is empty, the system sets the display_name field for the product to a space (" + # "). You can update the `display_name` later by using the API. If a `Product` + # with the specified `product-id` already exists, then the system ignores the ` + # product-display-name`, `product-category`, and `labels` columns. The `labels` + # column (optional) is a line containing a list of comma-separated key-value + # pairs, in the following format: "key_1=value_1,key_2=value_2,...,key_n=value_n" + # The `bounding-poly` column (optional) identifies one region of interest from + # the image in the same manner as `CreateReferenceImage`. If you do not specify + # the `bounding-poly` column, then the system will try to detect regions of + # interest automatically. At most one `bounding-poly` column is allowed per line. + # If the image contains multiple regions of interest, add a line to the CSV + # file that includes the same product information, and the `bounding-poly` + # values for each region of interest. The `bounding-poly` column must contain an + # even number of comma-separated numbers, in the format "p1_x,p1_y,p2_x,p2_y,..., + # pn_x,pn_y". Use non-negative integers for absolute bounding polygons, and + # float values in [0, 1] for normalized bounding polygons. The system will + # resize the image if the image resolution is too large to process (larger than + # 20MP). # Corresponds to the JSON property `csvFileUri` # @return [String] attr_accessor :csv_file_uri @@ -9257,9 +8721,8 @@ module Google end end - # Response message for the `ImportProductSets` method. - # This message is returned by the - # google.longrunning.Operations.GetOperation method in the returned + # Response message for the `ImportProductSets` method. This message is returned + # by the google.longrunning.Operations.GetOperation method in the returned # google.longrunning.Operation.response field. class ImportProductSetsResponse include Google::Apis::Core::Hashable @@ -9269,11 +8732,10 @@ module Google # @return [Array] attr_accessor :reference_images - # The rpc status for each ImportProductSet request, including both successes - # and errors. - # The number of statuses here matches the number of lines in the csv file, - # and statuses[i] stores the success or failure status of processing the i-th - # line of the csv, starting from line 0. + # The rpc status for each ImportProductSet request, including both successes and + # errors. The number of statuses here matches the number of lines in the csv + # file, and statuses[i] stores the success or failure status of processing the i- + # th line of the csv, starting from line 0. # Corresponds to the JSON property `statuses` # @return [Array] attr_accessor :statuses @@ -9293,11 +8755,11 @@ module Google class InputConfig include Google::Apis::Core::Hashable - # File content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateFiles requests. It does - # not work for AsyncBatchAnnotateFiles requests. + # File content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -9308,8 +8770,8 @@ module Google # @return [Google::Apis::VisionV1::GcsSource] attr_accessor :gcs_source - # The type of the file. Currently only "application/pdf", "image/tiff" and - # "image/gif" are supported. Wildcards are not supported. + # The type of the file. Currently only "application/pdf", "image/tiff" and " + # image/gif" are supported. Wildcards are not supported. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -9336,8 +8798,8 @@ module Google # @return [String] attr_accessor :key - # The value of the label attached to the product. Cannot be empty and - # cannot exceed 128 bytes. + # The value of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -9357,9 +8819,9 @@ module Google class Landmark include Google::Apis::Core::Hashable - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. # Corresponds to the JSON property `position` # @return [Google::Apis::VisionV1::Position] attr_accessor :position @@ -9382,9 +8844,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. class LatLng include Google::Apis::Core::Hashable @@ -9415,18 +8876,16 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `maxLatLng` # @return [Google::Apis::VisionV1::LatLng] attr_accessor :max_lat_lng # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `minLatLng` # @return [Google::Apis::VisionV1::LatLng] attr_accessor :min_lat_lng @@ -9585,9 +9044,8 @@ module Google # @return [Google::Apis::VisionV1::BoundingPoly] attr_accessor :bounding_poly - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -9627,9 +9085,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::VisionV1::LatLng] attr_accessor :lat_lng @@ -9644,9 +9101,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class NormalizedVertex include Google::Apis::Core::Hashable @@ -9675,9 +9131,8 @@ module Google class ObjectAnnotation include Google::Apis::Core::Hashable - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -9715,47 +9170,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::VisionV1::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 @@ -9809,13 +9262,11 @@ module Google class OutputConfig include Google::Apis::Core::Hashable - # The max number of response protos to put into each output JSON file on - # Google Cloud Storage. - # The valid range is [1, 100]. If not specified, the default value is 20. - # For example, for one pdf file with 100 pages, 100 response protos will - # be generated. If `batch_size` = 20, then 5 json files each - # containing 20 response protos will be written under the prefix - # `gcs_destination`.`uri`. + # The max number of response protos to put into each output JSON file on Google + # Cloud Storage. The valid range is [1, 100]. If not specified, the default + # value is 20. For example, for one pdf file with 100 pages, 100 response protos + # will be generated. If `batch_size` = 20, then 5 json files each containing 20 + # response protos will be written under the prefix `gcs_destination`.`uri`. # Currently, batch_size only applies to GcsDestination, with potential future # support for other output configurations. # Corresponds to the JSON property `batchSize` @@ -9852,8 +9303,8 @@ module Google # @return [Float] attr_accessor :confidence - # Page height. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page height. For PDFs the unit is points. For images (including TIFFs) the + # unit is pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -9863,8 +9314,8 @@ module Google # @return [Google::Apis::VisionV1::TextProperty] attr_accessor :property - # Page width. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page width. For PDFs the unit is points. For images (including TIFFs) the unit + # is pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -9920,9 +9371,9 @@ module Google end end - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. class Position include Google::Apis::Core::Hashable @@ -9969,33 +9420,28 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the product. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - # This field is ignored when creating a product. + # The resource name of the product. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Immutable. The category for the product identified by the reference image. - # This should - # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories - # "homegoods", "apparel", and "toys" are still supported, but these should - # not be used for new products. + # This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods- + # v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" + # are still supported, but these should not be used for new products. # Corresponds to the JSON property `productCategory` # @return [String] attr_accessor :product_category - # Key-value pairs that can be attached to a product. At query time, - # constraints can be specified based on the product_labels. - # Note that integer values can be provided as strings, e.g. "1199". Only - # strings with integer values can match a range-based restriction which is - # to be supported soon. - # Multiple values can be assigned to the same key. One product may have up to - # 500 product_labels. - # Notice that the total number of distinct product_labels over all products - # in one ProductSet cannot exceed 1M, otherwise the product search pipeline - # will refuse to work for that ProductSet. + # Key-value pairs that can be attached to a product. At query time, constraints + # can be specified based on the product_labels. Note that integer values can be + # provided as strings, e.g. "1199". Only strings with integer values can match a + # range-based restriction which is to be supported soon. Multiple values can be + # assigned to the same key. One product may have up to 500 product_labels. + # Notice that the total number of distinct product_labels over all products in + # one ProductSet cannot exceed 1M, otherwise the product search pipeline will + # refuse to work for that ProductSet. # Corresponds to the JSON property `productLabels` # @return [Array] attr_accessor :product_labels @@ -10023,30 +9469,29 @@ module Google # @return [Google::Apis::VisionV1::BoundingPoly] attr_accessor :bounding_poly - # The filtering expression. This can be used to restrict search results based - # on Product labels. We currently support an AND of OR of key-value - # expressions, where each expression within an OR must have the same key. An - # '=' should be used to connect the key and value. - # For example, "(color = red OR color = blue) AND brand = Google" is - # acceptable, but "(color = red OR brand = Google)" is not acceptable. - # "color: red" is not acceptable because it uses a ':' instead of an '='. + # The filtering expression. This can be used to restrict search results based on + # Product labels. We currently support an AND of OR of key-value expressions, + # where each expression within an OR must have the same key. An '=' should be + # used to connect the key and value. For example, "(color = red OR color = blue) + # AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is + # not acceptable. "color: red" is not acceptable because it uses a ':' instead + # of an '='. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter - # The list of product categories to search in. Currently, we only consider - # the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", - # "packagedgoods-v1", or "general-v1" should be specified. The legacy - # categories "homegoods", "apparel", and "toys" are still supported but will - # be deprecated. For new products, please use "homegoods-v2", "apparel-v2", - # or "toys-v2" for better product search accuracy. It is recommended to - # migrate existing products to these categories as well. + # The list of product categories to search in. Currently, we only consider the + # first category, and either "homegoods-v2", "apparel-v2", "toys-v2", " + # packagedgoods-v1", or "general-v1" should be specified. The legacy categories " + # homegoods", "apparel", and "toys" are still supported but will be deprecated. + # For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for + # better product search accuracy. It is recommended to migrate existing products + # to these categories as well. # Corresponds to the JSON property `productCategories` # @return [Array] attr_accessor :product_categories - # The resource name of a ProductSet to be searched for similar images. - # Format is: + # The resource name of a ProductSet to be searched for similar images. Format is: # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. # Corresponds to the JSON property `productSet` # @return [String] @@ -10070,8 +9515,8 @@ module Google include Google::Apis::Core::Hashable # Timestamp of the index which provided these results. Products added to the - # product set and products removed from the product set after this time are - # not reflected in the current results. + # product set and products removed from the product set after this time are not + # reflected in the current results. # Corresponds to the JSON property `indexTime` # @return [String] attr_accessor :index_time @@ -10107,35 +9552,33 @@ module Google class ProductSet include Google::Apis::Core::Hashable - # The user-provided name for this ProductSet. Must not be empty. Must be at - # most 4096 characters long. + # The user-provided name for this ProductSet. Must not be empty. Must be at most + # 4096 characters long. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # 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 `indexError` # @return [Google::Apis::VisionV1::Status] attr_accessor :index_error - # Output only. The time at which this ProductSet was last indexed. Query - # results will reflect all updates before this time. If this ProductSet has - # never been indexed, this timestamp is the default value - # "1970-01-01T00:00:00Z". - # This field is ignored when creating a ProductSet. + # Output only. The time at which this ProductSet was last indexed. Query results + # will reflect all updates before this time. If this ProductSet has never been + # indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This + # field is ignored when creating a ProductSet. # Corresponds to the JSON property `indexTime` # @return [String] attr_accessor :index_time - # The resource name of the ProductSet. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. - # This field is ignored when creating a ProductSet. + # The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a + # ProductSet. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -10157,9 +9600,9 @@ module Google class ProductSetPurgeConfig include Google::Apis::Core::Hashable - # The ProductSet that contains the Products to delete. If a Product is a - # member of product_set_id in addition to other ProductSets, the Product will - # still be deleted. + # The ProductSet that contains the Products to delete. If a Product is a member + # of product_set_id in addition to other ProductSets, the Product will still be + # deleted. # Corresponds to the JSON property `productSetId` # @return [String] attr_accessor :product_set_id @@ -10209,8 +9652,8 @@ module Google class PurgeProductsRequest include Google::Apis::Core::Hashable - # If delete_orphan_products is true, all Products that are not in any - # ProductSet will be deleted. + # If delete_orphan_products is true, all Products that are not in any ProductSet + # will be deleted. # Corresponds to the JSON property `deleteOrphanProducts` # @return [Boolean] attr_accessor :delete_orphan_products @@ -10246,28 +9689,24 @@ module Google include Google::Apis::Core::Hashable # Optional. Bounding polygons around the areas of interest in the reference - # image. - # If this field is empty, the system will try to detect regions of - # interest. At most 10 bounding polygons will be used. - # The provided shape is converted into a non-rotated rectangle. Once - # converted, the small edge of the rectangle must be greater than or equal - # to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 - # is not). + # image. If this field is empty, the system will try to detect regions of + # interest. At most 10 bounding polygons will be used. The provided shape is + # converted into a non-rotated rectangle. Once converted, the small edge of the + # rectangle must be greater than or equal to 300 pixels. The aspect ratio must + # be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). # Corresponds to the JSON property `boundingPolys` # @return [Array] attr_accessor :bounding_polys - # The resource name of the reference image. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ - # IMAGE_ID`. - # This field is ignored when creating a reference image. + # The resource name of the reference image. Format is: `projects/PROJECT_ID/ + # locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is + # ignored when creating a reference image. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The Google Cloud Storage URI of the reference image. - # The URI must start with `gs://`. + # Required. The Google Cloud Storage URI of the reference image. The URI must + # start with `gs://`. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -10289,8 +9728,7 @@ module Google include Google::Apis::Core::Hashable # Required. The resource name for the Product to be removed from this ProductSet. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + # Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` # Corresponds to the JSON property `product` # @return [String] attr_accessor :product @@ -10309,8 +9747,8 @@ module Google class Result include Google::Apis::Core::Hashable - # The resource name of the image from the product that is the closest match - # to the query. + # The resource name of the image from the product that is the closest match to + # the query. # Corresponds to the JSON property `image` # @return [String] attr_accessor :image @@ -10320,8 +9758,8 @@ module Google # @return [Google::Apis::VisionV1::Product] attr_accessor :product - # A confidence level on the match, ranging from 0 (no confidence) to - # 1 (full confidence). + # A confidence level on the match, ranging from 0 (no confidence) to 1 (full + # confidence). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -10338,15 +9776,14 @@ module Google end end - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). class SafeSearchAnnotation include Google::Apis::Core::Hashable # Represents the adult content likelihood for the image. Adult content may - # contain elements such as nudity, pornographic images or cartoons, or - # sexual activities. + # contain elements such as nudity, pornographic images or cartoons, or sexual + # activities. # Corresponds to the JSON property `adult` # @return [String] attr_accessor :adult @@ -10358,15 +9795,14 @@ module Google # Likelihood that the request image contains racy content. Racy content may # include (but is not limited to) skimpy or sheer clothing, strategically - # covered nudity, lewd or provocative poses, or close-ups of sensitive - # body areas. + # covered nudity, lewd or provocative poses, or close-ups of sensitive body + # areas. # Corresponds to the JSON property `racy` # @return [String] attr_accessor :racy - # Spoof likelihood. The likelihood that an modification - # was made to the image's canonical version to make it appear - # funny or offensive. + # Spoof likelihood. The likelihood that an modification was made to the image's + # canonical version to make it appear funny or offensive. # Corresponds to the JSON property `spoof` # @return [String] attr_accessor :spoof @@ -10390,12 +9826,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 @@ -10404,15 +9840,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 @@ -10466,13 +9902,12 @@ module Google end end - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. class TextAnnotation include Google::Apis::Core::Hashable @@ -10522,8 +9957,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the vertex coordinates are in the same scale as the original image. + # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are + # in the same scale as the original image. class Vertex include Google::Apis::Core::Hashable @@ -10552,14 +9987,14 @@ module Google class WebDetection include Google::Apis::Core::Hashable - # The service's best guess as to the topic of the request image. - # Inferred from similar images on the open web. + # The service's best guess as to the topic of the request image. Inferred from + # similar images on the open web. # Corresponds to the JSON property `bestGuessLabels` # @return [Array] attr_accessor :best_guess_labels - # Fully matching images from the Internet. - # Can include resized copies of the query image. + # Fully matching images from the Internet. Can include resized copies of the + # query image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -10569,9 +10004,9 @@ module Google # @return [Array] attr_accessor :pages_with_matching_images - # Partial matching images from the Internet. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its crops. + # Partial matching images from the Internet. Those images are similar enough to + # share some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -10635,8 +10070,8 @@ module Google # @return [String] attr_accessor :entity_id - # Overall relevancy score for the entity. - # Not normalized and not comparable across different image queries. + # Overall relevancy score for the entity. Not normalized and not comparable + # across different image queries. # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -10687,9 +10122,9 @@ module Google # @return [String] attr_accessor :label - # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - # For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more + # information, see http://www.unicode.org/reports/tr35/# + # Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -10709,8 +10144,8 @@ module Google class WebPage include Google::Apis::Core::Hashable - # Fully matching images on the page. - # Can include resized copies of the query image. + # Fully matching images on the page. Can include resized copies of the query + # image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -10720,10 +10155,9 @@ module Google # @return [String] attr_accessor :page_title - # Partial matching images on the page. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its - # crops. + # Partial matching images on the page. Those images are similar enough to share + # some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -10771,8 +10205,8 @@ module Google # @return [Google::Apis::VisionV1::TextProperty] attr_accessor :property - # List of symbols in the word. - # The order of the symbols follows the natural reading order. + # List of symbols in the word. The order of the symbols follows the natural + # reading order. # Corresponds to the JSON property `symbols` # @return [Array] attr_accessor :symbols diff --git a/generated/google/apis/vision_v1/service.rb b/generated/google/apis/vision_v1/service.rb index 889418802..065fcf7d9 100644 --- a/generated/google/apis/vision_v1/service.rb +++ b/generated/google/apis/vision_v1/service.rb @@ -49,12 +49,11 @@ module Google @batch_path = 'batch' end - # Service that performs image detection and annotation for a batch of files. - # Now only "application/pdf", "image/tiff" and "image/gif" are supported. - # This service will extract at most 5 (customers can specify which 5 in - # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each - # file provided and perform detection and annotation for each image - # extracted. + # Service that performs image detection and annotation for a batch of files. Now + # only "application/pdf", "image/tiff" and "image/gif" are supported. This + # service will extract at most 5 (customers can specify which 5 in + # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file + # provided and perform detection and annotation for each image extracted. # @param [Google::Apis::VisionV1::BatchAnnotateFilesRequest] batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -84,12 +83,12 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of generic - # files, such as PDF files, which may contain multiple pages and multiple - # images per page. Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). + # Run asynchronous image detection and annotation for a list of generic files, + # such as PDF files, which may contain multiple pages and multiple images per + # page. Progress and results can be retrieved through the `google.longrunning. + # Operations` interface. `Operation.metadata` contains `OperationMetadata` ( + # metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` ( + # results). # @param [Google::Apis::VisionV1::AsyncBatchAnnotateFilesRequest] async_batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -149,13 +148,12 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of images. - # Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). - # This service will write image annotation outputs to json files in customer - # GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + # Run asynchronous image detection and annotation for a list of images. Progress + # and results can be retrieved through the `google.longrunning.Operations` + # interface. `Operation.metadata` contains `OperationMetadata` (metadata). ` + # Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). + # This service will write image annotation outputs to json files in customer GCS + # bucket, each json file containing BatchAnnotateImagesResponse proto. # @param [Google::Apis::VisionV1::AsyncBatchAnnotateImagesRequest] async_batch_annotate_images_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -185,9 +183,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 @@ -217,15 +214,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. @@ -259,10 +254,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 @@ -292,9 +287,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 @@ -324,15 +318,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 @@ -371,21 +364,17 @@ module Google execute_or_queue_command(command, &block) end - # Service that performs image detection and annotation for a batch of files. - # Now only "application/pdf", "image/tiff" and "image/gif" are supported. - # This service will extract at most 5 (customers can specify which 5 in - # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each - # file provided and perform detection and annotation for each image - # extracted. + # Service that performs image detection and annotation for a batch of files. Now + # only "application/pdf", "image/tiff" and "image/gif" are supported. This + # service will extract at most 5 (customers can specify which 5 in + # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file + # provided and perform detection and annotation for each image extracted. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1::BatchAnnotateFilesRequest] batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -416,21 +405,18 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of generic - # files, such as PDF files, which may contain multiple pages and multiple - # images per page. Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). + # Run asynchronous image detection and annotation for a list of generic files, + # such as PDF files, which may contain multiple pages and multiple images per + # page. Progress and results can be retrieved through the `google.longrunning. + # Operations` interface. `Operation.metadata` contains `OperationMetadata` ( + # metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` ( + # results). # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1::AsyncBatchAnnotateFilesRequest] async_batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -463,14 +449,11 @@ module Google # Run image detection and annotation for a batch of images. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1::BatchAnnotateImagesRequest] batch_annotate_images_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -501,22 +484,18 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of images. - # Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). - # This service will write image annotation outputs to json files in customer - # GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + # Run asynchronous image detection and annotation for a list of images. Progress + # and results can be retrieved through the `google.longrunning.Operations` + # interface. `Operation.metadata` contains `OperationMetadata` (metadata). ` + # Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). + # This service will write image annotation outputs to json files in customer GCS + # bucket, each json file containing BatchAnnotateImagesResponse proto. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1::AsyncBatchAnnotateImagesRequest] async_batch_annotate_images_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -547,21 +526,17 @@ module Google execute_or_queue_command(command, &block) end - # Service that performs image detection and annotation for a batch of files. - # Now only "application/pdf", "image/tiff" and "image/gif" are supported. - # This service will extract at most 5 (customers can specify which 5 in - # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each - # file provided and perform detection and annotation for each image - # extracted. + # Service that performs image detection and annotation for a batch of files. Now + # only "application/pdf", "image/tiff" and "image/gif" are supported. This + # service will extract at most 5 (customers can specify which 5 in + # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file + # provided and perform detection and annotation for each image extracted. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1::BatchAnnotateFilesRequest] batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -592,21 +567,18 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of generic - # files, such as PDF files, which may contain multiple pages and multiple - # images per page. Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). + # Run asynchronous image detection and annotation for a list of generic files, + # such as PDF files, which may contain multiple pages and multiple images per + # page. Progress and results can be retrieved through the `google.longrunning. + # Operations` interface. `Operation.metadata` contains `OperationMetadata` ( + # metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` ( + # results). # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1::AsyncBatchAnnotateFilesRequest] async_batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -639,14 +611,11 @@ module Google # Run image detection and annotation for a batch of images. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1::BatchAnnotateImagesRequest] batch_annotate_images_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -677,22 +646,18 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of images. - # Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). - # This service will write image annotation outputs to json files in customer - # GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + # Run asynchronous image detection and annotation for a list of images. Progress + # and results can be retrieved through the `google.longrunning.Operations` + # interface. `Operation.metadata` contains `OperationMetadata` (metadata). ` + # Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). + # This service will write image annotation outputs to json files in customer GCS + # bucket, each json file containing BatchAnnotateImagesResponse proto. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1::AsyncBatchAnnotateImagesRequest] async_batch_annotate_images_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -723,9 +688,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 @@ -755,15 +719,13 @@ module Google execute_or_queue_command(command, &block) end - # Adds a Product to the specified ProductSet. If the Product is already - # present, no change is made. - # One Product can be added to at most 100 ProductSets. - # Possible errors: - # * Returns NOT_FOUND if the Product or the ProductSet doesn't exist. + # Adds a Product to the specified ProductSet. If the Product is already present, + # no change is made. One Product can be added to at most 100 ProductSets. + # Possible errors: * Returns NOT_FOUND if the Product or the ProductSet doesn't + # exist. # @param [String] name - # Required. The resource name for the ProductSet to modify. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + # Required. The resource name for the ProductSet to modify. Format is: `projects/ + # PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` # @param [Google::Apis::VisionV1::AddProductToProductSetRequest] add_product_to_product_set_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -794,13 +756,11 @@ module Google execute_or_queue_command(command, &block) end - # Creates and returns a new ProductSet resource. - # Possible errors: - # * Returns INVALID_ARGUMENT if display_name is missing, or is longer than - # 4096 characters. + # Creates and returns a new ProductSet resource. Possible errors: * Returns + # INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters. # @param [String] parent - # Required. The project in which the ProductSet should be created. - # Format is `projects/PROJECT_ID/locations/LOC_ID`. + # Required. The project in which the ProductSet should be created. Format is ` + # projects/PROJECT_ID/locations/LOC_ID`. # @param [Google::Apis::VisionV1::ProductSet] product_set_object # @param [String] product_set_id # A user-supplied resource id for this ProductSet. If set, the server will @@ -838,12 +798,11 @@ module Google end # Permanently deletes a ProductSet. Products and ReferenceImages in the - # ProductSet are not deleted. - # The actual image files are not deleted from Google Cloud Storage. + # ProductSet are not deleted. The actual image files are not deleted from Google + # Cloud Storage. # @param [String] name - # Required. Resource name of the ProductSet to delete. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + # Required. Resource name of the ProductSet to delete. Format is: `projects/ + # PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -871,13 +830,11 @@ module Google execute_or_queue_command(command, &block) end - # Gets information associated with a ProductSet. - # Possible errors: - # * Returns NOT_FOUND if the ProductSet does not exist. + # Gets information associated with a ProductSet. Possible errors: * Returns + # NOT_FOUND if the ProductSet does not exist. # @param [String] name - # Required. Resource name of the ProductSet to get. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + # Required. Resource name of the ProductSet to get. Format is: `projects/ + # PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -905,18 +862,16 @@ module Google execute_or_queue_command(command, &block) end - # Asynchronous API that imports a list of reference images to specified - # product sets based on a list of image information. - # The google.longrunning.Operation API can be used to keep track of the - # progress and results of the request. - # `Operation.metadata` contains `BatchOperationMetadata`. (progress) - # `Operation.response` contains `ImportProductSetsResponse`. (results) - # The input source of this method is a csv file on Google Cloud Storage. - # For the format of the csv file please see - # ImportProductSetsGcsSource.csv_file_uri. + # Asynchronous API that imports a list of reference images to specified product + # sets based on a list of image information. The google.longrunning.Operation + # API can be used to keep track of the progress and results of the request. ` + # Operation.metadata` contains `BatchOperationMetadata`. (progress) `Operation. + # response` contains `ImportProductSetsResponse`. (results) The input source of + # this method is a csv file on Google Cloud Storage. For the format of the csv + # file please see ImportProductSetsGcsSource.csv_file_uri. # @param [String] parent - # Required. The project in which the ProductSets should be imported. - # Format is `projects/PROJECT_ID/locations/LOC_ID`. + # Required. The project in which the ProductSets should be imported. Format is ` + # projects/PROJECT_ID/locations/LOC_ID`. # @param [Google::Apis::VisionV1::ImportProductSetsRequest] import_product_sets_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -947,13 +902,11 @@ module Google execute_or_queue_command(command, &block) end - # Lists ProductSets in an unspecified order. - # Possible errors: - # * Returns INVALID_ARGUMENT if page_size is greater than 100, or less - # than 1. + # Lists ProductSets in an unspecified order. Possible errors: * Returns + # INVALID_ARGUMENT if page_size is greater than 100, or less than 1. # @param [String] parent - # Required. The project from which ProductSets should be listed. - # Format is `projects/PROJECT_ID/locations/LOC_ID`. + # Required. The project from which ProductSets should be listed. Format is ` + # projects/PROJECT_ID/locations/LOC_ID`. # @param [Fixnum] page_size # The maximum number of items to return. Default 10, maximum 100. # @param [String] page_token @@ -987,23 +940,19 @@ module Google execute_or_queue_command(command, &block) end - # Makes changes to a ProductSet resource. - # Only display_name can be updated currently. - # Possible errors: - # * Returns NOT_FOUND if the ProductSet does not exist. - # * Returns INVALID_ARGUMENT if display_name is present in update_mask but - # missing from the request or longer than 4096 characters. + # Makes changes to a ProductSet resource. Only display_name can be updated + # currently. Possible errors: * Returns NOT_FOUND if the ProductSet does not + # exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask + # but missing from the request or longer than 4096 characters. # @param [String] name - # The resource name of the ProductSet. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. - # This field is ignored when creating a ProductSet. + # The resource name of the ProductSet. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a + # ProductSet. # @param [Google::Apis::VisionV1::ProductSet] product_set_object # @param [String] update_mask - # The FieldMask that specifies which fields to - # update. - # If update_mask isn't specified, all mutable fields are to be updated. - # Valid mask path is `display_name`. + # The FieldMask that specifies which fields to update. If update_mask isn't + # specified, all mutable fields are to be updated. Valid mask path is ` + # display_name`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1036,9 +985,8 @@ module Google # Removes a Product from the specified ProductSet. # @param [String] name - # Required. The resource name for the ProductSet to modify. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + # Required. The resource name for the ProductSet to modify. Format is: `projects/ + # PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` # @param [Google::Apis::VisionV1::RemoveProductFromProductSetRequest] remove_product_from_product_set_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1069,15 +1017,13 @@ module Google execute_or_queue_command(command, &block) end - # Lists the Products in a ProductSet, in an unspecified order. If the - # ProductSet does not exist, the products field of the response will be - # empty. - # Possible errors: - # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. + # Lists the Products in a ProductSet, in an unspecified order. If the ProductSet + # does not exist, the products field of the response will be empty. Possible + # errors: * Returns INVALID_ARGUMENT if page_size is greater than 100 or less + # than 1. # @param [String] name - # Required. The ProductSet resource for which to retrieve Products. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` + # Required. The ProductSet resource for which to retrieve Products. Format is: ` + # projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID` # @param [Fixnum] page_size # The maximum number of items to return. Default 10, maximum 100. # @param [String] page_token @@ -1111,22 +1057,19 @@ module Google execute_or_queue_command(command, &block) end - # Creates and returns a new product resource. - # Possible errors: - # * Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 - # characters. - # * Returns INVALID_ARGUMENT if description is longer than 4096 characters. - # * Returns INVALID_ARGUMENT if product_category is missing or invalid. + # Creates and returns a new product resource. Possible errors: * Returns + # INVALID_ARGUMENT if display_name is missing or longer than 4096 characters. * + # Returns INVALID_ARGUMENT if description is longer than 4096 characters. * + # Returns INVALID_ARGUMENT if product_category is missing or invalid. # @param [String] parent - # Required. The project in which the Product should be created. - # Format is - # `projects/PROJECT_ID/locations/LOC_ID`. + # Required. The project in which the Product should be created. Format is ` + # projects/PROJECT_ID/locations/LOC_ID`. # @param [Google::Apis::VisionV1::Product] product_object # @param [String] product_id - # A user-supplied resource id for this Product. If set, the server will - # attempt to use this value as the resource id. If it is already in use, an - # error is returned with code ALREADY_EXISTS. Must be at most 128 characters - # long. It cannot contain the character `/`. + # A user-supplied resource id for this Product. If set, the server will attempt + # to use this value as the resource id. If it is already in use, an error is + # returned with code ALREADY_EXISTS. Must be at most 128 characters long. It + # cannot contain the character `/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1157,14 +1100,13 @@ module Google execute_or_queue_command(command, &block) end - # Permanently deletes a product and its reference images. - # Metadata of the product and all its images will be deleted right away, but - # search queries against ProductSets containing the product may still work - # until all related caches are refreshed. + # Permanently deletes a product and its reference images. Metadata of the + # product and all its images will be deleted right away, but search queries + # against ProductSets containing the product may still work until all related + # caches are refreshed. # @param [String] name - # Required. Resource name of product to delete. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + # Required. Resource name of product to delete. Format is: `projects/PROJECT_ID/ + # locations/LOC_ID/products/PRODUCT_ID` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1192,13 +1134,11 @@ module Google execute_or_queue_command(command, &block) end - # Gets information associated with a Product. - # Possible errors: - # * Returns NOT_FOUND if the Product does not exist. + # Gets information associated with a Product. Possible errors: * Returns + # NOT_FOUND if the Product does not exist. # @param [String] name - # Required. Resource name of the Product to get. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID` + # Required. Resource name of the Product to get. Format is: `projects/PROJECT_ID/ + # locations/LOC_ID/products/PRODUCT_ID` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1226,13 +1166,11 @@ module Google execute_or_queue_command(command, &block) end - # Lists products in an unspecified order. - # Possible errors: - # * Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1. + # Lists products in an unspecified order. Possible errors: * Returns + # INVALID_ARGUMENT if page_size is greater than 100 or less than 1. # @param [String] parent # Required. The project OR ProductSet from which Products should be listed. - # Format: - # `projects/PROJECT_ID/locations/LOC_ID` + # Format: `projects/PROJECT_ID/locations/LOC_ID` # @param [Fixnum] page_size # The maximum number of items to return. Default 10, maximum 100. # @param [String] page_token @@ -1266,30 +1204,22 @@ module Google execute_or_queue_command(command, &block) end - # Makes changes to a Product resource. - # Only the `display_name`, `description`, and `labels` fields can be updated - # right now. - # If labels are updated, the change will not be reflected in queries until - # the next index time. - # Possible errors: - # * Returns NOT_FOUND if the Product does not exist. - # * Returns INVALID_ARGUMENT if display_name is present in update_mask but is - # missing from the request or longer than 4096 characters. - # * Returns INVALID_ARGUMENT if description is present in update_mask but is - # longer than 4096 characters. - # * Returns INVALID_ARGUMENT if product_category is present in update_mask. + # Makes changes to a Product resource. Only the `display_name`, `description`, + # and `labels` fields can be updated right now. If labels are updated, the + # change will not be reflected in queries until the next index time. Possible + # errors: * Returns NOT_FOUND if the Product does not exist. * Returns + # INVALID_ARGUMENT if display_name is present in update_mask but is missing from + # the request or longer than 4096 characters. * Returns INVALID_ARGUMENT if + # description is present in update_mask but is longer than 4096 characters. * + # Returns INVALID_ARGUMENT if product_category is present in update_mask. # @param [String] name - # The resource name of the product. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - # This field is ignored when creating a product. + # The resource name of the product. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. # @param [Google::Apis::VisionV1::Product] product_object # @param [String] update_mask - # The FieldMask that specifies which fields - # to update. - # If update_mask isn't specified, all mutable fields are to be updated. - # Valid mask paths include `product_labels`, `display_name`, and - # `description`. + # The FieldMask that specifies which fields to update. If update_mask isn't + # specified, all mutable fields are to be updated. Valid mask paths include ` + # product_labels`, `display_name`, and `description`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1320,25 +1250,22 @@ module Google execute_or_queue_command(command, &block) end - # Asynchronous API to delete all Products in a ProductSet or all Products - # that are in no ProductSet. - # If a Product is a member of the specified ProductSet in addition to other - # ProductSets, the Product will still be deleted. - # It is recommended to not delete the specified ProductSet until after this - # operation has completed. It is also recommended to not add any of the - # Products involved in the batch delete to a new ProductSet while this - # operation is running because those Products may still end up deleted. - # It's not possible to undo the PurgeProducts operation. Therefore, it is - # recommended to keep the csv files used in ImportProductSets (if that was - # how you originally built the Product Set) before starting PurgeProducts, in - # case you need to re-import the data after deletion. - # If the plan is to purge all of the Products from a ProductSet and then - # re-use the empty ProductSet to re-import new Products into the empty - # ProductSet, you must wait until the PurgeProducts operation has finished - # for that ProductSet. - # The google.longrunning.Operation API can be used to keep track of the - # progress and results of the request. - # `Operation.metadata` contains `BatchOperationMetadata`. (progress) + # Asynchronous API to delete all Products in a ProductSet or all Products that + # are in no ProductSet. If a Product is a member of the specified ProductSet in + # addition to other ProductSets, the Product will still be deleted. It is + # recommended to not delete the specified ProductSet until after this operation + # has completed. It is also recommended to not add any of the Products involved + # in the batch delete to a new ProductSet while this operation is running + # because those Products may still end up deleted. It's not possible to undo the + # PurgeProducts operation. Therefore, it is recommended to keep the csv files + # used in ImportProductSets (if that was how you originally built the Product + # Set) before starting PurgeProducts, in case you need to re-import the data + # after deletion. If the plan is to purge all of the Products from a ProductSet + # and then re-use the empty ProductSet to re-import new Products into the empty + # ProductSet, you must wait until the PurgeProducts operation has finished for + # that ProductSet. The google.longrunning.Operation API can be used to keep + # track of the progress and results of the request. `Operation.metadata` + # contains `BatchOperationMetadata`. (progress) # @param [String] parent # Required. The project and location in which the Products should be deleted. # Format is `projects/PROJECT_ID/locations/LOC_ID`. @@ -1372,31 +1299,27 @@ module Google execute_or_queue_command(command, &block) end - # Creates and returns a new ReferenceImage resource. - # The `bounding_poly` field is optional. If `bounding_poly` is not specified, - # the system will try to detect regions of interest in the image that are - # compatible with the product_category on the parent product. If it is - # specified, detection is ALWAYS skipped. The system converts polygons into - # non-rotated rectangles. - # Note that the pipeline will resize the image if the image resolution is too - # large to process (above 50MP). - # Possible errors: - # * Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 - # characters. - # * Returns INVALID_ARGUMENT if the product does not exist. - # * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing - # compatible with the parent product's product_category is detected. - # * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons. + # Creates and returns a new ReferenceImage resource. The `bounding_poly` field + # is optional. If `bounding_poly` is not specified, the system will try to + # detect regions of interest in the image that are compatible with the + # product_category on the parent product. If it is specified, detection is + # ALWAYS skipped. The system converts polygons into non-rotated rectangles. Note + # that the pipeline will resize the image if the image resolution is too large + # to process (above 50MP). Possible errors: * Returns INVALID_ARGUMENT if the + # image_uri is missing or longer than 4096 characters. * Returns + # INVALID_ARGUMENT if the product does not exist. * Returns INVALID_ARGUMENT if + # bounding_poly is not provided, and nothing compatible with the parent product' + # s product_category is detected. * Returns INVALID_ARGUMENT if bounding_poly + # contains more than 10 polygons. # @param [String] parent # Required. Resource name of the product in which to create the reference image. - # Format is - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + # Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. # @param [Google::Apis::VisionV1::ReferenceImage] reference_image_object # @param [String] reference_image_id - # A user-supplied resource id for the ReferenceImage to be added. If set, - # the server will attempt to use this value as the resource id. If it is - # already in use, an error is returned with code ALREADY_EXISTS. Must be at - # most 128 characters long. It cannot contain the character `/`. + # A user-supplied resource id for the ReferenceImage to be added. If set, the + # server will attempt to use this value as the resource id. If it is already in + # use, an error is returned with code ALREADY_EXISTS. Must be at most 128 + # characters long. It cannot contain the character `/`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1427,15 +1350,13 @@ module Google execute_or_queue_command(command, &block) end - # Permanently deletes a reference image. - # The image metadata will be deleted right away, but search queries - # against ProductSets containing the image may still work until all related - # caches are refreshed. - # The actual image files are not deleted from Google Cloud Storage. + # Permanently deletes a reference image. The image metadata will be deleted + # right away, but search queries against ProductSets containing the image may + # still work until all related caches are refreshed. The actual image files are + # not deleted from Google Cloud Storage. # @param [String] name - # Required. The resource name of the reference image to delete. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ + # Required. The resource name of the reference image to delete. Format is: ` + # projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ # IMAGE_ID` # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1464,14 +1385,11 @@ module Google execute_or_queue_command(command, &block) end - # Gets information associated with a ReferenceImage. - # Possible errors: - # * Returns NOT_FOUND if the specified image does not exist. + # Gets information associated with a ReferenceImage. Possible errors: * Returns + # NOT_FOUND if the specified image does not exist. # @param [String] name - # Required. The resource name of the ReferenceImage to get. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ - # IMAGE_ID`. + # Required. The resource name of the ReferenceImage to get. Format is: `projects/ + # PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1499,21 +1417,18 @@ module Google execute_or_queue_command(command, &block) end - # Lists reference images. - # Possible errors: - # * Returns NOT_FOUND if the parent product does not exist. - # * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less - # than 1. + # Lists reference images. Possible errors: * Returns NOT_FOUND if the parent + # product does not exist. * Returns INVALID_ARGUMENT if the page_size is greater + # than 100, or less than 1. # @param [String] parent - # Required. Resource name of the product containing the reference images. - # Format is - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. + # Required. Resource name of the product containing the reference images. Format + # is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. # @param [Fixnum] page_size # The maximum number of items to return. Default 10, maximum 100. # @param [String] page_token - # A token identifying a page of results to be returned. This is the value - # of `nextPageToken` returned in a previous reference image list request. - # Defaults to the first page if not specified. + # A token identifying a page of results to be returned. This is the value of ` + # nextPageToken` returned in a previous reference image list request. Defaults + # to the first page if not specified. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -1543,9 +1458,8 @@ module Google execute_or_queue_command(command, &block) end - # Gets the latest state of a long-running operation. Clients can use this - # method to poll the operation result at intervals as recommended by the API - # service. + # Gets the latest state of a long-running operation. Clients can use this method + # to poll the operation result at intervals as recommended by the API service. # @param [String] name # The name of the operation resource. # @param [String] fields diff --git a/generated/google/apis/vision_v1p1beta1.rb b/generated/google/apis/vision_v1p1beta1.rb index 8f20cfd2e..48ae5b171 100644 --- a/generated/google/apis/vision_v1p1beta1.rb +++ b/generated/google/apis/vision_v1p1beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/vision/ module VisionV1p1beta1 VERSION = 'V1p1beta1' - REVISION = '20200710' + 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/vision_v1p1beta1/classes.rb b/generated/google/apis/vision_v1p1beta1/classes.rb index 6084990a4..14db098f8 100644 --- a/generated/google/apis/vision_v1p1beta1/classes.rb +++ b/generated/google/apis/vision_v1p1beta1/classes.rb @@ -27,12 +27,12 @@ module Google class AnnotateFileResponse 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::VisionV1p1beta1::Status] attr_accessor :error @@ -42,8 +42,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::InputConfig] attr_accessor :input_config - # Individual responses to images found within the file. This field will be - # empty if the `error` field is set. + # Individual responses to images found within the file. This field will be empty + # if the `error` field is set. # Corresponds to the JSON property `responses` # @return [Array] attr_accessor :responses @@ -81,12 +81,12 @@ module Google # @return [Google::Apis::VisionV1p1beta1::CropHintsAnnotation] attr_accessor :crop_hints_annotation - # 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::VisionV1p1beta1::Status] attr_accessor :error @@ -96,13 +96,12 @@ module Google # @return [Array] attr_accessor :face_annotations - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. # Corresponds to the JSON property `fullTextAnnotation` # @return [Google::Apis::VisionV1p1beta1::TextAnnotation] attr_accessor :full_text_annotation @@ -122,8 +121,8 @@ module Google # @return [Array] attr_accessor :landmark_annotations - # If present, localized object detection has completed successfully. - # This will be sorted descending by confidence score. + # If present, localized object detection has completed successfully. This will + # be sorted descending by confidence score. # Corresponds to the JSON property `localizedObjectAnnotations` # @return [Array] attr_accessor :localized_object_annotations @@ -138,9 +137,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::ProductSearchResults] attr_accessor :product_search_results - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). # Corresponds to the JSON property `safeSearchAnnotation` # @return [Google::Apis::VisionV1p1beta1::SafeSearchAnnotation] attr_accessor :safe_search_annotation @@ -256,14 +254,14 @@ module Google end end - # Metadata for the batch operations such as the current state. - # This is included in the `metadata` field of the `Operation` returned by the - # `GetOperation` call of the `google::longrunning::Operations` service. + # Metadata for the batch operations such as the current state. This is included + # in the `metadata` field of the `Operation` returned by the `GetOperation` call + # of the `google::longrunning::Operations` service. class BatchOperationMetadata include Google::Apis::Core::Hashable - # The time when the batch request is finished and - # google.longrunning.Operation.done is set to true. + # The time when the batch request is finished and google.longrunning.Operation. + # done is set to true. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -360,122 +358,61 @@ module Google # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... class Color include Google::Apis::Core::Hashable - # The fraction of this color that should be applied to the pixel. That is, - # the final pixel color is defined by the equation: - # pixel color = alpha * (this color) + (1.0 - alpha) * (background color) - # This means that a value of 1.0 corresponds to a solid color, whereas - # a value of 0.0 corresponds to a completely transparent color. This - # uses a wrapper message rather than a simple float scalar so that it is - # possible to distinguish between a default value and the value being unset. - # If omitted, this color object is to be rendered as a solid color - # (as if the alpha value had been explicitly given with a value of 1.0). + # The fraction of this color that should be applied to the pixel. That is, the + # final pixel color is defined by the equation: pixel color = alpha * (this + # color) + (1.0 - alpha) * (background color) This means that a value of 1.0 + # corresponds to a solid color, whereas a value of 0.0 corresponds to a + # completely transparent color. This uses a wrapper message rather than a simple + # float scalar so that it is possible to distinguish between a default value and + # the value being unset. If omitted, this color object is to be rendered as a + # solid color (as if the alpha value had been explicitly given with a value of 1. + # 0). # Corresponds to the JSON property `alpha` # @return [Float] attr_accessor :alpha @@ -508,123 +445,61 @@ module Google end end - # Color information consists of RGB channels, score, and the fraction of - # the image that the color occupies in the image. + # Color information consists of RGB channels, score, and the fraction of the + # image that the color occupies in the image. class ColorInfo include Google::Apis::Core::Hashable # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... # Corresponds to the JSON property `color` # @return [Google::Apis::VisionV1p1beta1::Color] attr_accessor :color - # The fraction of pixels the color occupies in the image. - # Value in range [0, 1]. + # The fraction of pixels the color occupies in the image. Value in range [0, 1]. # Corresponds to the JSON property `pixelFraction` # @return [Float] attr_accessor :pixel_fraction @@ -655,7 +530,7 @@ module Google # @return [Google::Apis::VisionV1p1beta1::BoundingPoly] attr_accessor :bounding_poly - # Confidence of this being a salient region. Range [0, 1]. + # Confidence of this being a salient region. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -732,9 +607,8 @@ module Google # @return [Float] attr_accessor :confidence - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -778,11 +652,10 @@ module Google # @return [Google::Apis::VisionV1p1beta1::BoundingPoly] attr_accessor :bounding_poly - # **Deprecated. Use `score` instead.** - # The accuracy of the entity detection in an image. - # For example, for an image in which the "Eiffel Tower" entity is detected, - # this field represents the confidence that there is a tower in the query - # image. Range [0, 1]. + # **Deprecated. Use `score` instead.** The accuracy of the entity detection in + # an image. For example, for an image in which the "Eiffel Tower" entity is + # detected, this field represents the confidence that there is a tower in the + # query image. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -792,30 +665,29 @@ module Google # @return [String] attr_accessor :description - # The language code for the locale in which the entity textual - # `description` is expressed. + # The language code for the locale in which the entity textual `description` is + # expressed. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale - # The location information for the detected entity. Multiple - # `LocationInfo` elements can be present because one location may - # indicate the location of the scene in the image, and another location - # may indicate the location of the place where the image was taken. - # Location information is usually present for landmarks. + # The location information for the detected entity. Multiple `LocationInfo` + # elements can be present because one location may indicate the location of the + # scene in the image, and another location may indicate the location of the + # place where the image was taken. Location information is usually present for + # landmarks. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `mid` # @return [String] attr_accessor :mid - # Some entities may have optional user-supplied `Property` (name/value) - # fields, such a score or string that qualifies the entity. + # Some entities may have optional user-supplied `Property` (name/value) fields, + # such a score or string that qualifies the entity. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -825,11 +697,11 @@ module Google # @return [Float] attr_accessor :score - # The relevancy of the ICA (Image Content Annotation) label to the - # image. For example, the relevancy of "tower" is likely higher to an image - # containing the detected "Eiffel Tower" than to an image containing a - # detected distant towering building, even though the confidence that - # there is a tower in each image may be the same. Range [0, 1]. + # The relevancy of the ICA (Image Content Annotation) label to the image. For + # example, the relevancy of "tower" is likely higher to an image containing the + # detected "Eiffel Tower" than to an image containing a detected distant + # towering building, even though the confidence that there is a tower in each + # image may be the same. Range [0, 1]. # Corresponds to the JSON property `topicality` # @return [Float] attr_accessor :topicality @@ -902,15 +774,15 @@ module Google attr_accessor :landmarks # Yaw angle, which indicates the leftward/rightward angle that the face is - # pointing relative to the vertical plane perpendicular to the image. Range - # [-180,180]. + # pointing relative to the vertical plane perpendicular to the image. Range [- + # 180,180]. # Corresponds to the JSON property `panAngle` # @return [Float] attr_accessor :pan_angle - # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation - # of the face relative to the image vertical about the axis perpendicular to - # the face. Range [-180,180]. + # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of + # the face relative to the image vertical about the axis perpendicular to the + # face. Range [-180,180]. # Corresponds to the JSON property `rollAngle` # @return [Float] attr_accessor :roll_angle @@ -964,24 +836,20 @@ module Google class GcsDestination include Google::Apis::Core::Hashable - # Google Cloud Storage URI prefix where the results will be stored. Results - # will be in JSON format and preceded by its corresponding input URI prefix. - # This field can either represent a gcs file prefix or gcs directory. In - # either case, the uri should be unique because in order to get all of the - # output files, you will need to do a wildcard gcs search on the uri prefix - # you provide. - # Examples: - # * File Prefix: gs://bucket-name/here/filenameprefix The output files - # will be created in gs://bucket-name/here/ and the names of the - # output files will begin with "filenameprefix". - # * Directory Prefix: gs://bucket-name/some/location/ The output files - # will be created in gs://bucket-name/some/location/ and the names of the - # output files could be anything because there was no filename prefix - # specified. - # If multiple outputs, each response is still AnnotateFileResponse, each of - # which contains some subset of the full list of AnnotateImageResponse. - # Multiple outputs can happen if, for example, the output JSON is too large - # and overflows into multiple sharded files. + # Google Cloud Storage URI prefix where the results will be stored. Results will + # be in JSON format and preceded by its corresponding input URI prefix. This + # field can either represent a gcs file prefix or gcs directory. In either case, + # the uri should be unique because in order to get all of the output files, you + # will need to do a wildcard gcs search on the uri prefix you provide. Examples: + # * File Prefix: gs://bucket-name/here/filenameprefix The output files will be + # created in gs://bucket-name/here/ and the names of the output files will begin + # with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The + # output files will be created in gs://bucket-name/some/location/ and the names + # of the output files could be anything because there was no filename prefix + # specified. If multiple outputs, each response is still AnnotateFileResponse, + # each of which contains some subset of the full list of AnnotateImageResponse. + # Multiple outputs can happen if, for example, the output JSON is too large and + # overflows into multiple sharded files. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -1000,8 +868,8 @@ module Google class GcsSource include Google::Apis::Core::Hashable - # Google Cloud Storage URI for the input file. This must only be a - # Google Cloud Storage object. Wildcards are not currently supported. + # Google Cloud Storage URI for the input file. This must only be a Google Cloud + # Storage object. Wildcards are not currently supported. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -1035,16 +903,13 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1InputConfig] attr_accessor :input_config - # Pages of the file to perform image annotation. - # Pages starts from 1, we assume the first page of the file is page 1. - # At most 5 pages are supported per request. Pages can be negative. - # Page 1 means the first page. - # Page 2 means the second page. - # Page -1 means the last page. - # Page -2 means the second to the last page. - # If the file is GIF instead of PDF or TIFF, page refers to GIF frames. - # If this field is empty, by default the service performs image annotation - # for the first 5 pages of the file. + # Pages of the file to perform image annotation. Pages starts from 1, we assume + # the first page of the file is page 1. At most 5 pages are supported per + # request. Pages can be negative. Page 1 means the first page. Page 2 means the + # second page. Page -1 means the last page. Page -2 means the second to the last + # page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If + # this field is empty, by default the service performs image annotation for the + # first 5 pages of the file. # Corresponds to the JSON property `pages` # @return [Array] attr_accessor :pages @@ -1067,12 +932,12 @@ module Google class GoogleCloudVisionV1p1beta1AnnotateFileResponse 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::VisionV1p1beta1::Status] attr_accessor :error @@ -1082,8 +947,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1InputConfig] attr_accessor :input_config - # Individual responses to images found within the file. This field will be - # empty if the `error` field is set. + # Individual responses to images found within the file. This field will be empty + # if the `error` field is set. # Corresponds to the JSON property `responses` # @return [Array] attr_accessor :responses @@ -1153,12 +1018,12 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1CropHintsAnnotation] attr_accessor :crop_hints_annotation - # 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::VisionV1p1beta1::Status] attr_accessor :error @@ -1168,13 +1033,12 @@ module Google # @return [Array] attr_accessor :face_annotations - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. # Corresponds to the JSON property `fullTextAnnotation` # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotation] attr_accessor :full_text_annotation @@ -1194,8 +1058,8 @@ module Google # @return [Array] attr_accessor :landmark_annotations - # If present, localized object detection has completed successfully. - # This will be sorted descending by confidence score. + # If present, localized object detection has completed successfully. This will + # be sorted descending by confidence score. # Corresponds to the JSON property `localizedObjectAnnotations` # @return [Array] attr_accessor :localized_object_annotations @@ -1210,9 +1074,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1ProductSearchResults] attr_accessor :product_search_results - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). # Corresponds to the JSON property `safeSearchAnnotation` # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1SafeSearchAnnotation] attr_accessor :safe_search_annotation @@ -1306,19 +1169,15 @@ module Google end end - # Multiple async file annotation requests are batched into a single service - # call. + # Multiple async file annotation requests are batched into a single service call. class GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest include Google::Apis::Core::Hashable - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -1368,14 +1227,11 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1OutputConfig] attr_accessor :output_config - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -1401,14 +1257,11 @@ module Google class GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest include Google::Apis::Core::Hashable - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -1454,14 +1307,11 @@ module Google class GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest include Google::Apis::Core::Hashable - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -1569,123 +1419,61 @@ module Google end end - # Color information consists of RGB channels, score, and the fraction of - # the image that the color occupies in the image. + # Color information consists of RGB channels, score, and the fraction of the + # image that the color occupies in the image. class GoogleCloudVisionV1p1beta1ColorInfo include Google::Apis::Core::Hashable # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... # Corresponds to the JSON property `color` # @return [Google::Apis::VisionV1p1beta1::Color] attr_accessor :color - # The fraction of pixels the color occupies in the image. - # Value in range [0, 1]. + # The fraction of pixels the color occupies in the image. Value in range [0, 1]. # Corresponds to the JSON property `pixelFraction` # @return [Float] attr_accessor :pixel_fraction @@ -1716,7 +1504,7 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly] attr_accessor :bounding_poly - # Confidence of this being a salient region. Range [0, 1]. + # Confidence of this being a salient region. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -1762,12 +1550,11 @@ module Google class GoogleCloudVisionV1p1beta1CropHintsParams include Google::Apis::Core::Hashable - # Aspect ratios in floats, representing the ratio of the width to the height - # of the image. For example, if the desired aspect ratio is 4/3, the - # corresponding float value should be 1.33333. If not specified, the - # best possible crop is returned. The number of provided aspect ratios is - # limited to a maximum of 16; any aspect ratios provided after the 16th are - # ignored. + # Aspect ratios in floats, representing the ratio of the width to the height of + # the image. For example, if the desired aspect ratio is 4/3, the corresponding + # float value should be 1.33333. If not specified, the best possible crop is + # returned. The number of provided aspect ratios is limited to a maximum of 16; + # any aspect ratios provided after the 16th are ignored. # Corresponds to the JSON property `aspectRatios` # @return [Array] attr_accessor :aspect_ratios @@ -1810,11 +1597,10 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly] attr_accessor :bounding_poly - # **Deprecated. Use `score` instead.** - # The accuracy of the entity detection in an image. - # For example, for an image in which the "Eiffel Tower" entity is detected, - # this field represents the confidence that there is a tower in the query - # image. Range [0, 1]. + # **Deprecated. Use `score` instead.** The accuracy of the entity detection in + # an image. For example, for an image in which the "Eiffel Tower" entity is + # detected, this field represents the confidence that there is a tower in the + # query image. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -1824,30 +1610,29 @@ module Google # @return [String] attr_accessor :description - # The language code for the locale in which the entity textual - # `description` is expressed. + # The language code for the locale in which the entity textual `description` is + # expressed. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale - # The location information for the detected entity. Multiple - # `LocationInfo` elements can be present because one location may - # indicate the location of the scene in the image, and another location - # may indicate the location of the place where the image was taken. - # Location information is usually present for landmarks. + # The location information for the detected entity. Multiple `LocationInfo` + # elements can be present because one location may indicate the location of the + # scene in the image, and another location may indicate the location of the + # place where the image was taken. Location information is usually present for + # landmarks. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `mid` # @return [String] attr_accessor :mid - # Some entities may have optional user-supplied `Property` (name/value) - # fields, such a score or string that qualifies the entity. + # Some entities may have optional user-supplied `Property` (name/value) fields, + # such a score or string that qualifies the entity. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -1857,11 +1642,11 @@ module Google # @return [Float] attr_accessor :score - # The relevancy of the ICA (Image Content Annotation) label to the - # image. For example, the relevancy of "tower" is likely higher to an image - # containing the detected "Eiffel Tower" than to an image containing a - # detected distant towering building, even though the confidence that - # there is a tower in each image may be the same. Range [0, 1]. + # The relevancy of the ICA (Image Content Annotation) label to the image. For + # example, the relevancy of "tower" is likely higher to an image containing the + # detected "Eiffel Tower" than to an image containing a detected distant + # towering building, even though the confidence that there is a tower in each + # image may be the same. Range [0, 1]. # Corresponds to the JSON property `topicality` # @return [Float] attr_accessor :topicality @@ -1934,15 +1719,15 @@ module Google attr_accessor :landmarks # Yaw angle, which indicates the leftward/rightward angle that the face is - # pointing relative to the vertical plane perpendicular to the image. Range - # [-180,180]. + # pointing relative to the vertical plane perpendicular to the image. Range [- + # 180,180]. # Corresponds to the JSON property `panAngle` # @return [Float] attr_accessor :pan_angle - # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation - # of the face relative to the image vertical about the axis perpendicular to - # the face. Range [-180,180]. + # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of + # the face relative to the image vertical about the axis perpendicular to the + # face. Range [-180,180]. # Corresponds to the JSON property `rollAngle` # @return [Float] attr_accessor :roll_angle @@ -1996,9 +1781,9 @@ module Google class GoogleCloudVisionV1p1beta1FaceAnnotationLandmark include Google::Apis::Core::Hashable - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. # Corresponds to the JSON property `position` # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Position] attr_accessor :position @@ -2020,20 +1805,19 @@ module Google end # The type of Google Cloud Vision API detection to perform, and the maximum - # number of results to return for that type. Multiple `Feature` objects can - # be specified in the `features` list. + # number of results to return for that type. Multiple `Feature` objects can be + # specified in the `features` list. class GoogleCloudVisionV1p1beta1Feature include Google::Apis::Core::Hashable - # Maximum number of results of this type. Does not apply to - # `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. + # Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, ` + # DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. # Corresponds to the JSON property `maxResults` # @return [Fixnum] attr_accessor :max_results - # Model to use for the feature. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for the feature. Supported values: "builtin/stable" (the default + # if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -2059,24 +1843,20 @@ module Google class GoogleCloudVisionV1p1beta1GcsDestination include Google::Apis::Core::Hashable - # Google Cloud Storage URI prefix where the results will be stored. Results - # will be in JSON format and preceded by its corresponding input URI prefix. - # This field can either represent a gcs file prefix or gcs directory. In - # either case, the uri should be unique because in order to get all of the - # output files, you will need to do a wildcard gcs search on the uri prefix - # you provide. - # Examples: - # * File Prefix: gs://bucket-name/here/filenameprefix The output files - # will be created in gs://bucket-name/here/ and the names of the - # output files will begin with "filenameprefix". - # * Directory Prefix: gs://bucket-name/some/location/ The output files - # will be created in gs://bucket-name/some/location/ and the names of the - # output files could be anything because there was no filename prefix - # specified. - # If multiple outputs, each response is still AnnotateFileResponse, each of - # which contains some subset of the full list of AnnotateImageResponse. - # Multiple outputs can happen if, for example, the output JSON is too large - # and overflows into multiple sharded files. + # Google Cloud Storage URI prefix where the results will be stored. Results will + # be in JSON format and preceded by its corresponding input URI prefix. This + # field can either represent a gcs file prefix or gcs directory. In either case, + # the uri should be unique because in order to get all of the output files, you + # will need to do a wildcard gcs search on the uri prefix you provide. Examples: + # * File Prefix: gs://bucket-name/here/filenameprefix The output files will be + # created in gs://bucket-name/here/ and the names of the output files will begin + # with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The + # output files will be created in gs://bucket-name/some/location/ and the names + # of the output files could be anything because there was no filename prefix + # specified. If multiple outputs, each response is still AnnotateFileResponse, + # each of which contains some subset of the full list of AnnotateImageResponse. + # Multiple outputs can happen if, for example, the output JSON is too large and + # overflows into multiple sharded files. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -2095,8 +1875,8 @@ module Google class GoogleCloudVisionV1p1beta1GcsSource include Google::Apis::Core::Hashable - # Google Cloud Storage URI for the input file. This must only be a - # Google Cloud Storage object. Wildcards are not currently supported. + # Google Cloud Storage URI for the input file. This must only be a Google Cloud + # Storage object. Wildcards are not currently supported. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -2115,11 +1895,11 @@ module Google class GoogleCloudVisionV1p1beta1Image include Google::Apis::Core::Hashable - # Image content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateImages requests. It does - # not work for AsyncBatchAnnotateImages requests. + # Image content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateImages requests. It does not work for AsyncBatchAnnotateImages + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -2146,8 +1926,8 @@ module Google class GoogleCloudVisionV1p1beta1ImageAnnotationContext include Google::Apis::Core::Hashable - # If the file was a PDF or TIFF, this field gives the page number within - # the file used to produce the image. + # If the file was a PDF or TIFF, this field gives the page number within the + # file used to produce the image. # Corresponds to the JSON property `pageNumber` # @return [Fixnum] attr_accessor :page_number @@ -2179,12 +1959,12 @@ module Google # List of languages to use for TEXT_DETECTION. In most cases, an empty value # yields the best results since it enables automatic language detection. For - # languages based on the Latin alphabet, setting `language_hints` is not - # needed. In rare cases, when the language of the text in the image is known, - # setting a hint will help get better results (although it will be a - # significant hindrance if the hint is wrong). Text detection returns an - # error if one or more of the specified languages is not one of the - # [supported languages](https://cloud.google.com/vision/docs/languages). + # languages based on the Latin alphabet, setting `language_hints` is not needed. + # In rare cases, when the language of the text in the image is known, setting a + # hint will help get better results (although it will be a significant hindrance + # if the hint is wrong). Text detection returns an error if one or more of the + # specified languages is not one of the [supported languages](https://cloud. + # google.com/vision/docs/languages). # Corresponds to the JSON property `languageHints` # @return [Array] attr_accessor :language_hints @@ -2241,29 +2021,24 @@ module Google class GoogleCloudVisionV1p1beta1ImageSource include Google::Apis::Core::Hashable - # **Use `image_uri` instead.** - # The Google Cloud Storage URI of the form - # `gs://bucket_name/object_name`. Object versioning is not supported. See - # [Google Cloud Storage Request - # URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. + # **Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs:// + # bucket_name/object_name`. Object versioning is not supported. See [Google + # Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference- + # uris) for more info. # Corresponds to the JSON property `gcsImageUri` # @return [String] attr_accessor :gcs_image_uri - # The URI of the source image. Can be either: - # 1. A Google Cloud Storage URI of the form - # `gs://bucket_name/object_name`. Object versioning is not supported. See - # [Google Cloud Storage Request - # URIs](https://cloud.google.com/storage/docs/reference-uris) for more - # info. - # 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from - # HTTP/HTTPS URLs, Google cannot guarantee that the request will be - # completed. Your request may fail if the specified host denies the - # request (e.g. due to request throttling or DOS prevention), or if Google - # throttles requests to the site for abuse prevention. You should not - # depend on externally-hosted images for production applications. - # When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes - # precedence. + # The URI of the source image. Can be either: 1. A Google Cloud Storage URI of + # the form `gs://bucket_name/object_name`. Object versioning is not supported. + # See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/ + # reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. + # When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the + # request will be completed. Your request may fail if the specified host denies + # the request (e.g. due to request throttling or DOS prevention), or if Google + # throttles requests to the site for abuse prevention. You should not depend on + # externally-hosted images for production applications. When both `gcs_image_uri` + # and `image_uri` are specified, `image_uri` takes precedence. # Corresponds to the JSON property `imageUri` # @return [String] attr_accessor :image_uri @@ -2283,11 +2058,11 @@ module Google class GoogleCloudVisionV1p1beta1InputConfig include Google::Apis::Core::Hashable - # File content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateFiles requests. It does - # not work for AsyncBatchAnnotateFiles requests. + # File content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -2298,8 +2073,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1GcsSource] attr_accessor :gcs_source - # The type of the file. Currently only "application/pdf", "image/tiff" and - # "image/gif" are supported. Wildcards are not supported. + # The type of the file. Currently only "application/pdf", "image/tiff" and " + # image/gif" are supported. Wildcards are not supported. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -2322,18 +2097,16 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `maxLatLng` # @return [Google::Apis::VisionV1p1beta1::LatLng] attr_accessor :max_lat_lng # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `minLatLng` # @return [Google::Apis::VisionV1p1beta1::LatLng] attr_accessor :min_lat_lng @@ -2358,9 +2131,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly] attr_accessor :bounding_poly - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -2400,9 +2172,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::VisionV1p1beta1::LatLng] attr_accessor :lat_lng @@ -2417,9 +2188,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVisionV1p1beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -2479,13 +2249,11 @@ module Google class GoogleCloudVisionV1p1beta1OutputConfig include Google::Apis::Core::Hashable - # The max number of response protos to put into each output JSON file on - # Google Cloud Storage. - # The valid range is [1, 100]. If not specified, the default value is 20. - # For example, for one pdf file with 100 pages, 100 response protos will - # be generated. If `batch_size` = 20, then 5 json files each - # containing 20 response protos will be written under the prefix - # `gcs_destination`.`uri`. + # The max number of response protos to put into each output JSON file on Google + # Cloud Storage. The valid range is [1, 100]. If not specified, the default + # value is 20. For example, for one pdf file with 100 pages, 100 response protos + # will be generated. If `batch_size` = 20, then 5 json files each containing 20 + # response protos will be written under the prefix `gcs_destination`.`uri`. # Currently, batch_size only applies to GcsDestination, with potential future # support for other output configurations. # Corresponds to the JSON property `batchSize` @@ -2522,8 +2290,8 @@ module Google # @return [Float] attr_accessor :confidence - # Page height. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page height. For PDFs the unit is points. For images (including TIFFs) the + # unit is pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -2533,8 +2301,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty] attr_accessor :property - # Page width. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page width. For PDFs the unit is points. For images (including TIFFs) the unit + # is pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -2590,9 +2358,9 @@ module Google end end - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. class GoogleCloudVisionV1p1beta1Position include Google::Apis::Core::Hashable @@ -2639,33 +2407,28 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the product. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - # This field is ignored when creating a product. + # The resource name of the product. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Immutable. The category for the product identified by the reference image. - # This should - # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories - # "homegoods", "apparel", and "toys" are still supported, but these should - # not be used for new products. + # This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods- + # v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" + # are still supported, but these should not be used for new products. # Corresponds to the JSON property `productCategory` # @return [String] attr_accessor :product_category - # Key-value pairs that can be attached to a product. At query time, - # constraints can be specified based on the product_labels. - # Note that integer values can be provided as strings, e.g. "1199". Only - # strings with integer values can match a range-based restriction which is - # to be supported soon. - # Multiple values can be assigned to the same key. One product may have up to - # 500 product_labels. - # Notice that the total number of distinct product_labels over all products - # in one ProductSet cannot exceed 1M, otherwise the product search pipeline - # will refuse to work for that ProductSet. + # Key-value pairs that can be attached to a product. At query time, constraints + # can be specified based on the product_labels. Note that integer values can be + # provided as strings, e.g. "1199". Only strings with integer values can match a + # range-based restriction which is to be supported soon. Multiple values can be + # assigned to the same key. One product may have up to 500 product_labels. + # Notice that the total number of distinct product_labels over all products in + # one ProductSet cannot exceed 1M, otherwise the product search pipeline will + # refuse to work for that ProductSet. # Corresponds to the JSON property `productLabels` # @return [Array] attr_accessor :product_labels @@ -2694,8 +2457,8 @@ module Google # @return [String] attr_accessor :key - # The value of the label attached to the product. Cannot be empty and - # cannot exceed 128 bytes. + # The value of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -2720,30 +2483,29 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BoundingPoly] attr_accessor :bounding_poly - # The filtering expression. This can be used to restrict search results based - # on Product labels. We currently support an AND of OR of key-value - # expressions, where each expression within an OR must have the same key. An - # '=' should be used to connect the key and value. - # For example, "(color = red OR color = blue) AND brand = Google" is - # acceptable, but "(color = red OR brand = Google)" is not acceptable. - # "color: red" is not acceptable because it uses a ':' instead of an '='. + # The filtering expression. This can be used to restrict search results based on + # Product labels. We currently support an AND of OR of key-value expressions, + # where each expression within an OR must have the same key. An '=' should be + # used to connect the key and value. For example, "(color = red OR color = blue) + # AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is + # not acceptable. "color: red" is not acceptable because it uses a ':' instead + # of an '='. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter - # The list of product categories to search in. Currently, we only consider - # the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", - # "packagedgoods-v1", or "general-v1" should be specified. The legacy - # categories "homegoods", "apparel", and "toys" are still supported but will - # be deprecated. For new products, please use "homegoods-v2", "apparel-v2", - # or "toys-v2" for better product search accuracy. It is recommended to - # migrate existing products to these categories as well. + # The list of product categories to search in. Currently, we only consider the + # first category, and either "homegoods-v2", "apparel-v2", "toys-v2", " + # packagedgoods-v1", or "general-v1" should be specified. The legacy categories " + # homegoods", "apparel", and "toys" are still supported but will be deprecated. + # For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for + # better product search accuracy. It is recommended to migrate existing products + # to these categories as well. # Corresponds to the JSON property `productCategories` # @return [Array] attr_accessor :product_categories - # The resource name of a ProductSet to be searched for similar images. - # Format is: + # The resource name of a ProductSet to be searched for similar images. Format is: # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. # Corresponds to the JSON property `productSet` # @return [String] @@ -2767,8 +2529,8 @@ module Google include Google::Apis::Core::Hashable # Timestamp of the index which provided these results. Products added to the - # product set and products removed from the product set after this time are - # not reflected in the current results. + # product set and products removed from the product set after this time are not + # reflected in the current results. # Corresponds to the JSON property `indexTime` # @return [String] attr_accessor :index_time @@ -2798,8 +2560,7 @@ module Google end end - # Information about the products similar to a single product in a query - # image. + # Information about the products similar to a single product in a query image. class GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult include Google::Apis::Core::Hashable @@ -2834,9 +2595,8 @@ module Google class GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation include Google::Apis::Core::Hashable - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -2873,8 +2633,8 @@ module Google class GoogleCloudVisionV1p1beta1ProductSearchResultsResult include Google::Apis::Core::Hashable - # The resource name of the image from the product that is the closest match - # to the query. + # The resource name of the image from the product that is the closest match to + # the query. # Corresponds to the JSON property `image` # @return [String] attr_accessor :image @@ -2884,8 +2644,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1Product] attr_accessor :product - # A confidence level on the match, ranging from 0 (no confidence) to - # 1 (full confidence). + # A confidence level on the match, ranging from 0 (no confidence) to 1 (full + # confidence). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -2933,15 +2693,14 @@ module Google end end - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). class GoogleCloudVisionV1p1beta1SafeSearchAnnotation include Google::Apis::Core::Hashable # Represents the adult content likelihood for the image. Adult content may - # contain elements such as nudity, pornographic images or cartoons, or - # sexual activities. + # contain elements such as nudity, pornographic images or cartoons, or sexual + # activities. # Corresponds to the JSON property `adult` # @return [String] attr_accessor :adult @@ -2953,15 +2712,14 @@ module Google # Likelihood that the request image contains racy content. Racy content may # include (but is not limited to) skimpy or sheer clothing, strategically - # covered nudity, lewd or provocative poses, or close-ups of sensitive - # body areas. + # covered nudity, lewd or provocative poses, or close-ups of sensitive body + # areas. # Corresponds to the JSON property `racy` # @return [String] attr_accessor :racy - # Spoof likelihood. The likelihood that an modification - # was made to the image's canonical version to make it appear - # funny or offensive. + # Spoof likelihood. The likelihood that an modification was made to the image's + # canonical version to make it appear funny or offensive. # Corresponds to the JSON property `spoof` # @return [String] attr_accessor :spoof @@ -3022,13 +2780,12 @@ module Google end end - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. class GoogleCloudVisionV1p1beta1TextAnnotation include Google::Apis::Core::Hashable @@ -3088,9 +2845,8 @@ module Google # @return [Float] attr_accessor :confidence - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -3131,8 +2887,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the vertex coordinates are in the same scale as the original image. + # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are + # in the same scale as the original image. class GoogleCloudVisionV1p1beta1Vertex include Google::Apis::Core::Hashable @@ -3161,14 +2917,14 @@ module Google class GoogleCloudVisionV1p1beta1WebDetection include Google::Apis::Core::Hashable - # The service's best guess as to the topic of the request image. - # Inferred from similar images on the open web. + # The service's best guess as to the topic of the request image. Inferred from + # similar images on the open web. # Corresponds to the JSON property `bestGuessLabels` # @return [Array] attr_accessor :best_guess_labels - # Fully matching images from the Internet. - # Can include resized copies of the query image. + # Fully matching images from the Internet. Can include resized copies of the + # query image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -3178,9 +2934,9 @@ module Google # @return [Array] attr_accessor :pages_with_matching_images - # Partial matching images from the Internet. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its crops. + # Partial matching images from the Internet. Those images are similar enough to + # share some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -3244,8 +3000,8 @@ module Google # @return [String] attr_accessor :entity_id - # Overall relevancy score for the entity. - # Not normalized and not comparable across different image queries. + # Overall relevancy score for the entity. Not normalized and not comparable + # across different image queries. # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -3296,9 +3052,9 @@ module Google # @return [String] attr_accessor :label - # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - # For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more + # information, see http://www.unicode.org/reports/tr35/# + # Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -3318,8 +3074,8 @@ module Google class GoogleCloudVisionV1p1beta1WebDetectionWebPage include Google::Apis::Core::Hashable - # Fully matching images on the page. - # Can include resized copies of the query image. + # Fully matching images on the page. Can include resized copies of the query + # image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -3329,10 +3085,9 @@ module Google # @return [String] attr_accessor :page_title - # Partial matching images on the page. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its - # crops. + # Partial matching images on the page. Those images are similar enough to share + # some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -3380,8 +3135,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty] attr_accessor :property - # List of symbols in the word. - # The order of the symbols follows the natural reading order. + # List of symbols in the word. The order of the symbols follows the natural + # reading order. # Corresponds to the JSON property `symbols` # @return [Array] attr_accessor :symbols @@ -3404,12 +3159,12 @@ module Google class GoogleCloudVisionV1p2beta1AnnotateFileResponse 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::VisionV1p1beta1::Status] attr_accessor :error @@ -3419,8 +3174,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1InputConfig] attr_accessor :input_config - # Individual responses to images found within the file. This field will be - # empty if the `error` field is set. + # Individual responses to images found within the file. This field will be empty + # if the `error` field is set. # Corresponds to the JSON property `responses` # @return [Array] attr_accessor :responses @@ -3458,12 +3213,12 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1CropHintsAnnotation] attr_accessor :crop_hints_annotation - # 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::VisionV1p1beta1::Status] attr_accessor :error @@ -3473,13 +3228,12 @@ module Google # @return [Array] attr_accessor :face_annotations - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. # Corresponds to the JSON property `fullTextAnnotation` # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1TextAnnotation] attr_accessor :full_text_annotation @@ -3499,8 +3253,8 @@ module Google # @return [Array] attr_accessor :landmark_annotations - # If present, localized object detection has completed successfully. - # This will be sorted descending by confidence score. + # If present, localized object detection has completed successfully. This will + # be sorted descending by confidence score. # Corresponds to the JSON property `localizedObjectAnnotations` # @return [Array] attr_accessor :localized_object_annotations @@ -3515,9 +3269,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1ProductSearchResults] attr_accessor :product_search_results - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). # Corresponds to the JSON property `safeSearchAnnotation` # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1SafeSearchAnnotation] attr_accessor :safe_search_annotation @@ -3662,123 +3415,61 @@ module Google end end - # Color information consists of RGB channels, score, and the fraction of - # the image that the color occupies in the image. + # Color information consists of RGB channels, score, and the fraction of the + # image that the color occupies in the image. class GoogleCloudVisionV1p2beta1ColorInfo include Google::Apis::Core::Hashable # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... # Corresponds to the JSON property `color` # @return [Google::Apis::VisionV1p1beta1::Color] attr_accessor :color - # The fraction of pixels the color occupies in the image. - # Value in range [0, 1]. + # The fraction of pixels the color occupies in the image. Value in range [0, 1]. # Corresponds to the JSON property `pixelFraction` # @return [Float] attr_accessor :pixel_fraction @@ -3809,7 +3500,7 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1BoundingPoly] attr_accessor :bounding_poly - # Confidence of this being a salient region. Range [0, 1]. + # Confidence of this being a salient region. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -3879,11 +3570,10 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1BoundingPoly] attr_accessor :bounding_poly - # **Deprecated. Use `score` instead.** - # The accuracy of the entity detection in an image. - # For example, for an image in which the "Eiffel Tower" entity is detected, - # this field represents the confidence that there is a tower in the query - # image. Range [0, 1]. + # **Deprecated. Use `score` instead.** The accuracy of the entity detection in + # an image. For example, for an image in which the "Eiffel Tower" entity is + # detected, this field represents the confidence that there is a tower in the + # query image. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -3893,30 +3583,29 @@ module Google # @return [String] attr_accessor :description - # The language code for the locale in which the entity textual - # `description` is expressed. + # The language code for the locale in which the entity textual `description` is + # expressed. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale - # The location information for the detected entity. Multiple - # `LocationInfo` elements can be present because one location may - # indicate the location of the scene in the image, and another location - # may indicate the location of the place where the image was taken. - # Location information is usually present for landmarks. + # The location information for the detected entity. Multiple `LocationInfo` + # elements can be present because one location may indicate the location of the + # scene in the image, and another location may indicate the location of the + # place where the image was taken. Location information is usually present for + # landmarks. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `mid` # @return [String] attr_accessor :mid - # Some entities may have optional user-supplied `Property` (name/value) - # fields, such a score or string that qualifies the entity. + # Some entities may have optional user-supplied `Property` (name/value) fields, + # such a score or string that qualifies the entity. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -3926,11 +3615,11 @@ module Google # @return [Float] attr_accessor :score - # The relevancy of the ICA (Image Content Annotation) label to the - # image. For example, the relevancy of "tower" is likely higher to an image - # containing the detected "Eiffel Tower" than to an image containing a - # detected distant towering building, even though the confidence that - # there is a tower in each image may be the same. Range [0, 1]. + # The relevancy of the ICA (Image Content Annotation) label to the image. For + # example, the relevancy of "tower" is likely higher to an image containing the + # detected "Eiffel Tower" than to an image containing a detected distant + # towering building, even though the confidence that there is a tower in each + # image may be the same. Range [0, 1]. # Corresponds to the JSON property `topicality` # @return [Float] attr_accessor :topicality @@ -4003,15 +3692,15 @@ module Google attr_accessor :landmarks # Yaw angle, which indicates the leftward/rightward angle that the face is - # pointing relative to the vertical plane perpendicular to the image. Range - # [-180,180]. + # pointing relative to the vertical plane perpendicular to the image. Range [- + # 180,180]. # Corresponds to the JSON property `panAngle` # @return [Float] attr_accessor :pan_angle - # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation - # of the face relative to the image vertical about the axis perpendicular to - # the face. Range [-180,180]. + # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of + # the face relative to the image vertical about the axis perpendicular to the + # face. Range [-180,180]. # Corresponds to the JSON property `rollAngle` # @return [Float] attr_accessor :roll_angle @@ -4065,9 +3754,9 @@ module Google class GoogleCloudVisionV1p2beta1FaceAnnotationLandmark include Google::Apis::Core::Hashable - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. # Corresponds to the JSON property `position` # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1Position] attr_accessor :position @@ -4092,24 +3781,20 @@ module Google class GoogleCloudVisionV1p2beta1GcsDestination include Google::Apis::Core::Hashable - # Google Cloud Storage URI prefix where the results will be stored. Results - # will be in JSON format and preceded by its corresponding input URI prefix. - # This field can either represent a gcs file prefix or gcs directory. In - # either case, the uri should be unique because in order to get all of the - # output files, you will need to do a wildcard gcs search on the uri prefix - # you provide. - # Examples: - # * File Prefix: gs://bucket-name/here/filenameprefix The output files - # will be created in gs://bucket-name/here/ and the names of the - # output files will begin with "filenameprefix". - # * Directory Prefix: gs://bucket-name/some/location/ The output files - # will be created in gs://bucket-name/some/location/ and the names of the - # output files could be anything because there was no filename prefix - # specified. - # If multiple outputs, each response is still AnnotateFileResponse, each of - # which contains some subset of the full list of AnnotateImageResponse. - # Multiple outputs can happen if, for example, the output JSON is too large - # and overflows into multiple sharded files. + # Google Cloud Storage URI prefix where the results will be stored. Results will + # be in JSON format and preceded by its corresponding input URI prefix. This + # field can either represent a gcs file prefix or gcs directory. In either case, + # the uri should be unique because in order to get all of the output files, you + # will need to do a wildcard gcs search on the uri prefix you provide. Examples: + # * File Prefix: gs://bucket-name/here/filenameprefix The output files will be + # created in gs://bucket-name/here/ and the names of the output files will begin + # with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The + # output files will be created in gs://bucket-name/some/location/ and the names + # of the output files could be anything because there was no filename prefix + # specified. If multiple outputs, each response is still AnnotateFileResponse, + # each of which contains some subset of the full list of AnnotateImageResponse. + # Multiple outputs can happen if, for example, the output JSON is too large and + # overflows into multiple sharded files. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -4128,8 +3813,8 @@ module Google class GoogleCloudVisionV1p2beta1GcsSource include Google::Apis::Core::Hashable - # Google Cloud Storage URI for the input file. This must only be a - # Google Cloud Storage object. Wildcards are not currently supported. + # Google Cloud Storage URI for the input file. This must only be a Google Cloud + # Storage object. Wildcards are not currently supported. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -4149,8 +3834,8 @@ module Google class GoogleCloudVisionV1p2beta1ImageAnnotationContext include Google::Apis::Core::Hashable - # If the file was a PDF or TIFF, this field gives the page number within - # the file used to produce the image. + # If the file was a PDF or TIFF, this field gives the page number within the + # file used to produce the image. # Corresponds to the JSON property `pageNumber` # @return [Fixnum] attr_accessor :page_number @@ -4194,11 +3879,11 @@ module Google class GoogleCloudVisionV1p2beta1InputConfig include Google::Apis::Core::Hashable - # File content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateFiles requests. It does - # not work for AsyncBatchAnnotateFiles requests. + # File content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -4209,8 +3894,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1GcsSource] attr_accessor :gcs_source - # The type of the file. Currently only "application/pdf", "image/tiff" and - # "image/gif" are supported. Wildcards are not supported. + # The type of the file. Currently only "application/pdf", "image/tiff" and " + # image/gif" are supported. Wildcards are not supported. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -4236,9 +3921,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1BoundingPoly] attr_accessor :bounding_poly - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -4278,9 +3962,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::VisionV1p1beta1::LatLng] attr_accessor :lat_lng @@ -4295,9 +3978,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVisionV1p2beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -4357,13 +4039,11 @@ module Google class GoogleCloudVisionV1p2beta1OutputConfig include Google::Apis::Core::Hashable - # The max number of response protos to put into each output JSON file on - # Google Cloud Storage. - # The valid range is [1, 100]. If not specified, the default value is 20. - # For example, for one pdf file with 100 pages, 100 response protos will - # be generated. If `batch_size` = 20, then 5 json files each - # containing 20 response protos will be written under the prefix - # `gcs_destination`.`uri`. + # The max number of response protos to put into each output JSON file on Google + # Cloud Storage. The valid range is [1, 100]. If not specified, the default + # value is 20. For example, for one pdf file with 100 pages, 100 response protos + # will be generated. If `batch_size` = 20, then 5 json files each containing 20 + # response protos will be written under the prefix `gcs_destination`.`uri`. # Currently, batch_size only applies to GcsDestination, with potential future # support for other output configurations. # Corresponds to the JSON property `batchSize` @@ -4400,8 +4080,8 @@ module Google # @return [Float] attr_accessor :confidence - # Page height. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page height. For PDFs the unit is points. For images (including TIFFs) the + # unit is pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -4411,8 +4091,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1TextAnnotationTextProperty] attr_accessor :property - # Page width. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page width. For PDFs the unit is points. For images (including TIFFs) the unit + # is pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -4468,9 +4148,9 @@ module Google end end - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. class GoogleCloudVisionV1p2beta1Position include Google::Apis::Core::Hashable @@ -4517,33 +4197,28 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the product. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - # This field is ignored when creating a product. + # The resource name of the product. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Immutable. The category for the product identified by the reference image. - # This should - # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories - # "homegoods", "apparel", and "toys" are still supported, but these should - # not be used for new products. + # This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods- + # v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" + # are still supported, but these should not be used for new products. # Corresponds to the JSON property `productCategory` # @return [String] attr_accessor :product_category - # Key-value pairs that can be attached to a product. At query time, - # constraints can be specified based on the product_labels. - # Note that integer values can be provided as strings, e.g. "1199". Only - # strings with integer values can match a range-based restriction which is - # to be supported soon. - # Multiple values can be assigned to the same key. One product may have up to - # 500 product_labels. - # Notice that the total number of distinct product_labels over all products - # in one ProductSet cannot exceed 1M, otherwise the product search pipeline - # will refuse to work for that ProductSet. + # Key-value pairs that can be attached to a product. At query time, constraints + # can be specified based on the product_labels. Note that integer values can be + # provided as strings, e.g. "1199". Only strings with integer values can match a + # range-based restriction which is to be supported soon. Multiple values can be + # assigned to the same key. One product may have up to 500 product_labels. + # Notice that the total number of distinct product_labels over all products in + # one ProductSet cannot exceed 1M, otherwise the product search pipeline will + # refuse to work for that ProductSet. # Corresponds to the JSON property `productLabels` # @return [Array] attr_accessor :product_labels @@ -4572,8 +4247,8 @@ module Google # @return [String] attr_accessor :key - # The value of the label attached to the product. Cannot be empty and - # cannot exceed 128 bytes. + # The value of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -4594,8 +4269,8 @@ module Google include Google::Apis::Core::Hashable # Timestamp of the index which provided these results. Products added to the - # product set and products removed from the product set after this time are - # not reflected in the current results. + # product set and products removed from the product set after this time are not + # reflected in the current results. # Corresponds to the JSON property `indexTime` # @return [String] attr_accessor :index_time @@ -4625,8 +4300,7 @@ module Google end end - # Information about the products similar to a single product in a query - # image. + # Information about the products similar to a single product in a query image. class GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult include Google::Apis::Core::Hashable @@ -4661,9 +4335,8 @@ module Google class GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation include Google::Apis::Core::Hashable - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -4700,8 +4373,8 @@ module Google class GoogleCloudVisionV1p2beta1ProductSearchResultsResult include Google::Apis::Core::Hashable - # The resource name of the image from the product that is the closest match - # to the query. + # The resource name of the image from the product that is the closest match to + # the query. # Corresponds to the JSON property `image` # @return [String] attr_accessor :image @@ -4711,8 +4384,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1Product] attr_accessor :product - # A confidence level on the match, ranging from 0 (no confidence) to - # 1 (full confidence). + # A confidence level on the match, ranging from 0 (no confidence) to 1 (full + # confidence). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -4760,15 +4433,14 @@ module Google end end - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). class GoogleCloudVisionV1p2beta1SafeSearchAnnotation include Google::Apis::Core::Hashable # Represents the adult content likelihood for the image. Adult content may - # contain elements such as nudity, pornographic images or cartoons, or - # sexual activities. + # contain elements such as nudity, pornographic images or cartoons, or sexual + # activities. # Corresponds to the JSON property `adult` # @return [String] attr_accessor :adult @@ -4780,15 +4452,14 @@ module Google # Likelihood that the request image contains racy content. Racy content may # include (but is not limited to) skimpy or sheer clothing, strategically - # covered nudity, lewd or provocative poses, or close-ups of sensitive - # body areas. + # covered nudity, lewd or provocative poses, or close-ups of sensitive body + # areas. # Corresponds to the JSON property `racy` # @return [String] attr_accessor :racy - # Spoof likelihood. The likelihood that an modification - # was made to the image's canonical version to make it appear - # funny or offensive. + # Spoof likelihood. The likelihood that an modification was made to the image's + # canonical version to make it appear funny or offensive. # Corresponds to the JSON property `spoof` # @return [String] attr_accessor :spoof @@ -4849,13 +4520,12 @@ module Google end end - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. class GoogleCloudVisionV1p2beta1TextAnnotation include Google::Apis::Core::Hashable @@ -4915,9 +4585,8 @@ module Google # @return [Float] attr_accessor :confidence - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -4958,8 +4627,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the vertex coordinates are in the same scale as the original image. + # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are + # in the same scale as the original image. class GoogleCloudVisionV1p2beta1Vertex include Google::Apis::Core::Hashable @@ -4988,14 +4657,14 @@ module Google class GoogleCloudVisionV1p2beta1WebDetection include Google::Apis::Core::Hashable - # The service's best guess as to the topic of the request image. - # Inferred from similar images on the open web. + # The service's best guess as to the topic of the request image. Inferred from + # similar images on the open web. # Corresponds to the JSON property `bestGuessLabels` # @return [Array] attr_accessor :best_guess_labels - # Fully matching images from the Internet. - # Can include resized copies of the query image. + # Fully matching images from the Internet. Can include resized copies of the + # query image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -5005,9 +4674,9 @@ module Google # @return [Array] attr_accessor :pages_with_matching_images - # Partial matching images from the Internet. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its crops. + # Partial matching images from the Internet. Those images are similar enough to + # share some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -5051,8 +4720,8 @@ module Google # @return [String] attr_accessor :entity_id - # Overall relevancy score for the entity. - # Not normalized and not comparable across different image queries. + # Overall relevancy score for the entity. Not normalized and not comparable + # across different image queries. # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -5103,9 +4772,9 @@ module Google # @return [String] attr_accessor :label - # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - # For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more + # information, see http://www.unicode.org/reports/tr35/# + # Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -5125,8 +4794,8 @@ module Google class GoogleCloudVisionV1p2beta1WebDetectionWebPage include Google::Apis::Core::Hashable - # Fully matching images on the page. - # Can include resized copies of the query image. + # Fully matching images on the page. Can include resized copies of the query + # image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -5136,10 +4805,9 @@ module Google # @return [String] attr_accessor :page_title - # Partial matching images on the page. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its - # crops. + # Partial matching images on the page. Those images are similar enough to share + # some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -5187,8 +4855,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p2beta1TextAnnotationTextProperty] attr_accessor :property - # List of symbols in the word. - # The order of the symbols follows the natural reading order. + # List of symbols in the word. The order of the symbols follows the natural + # reading order. # Corresponds to the JSON property `symbols` # @return [Array] attr_accessor :symbols @@ -5211,12 +4879,12 @@ module Google class GoogleCloudVisionV1p3beta1AnnotateFileResponse 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::VisionV1p1beta1::Status] attr_accessor :error @@ -5226,8 +4894,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1InputConfig] attr_accessor :input_config - # Individual responses to images found within the file. This field will be - # empty if the `error` field is set. + # Individual responses to images found within the file. This field will be empty + # if the `error` field is set. # Corresponds to the JSON property `responses` # @return [Array] attr_accessor :responses @@ -5265,12 +4933,12 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1CropHintsAnnotation] attr_accessor :crop_hints_annotation - # 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::VisionV1p1beta1::Status] attr_accessor :error @@ -5280,13 +4948,12 @@ module Google # @return [Array] attr_accessor :face_annotations - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. # Corresponds to the JSON property `fullTextAnnotation` # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1TextAnnotation] attr_accessor :full_text_annotation @@ -5306,8 +4973,8 @@ module Google # @return [Array] attr_accessor :landmark_annotations - # If present, localized object detection has completed successfully. - # This will be sorted descending by confidence score. + # If present, localized object detection has completed successfully. This will + # be sorted descending by confidence score. # Corresponds to the JSON property `localizedObjectAnnotations` # @return [Array] attr_accessor :localized_object_annotations @@ -5322,9 +4989,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1ProductSearchResults] attr_accessor :product_search_results - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). # Corresponds to the JSON property `safeSearchAnnotation` # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1SafeSearchAnnotation] attr_accessor :safe_search_annotation @@ -5401,14 +5067,14 @@ module Google end end - # Metadata for the batch operations such as the current state. - # This is included in the `metadata` field of the `Operation` returned by the - # `GetOperation` call of the `google::longrunning::Operations` service. + # Metadata for the batch operations such as the current state. This is included + # in the `metadata` field of the `Operation` returned by the `GetOperation` call + # of the `google::longrunning::Operations` service. class GoogleCloudVisionV1p3beta1BatchOperationMetadata include Google::Apis::Core::Hashable - # The time when the batch request is finished and - # google.longrunning.Operation.done is set to true. + # The time when the batch request is finished and google.longrunning.Operation. + # done is set to true. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -5503,123 +5169,61 @@ module Google end end - # Color information consists of RGB channels, score, and the fraction of - # the image that the color occupies in the image. + # Color information consists of RGB channels, score, and the fraction of the + # image that the color occupies in the image. class GoogleCloudVisionV1p3beta1ColorInfo include Google::Apis::Core::Hashable # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... # Corresponds to the JSON property `color` # @return [Google::Apis::VisionV1p1beta1::Color] attr_accessor :color - # The fraction of pixels the color occupies in the image. - # Value in range [0, 1]. + # The fraction of pixels the color occupies in the image. Value in range [0, 1]. # Corresponds to the JSON property `pixelFraction` # @return [Float] attr_accessor :pixel_fraction @@ -5650,7 +5254,7 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1BoundingPoly] attr_accessor :bounding_poly - # Confidence of this being a salient region. Range [0, 1]. + # Confidence of this being a salient region. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -5720,11 +5324,10 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1BoundingPoly] attr_accessor :bounding_poly - # **Deprecated. Use `score` instead.** - # The accuracy of the entity detection in an image. - # For example, for an image in which the "Eiffel Tower" entity is detected, - # this field represents the confidence that there is a tower in the query - # image. Range [0, 1]. + # **Deprecated. Use `score` instead.** The accuracy of the entity detection in + # an image. For example, for an image in which the "Eiffel Tower" entity is + # detected, this field represents the confidence that there is a tower in the + # query image. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -5734,30 +5337,29 @@ module Google # @return [String] attr_accessor :description - # The language code for the locale in which the entity textual - # `description` is expressed. + # The language code for the locale in which the entity textual `description` is + # expressed. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale - # The location information for the detected entity. Multiple - # `LocationInfo` elements can be present because one location may - # indicate the location of the scene in the image, and another location - # may indicate the location of the place where the image was taken. - # Location information is usually present for landmarks. + # The location information for the detected entity. Multiple `LocationInfo` + # elements can be present because one location may indicate the location of the + # scene in the image, and another location may indicate the location of the + # place where the image was taken. Location information is usually present for + # landmarks. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `mid` # @return [String] attr_accessor :mid - # Some entities may have optional user-supplied `Property` (name/value) - # fields, such a score or string that qualifies the entity. + # Some entities may have optional user-supplied `Property` (name/value) fields, + # such a score or string that qualifies the entity. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -5767,11 +5369,11 @@ module Google # @return [Float] attr_accessor :score - # The relevancy of the ICA (Image Content Annotation) label to the - # image. For example, the relevancy of "tower" is likely higher to an image - # containing the detected "Eiffel Tower" than to an image containing a - # detected distant towering building, even though the confidence that - # there is a tower in each image may be the same. Range [0, 1]. + # The relevancy of the ICA (Image Content Annotation) label to the image. For + # example, the relevancy of "tower" is likely higher to an image containing the + # detected "Eiffel Tower" than to an image containing a detected distant + # towering building, even though the confidence that there is a tower in each + # image may be the same. Range [0, 1]. # Corresponds to the JSON property `topicality` # @return [Float] attr_accessor :topicality @@ -5844,15 +5446,15 @@ module Google attr_accessor :landmarks # Yaw angle, which indicates the leftward/rightward angle that the face is - # pointing relative to the vertical plane perpendicular to the image. Range - # [-180,180]. + # pointing relative to the vertical plane perpendicular to the image. Range [- + # 180,180]. # Corresponds to the JSON property `panAngle` # @return [Float] attr_accessor :pan_angle - # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation - # of the face relative to the image vertical about the axis perpendicular to - # the face. Range [-180,180]. + # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of + # the face relative to the image vertical about the axis perpendicular to the + # face. Range [-180,180]. # Corresponds to the JSON property `rollAngle` # @return [Float] attr_accessor :roll_angle @@ -5906,9 +5508,9 @@ module Google class GoogleCloudVisionV1p3beta1FaceAnnotationLandmark include Google::Apis::Core::Hashable - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. # Corresponds to the JSON property `position` # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1Position] attr_accessor :position @@ -5933,24 +5535,20 @@ module Google class GoogleCloudVisionV1p3beta1GcsDestination include Google::Apis::Core::Hashable - # Google Cloud Storage URI prefix where the results will be stored. Results - # will be in JSON format and preceded by its corresponding input URI prefix. - # This field can either represent a gcs file prefix or gcs directory. In - # either case, the uri should be unique because in order to get all of the - # output files, you will need to do a wildcard gcs search on the uri prefix - # you provide. - # Examples: - # * File Prefix: gs://bucket-name/here/filenameprefix The output files - # will be created in gs://bucket-name/here/ and the names of the - # output files will begin with "filenameprefix". - # * Directory Prefix: gs://bucket-name/some/location/ The output files - # will be created in gs://bucket-name/some/location/ and the names of the - # output files could be anything because there was no filename prefix - # specified. - # If multiple outputs, each response is still AnnotateFileResponse, each of - # which contains some subset of the full list of AnnotateImageResponse. - # Multiple outputs can happen if, for example, the output JSON is too large - # and overflows into multiple sharded files. + # Google Cloud Storage URI prefix where the results will be stored. Results will + # be in JSON format and preceded by its corresponding input URI prefix. This + # field can either represent a gcs file prefix or gcs directory. In either case, + # the uri should be unique because in order to get all of the output files, you + # will need to do a wildcard gcs search on the uri prefix you provide. Examples: + # * File Prefix: gs://bucket-name/here/filenameprefix The output files will be + # created in gs://bucket-name/here/ and the names of the output files will begin + # with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The + # output files will be created in gs://bucket-name/some/location/ and the names + # of the output files could be anything because there was no filename prefix + # specified. If multiple outputs, each response is still AnnotateFileResponse, + # each of which contains some subset of the full list of AnnotateImageResponse. + # Multiple outputs can happen if, for example, the output JSON is too large and + # overflows into multiple sharded files. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -5969,8 +5567,8 @@ module Google class GoogleCloudVisionV1p3beta1GcsSource include Google::Apis::Core::Hashable - # Google Cloud Storage URI for the input file. This must only be a - # Google Cloud Storage object. Wildcards are not currently supported. + # Google Cloud Storage URI for the input file. This must only be a Google Cloud + # Storage object. Wildcards are not currently supported. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -5990,8 +5588,8 @@ module Google class GoogleCloudVisionV1p3beta1ImageAnnotationContext include Google::Apis::Core::Hashable - # If the file was a PDF or TIFF, this field gives the page number within - # the file used to produce the image. + # If the file was a PDF or TIFF, this field gives the page number within the + # file used to produce the image. # Corresponds to the JSON property `pageNumber` # @return [Fixnum] attr_accessor :page_number @@ -6031,9 +5629,8 @@ module Google end end - # Response message for the `ImportProductSets` method. - # This message is returned by the - # google.longrunning.Operations.GetOperation method in the returned + # Response message for the `ImportProductSets` method. This message is returned + # by the google.longrunning.Operations.GetOperation method in the returned # google.longrunning.Operation.response field. class GoogleCloudVisionV1p3beta1ImportProductSetsResponse include Google::Apis::Core::Hashable @@ -6043,11 +5640,10 @@ module Google # @return [Array] attr_accessor :reference_images - # The rpc status for each ImportProductSet request, including both successes - # and errors. - # The number of statuses here matches the number of lines in the csv file, - # and statuses[i] stores the success or failure status of processing the i-th - # line of the csv, starting from line 0. + # The rpc status for each ImportProductSet request, including both successes and + # errors. The number of statuses here matches the number of lines in the csv + # file, and statuses[i] stores the success or failure status of processing the i- + # th line of the csv, starting from line 0. # Corresponds to the JSON property `statuses` # @return [Array] attr_accessor :statuses @@ -6067,11 +5663,11 @@ module Google class GoogleCloudVisionV1p3beta1InputConfig include Google::Apis::Core::Hashable - # File content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateFiles requests. It does - # not work for AsyncBatchAnnotateFiles requests. + # File content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -6082,8 +5678,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1GcsSource] attr_accessor :gcs_source - # The type of the file. Currently only "application/pdf", "image/tiff" and - # "image/gif" are supported. Wildcards are not supported. + # The type of the file. Currently only "application/pdf", "image/tiff" and " + # image/gif" are supported. Wildcards are not supported. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -6109,9 +5705,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1BoundingPoly] attr_accessor :bounding_poly - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -6151,9 +5746,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::VisionV1p1beta1::LatLng] attr_accessor :lat_lng @@ -6168,9 +5762,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVisionV1p3beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -6230,13 +5823,11 @@ module Google class GoogleCloudVisionV1p3beta1OutputConfig include Google::Apis::Core::Hashable - # The max number of response protos to put into each output JSON file on - # Google Cloud Storage. - # The valid range is [1, 100]. If not specified, the default value is 20. - # For example, for one pdf file with 100 pages, 100 response protos will - # be generated. If `batch_size` = 20, then 5 json files each - # containing 20 response protos will be written under the prefix - # `gcs_destination`.`uri`. + # The max number of response protos to put into each output JSON file on Google + # Cloud Storage. The valid range is [1, 100]. If not specified, the default + # value is 20. For example, for one pdf file with 100 pages, 100 response protos + # will be generated. If `batch_size` = 20, then 5 json files each containing 20 + # response protos will be written under the prefix `gcs_destination`.`uri`. # Currently, batch_size only applies to GcsDestination, with potential future # support for other output configurations. # Corresponds to the JSON property `batchSize` @@ -6273,8 +5864,8 @@ module Google # @return [Float] attr_accessor :confidence - # Page height. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page height. For PDFs the unit is points. For images (including TIFFs) the + # unit is pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -6284,8 +5875,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1TextAnnotationTextProperty] attr_accessor :property - # Page width. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page width. For PDFs the unit is points. For images (including TIFFs) the unit + # is pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -6341,9 +5932,9 @@ module Google end end - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. class GoogleCloudVisionV1p3beta1Position include Google::Apis::Core::Hashable @@ -6390,33 +5981,28 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the product. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - # This field is ignored when creating a product. + # The resource name of the product. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Immutable. The category for the product identified by the reference image. - # This should - # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories - # "homegoods", "apparel", and "toys" are still supported, but these should - # not be used for new products. + # This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods- + # v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" + # are still supported, but these should not be used for new products. # Corresponds to the JSON property `productCategory` # @return [String] attr_accessor :product_category - # Key-value pairs that can be attached to a product. At query time, - # constraints can be specified based on the product_labels. - # Note that integer values can be provided as strings, e.g. "1199". Only - # strings with integer values can match a range-based restriction which is - # to be supported soon. - # Multiple values can be assigned to the same key. One product may have up to - # 500 product_labels. - # Notice that the total number of distinct product_labels over all products - # in one ProductSet cannot exceed 1M, otherwise the product search pipeline - # will refuse to work for that ProductSet. + # Key-value pairs that can be attached to a product. At query time, constraints + # can be specified based on the product_labels. Note that integer values can be + # provided as strings, e.g. "1199". Only strings with integer values can match a + # range-based restriction which is to be supported soon. Multiple values can be + # assigned to the same key. One product may have up to 500 product_labels. + # Notice that the total number of distinct product_labels over all products in + # one ProductSet cannot exceed 1M, otherwise the product search pipeline will + # refuse to work for that ProductSet. # Corresponds to the JSON property `productLabels` # @return [Array] attr_accessor :product_labels @@ -6445,8 +6031,8 @@ module Google # @return [String] attr_accessor :key - # The value of the label attached to the product. Cannot be empty and - # cannot exceed 128 bytes. + # The value of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -6467,8 +6053,8 @@ module Google include Google::Apis::Core::Hashable # Timestamp of the index which provided these results. Products added to the - # product set and products removed from the product set after this time are - # not reflected in the current results. + # product set and products removed from the product set after this time are not + # reflected in the current results. # Corresponds to the JSON property `indexTime` # @return [String] attr_accessor :index_time @@ -6498,8 +6084,7 @@ module Google end end - # Information about the products similar to a single product in a query - # image. + # Information about the products similar to a single product in a query image. class GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult include Google::Apis::Core::Hashable @@ -6534,9 +6119,8 @@ module Google class GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation include Google::Apis::Core::Hashable - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -6573,8 +6157,8 @@ module Google class GoogleCloudVisionV1p3beta1ProductSearchResultsResult include Google::Apis::Core::Hashable - # The resource name of the image from the product that is the closest match - # to the query. + # The resource name of the image from the product that is the closest match to + # the query. # Corresponds to the JSON property `image` # @return [String] attr_accessor :image @@ -6584,8 +6168,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1Product] attr_accessor :product - # A confidence level on the match, ranging from 0 (no confidence) to - # 1 (full confidence). + # A confidence level on the match, ranging from 0 (no confidence) to 1 (full + # confidence). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -6639,28 +6223,24 @@ module Google include Google::Apis::Core::Hashable # Optional. Bounding polygons around the areas of interest in the reference - # image. - # If this field is empty, the system will try to detect regions of - # interest. At most 10 bounding polygons will be used. - # The provided shape is converted into a non-rotated rectangle. Once - # converted, the small edge of the rectangle must be greater than or equal - # to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 - # is not). + # image. If this field is empty, the system will try to detect regions of + # interest. At most 10 bounding polygons will be used. The provided shape is + # converted into a non-rotated rectangle. Once converted, the small edge of the + # rectangle must be greater than or equal to 300 pixels. The aspect ratio must + # be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). # Corresponds to the JSON property `boundingPolys` # @return [Array] attr_accessor :bounding_polys - # The resource name of the reference image. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ - # IMAGE_ID`. - # This field is ignored when creating a reference image. + # The resource name of the reference image. Format is: `projects/PROJECT_ID/ + # locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is + # ignored when creating a reference image. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The Google Cloud Storage URI of the reference image. - # The URI must start with `gs://`. + # Required. The Google Cloud Storage URI of the reference image. The URI must + # start with `gs://`. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -6677,15 +6257,14 @@ module Google end end - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). class GoogleCloudVisionV1p3beta1SafeSearchAnnotation include Google::Apis::Core::Hashable # Represents the adult content likelihood for the image. Adult content may - # contain elements such as nudity, pornographic images or cartoons, or - # sexual activities. + # contain elements such as nudity, pornographic images or cartoons, or sexual + # activities. # Corresponds to the JSON property `adult` # @return [String] attr_accessor :adult @@ -6697,15 +6276,14 @@ module Google # Likelihood that the request image contains racy content. Racy content may # include (but is not limited to) skimpy or sheer clothing, strategically - # covered nudity, lewd or provocative poses, or close-ups of sensitive - # body areas. + # covered nudity, lewd or provocative poses, or close-ups of sensitive body + # areas. # Corresponds to the JSON property `racy` # @return [String] attr_accessor :racy - # Spoof likelihood. The likelihood that an modification - # was made to the image's canonical version to make it appear - # funny or offensive. + # Spoof likelihood. The likelihood that an modification was made to the image's + # canonical version to make it appear funny or offensive. # Corresponds to the JSON property `spoof` # @return [String] attr_accessor :spoof @@ -6766,13 +6344,12 @@ module Google end end - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. class GoogleCloudVisionV1p3beta1TextAnnotation include Google::Apis::Core::Hashable @@ -6832,9 +6409,8 @@ module Google # @return [Float] attr_accessor :confidence - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -6875,8 +6451,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the vertex coordinates are in the same scale as the original image. + # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are + # in the same scale as the original image. class GoogleCloudVisionV1p3beta1Vertex include Google::Apis::Core::Hashable @@ -6905,14 +6481,14 @@ module Google class GoogleCloudVisionV1p3beta1WebDetection include Google::Apis::Core::Hashable - # The service's best guess as to the topic of the request image. - # Inferred from similar images on the open web. + # The service's best guess as to the topic of the request image. Inferred from + # similar images on the open web. # Corresponds to the JSON property `bestGuessLabels` # @return [Array] attr_accessor :best_guess_labels - # Fully matching images from the Internet. - # Can include resized copies of the query image. + # Fully matching images from the Internet. Can include resized copies of the + # query image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -6922,9 +6498,9 @@ module Google # @return [Array] attr_accessor :pages_with_matching_images - # Partial matching images from the Internet. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its crops. + # Partial matching images from the Internet. Those images are similar enough to + # share some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -6968,8 +6544,8 @@ module Google # @return [String] attr_accessor :entity_id - # Overall relevancy score for the entity. - # Not normalized and not comparable across different image queries. + # Overall relevancy score for the entity. Not normalized and not comparable + # across different image queries. # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -7020,9 +6596,9 @@ module Google # @return [String] attr_accessor :label - # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - # For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more + # information, see http://www.unicode.org/reports/tr35/# + # Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -7042,8 +6618,8 @@ module Google class GoogleCloudVisionV1p3beta1WebDetectionWebPage include Google::Apis::Core::Hashable - # Fully matching images on the page. - # Can include resized copies of the query image. + # Fully matching images on the page. Can include resized copies of the query + # image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -7053,10 +6629,9 @@ module Google # @return [String] attr_accessor :page_title - # Partial matching images on the page. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its - # crops. + # Partial matching images on the page. Those images are similar enough to share + # some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -7104,8 +6679,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p3beta1TextAnnotationTextProperty] attr_accessor :property - # List of symbols in the word. - # The order of the symbols follows the natural reading order. + # List of symbols in the word. The order of the symbols follows the natural + # reading order. # Corresponds to the JSON property `symbols` # @return [Array] attr_accessor :symbols @@ -7128,12 +6703,12 @@ module Google class GoogleCloudVisionV1p4beta1AnnotateFileResponse 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::VisionV1p1beta1::Status] attr_accessor :error @@ -7143,8 +6718,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p4beta1InputConfig] attr_accessor :input_config - # Individual responses to images found within the file. This field will be - # empty if the `error` field is set. + # Individual responses to images found within the file. This field will be empty + # if the `error` field is set. # Corresponds to the JSON property `responses` # @return [Array] attr_accessor :responses @@ -7182,12 +6757,12 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p4beta1CropHintsAnnotation] attr_accessor :crop_hints_annotation - # 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::VisionV1p1beta1::Status] attr_accessor :error @@ -7197,13 +6772,12 @@ module Google # @return [Array] attr_accessor :face_annotations - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. # Corresponds to the JSON property `fullTextAnnotation` # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p4beta1TextAnnotation] attr_accessor :full_text_annotation @@ -7223,8 +6797,8 @@ module Google # @return [Array] attr_accessor :landmark_annotations - # If present, localized object detection has completed successfully. - # This will be sorted descending by confidence score. + # If present, localized object detection has completed successfully. This will + # be sorted descending by confidence score. # Corresponds to the JSON property `localizedObjectAnnotations` # @return [Array] attr_accessor :localized_object_annotations @@ -7239,9 +6813,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p4beta1ProductSearchResults] attr_accessor :product_search_results - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). # Corresponds to the JSON property `safeSearchAnnotation` # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p4beta1SafeSearchAnnotation] attr_accessor :safe_search_annotation @@ -7357,14 +6930,14 @@ module Google end end - # Metadata for the batch operations such as the current state. - # This is included in the `metadata` field of the `Operation` returned by the - # `GetOperation` call of the `google::longrunning::Operations` service. + # Metadata for the batch operations such as the current state. This is included + # in the `metadata` field of the `Operation` returned by the `GetOperation` call + # of the `google::longrunning::Operations` service. class GoogleCloudVisionV1p4beta1BatchOperationMetadata include Google::Apis::Core::Hashable - # The time when the batch request is finished and - # google.longrunning.Operation.done is set to true. + # The time when the batch request is finished and google.longrunning.Operation. + # done is set to true. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -7473,8 +7046,7 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the preloaded Celebrity. Has the format - # `builtin/`mid``. + # The resource name of the preloaded Celebrity. Has the format `builtin/`mid``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -7491,123 +7063,61 @@ module Google end end - # Color information consists of RGB channels, score, and the fraction of - # the image that the color occupies in the image. + # Color information consists of RGB channels, score, and the fraction of the + # image that the color occupies in the image. class GoogleCloudVisionV1p4beta1ColorInfo include Google::Apis::Core::Hashable # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... # Corresponds to the JSON property `color` # @return [Google::Apis::VisionV1p1beta1::Color] attr_accessor :color - # The fraction of pixels the color occupies in the image. - # Value in range [0, 1]. + # The fraction of pixels the color occupies in the image. Value in range [0, 1]. # Corresponds to the JSON property `pixelFraction` # @return [Float] attr_accessor :pixel_fraction @@ -7638,7 +7148,7 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p4beta1BoundingPoly] attr_accessor :bounding_poly - # Confidence of this being a salient region. Range [0, 1]. + # Confidence of this being a salient region. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -7708,11 +7218,10 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p4beta1BoundingPoly] attr_accessor :bounding_poly - # **Deprecated. Use `score` instead.** - # The accuracy of the entity detection in an image. - # For example, for an image in which the "Eiffel Tower" entity is detected, - # this field represents the confidence that there is a tower in the query - # image. Range [0, 1]. + # **Deprecated. Use `score` instead.** The accuracy of the entity detection in + # an image. For example, for an image in which the "Eiffel Tower" entity is + # detected, this field represents the confidence that there is a tower in the + # query image. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -7722,30 +7231,29 @@ module Google # @return [String] attr_accessor :description - # The language code for the locale in which the entity textual - # `description` is expressed. + # The language code for the locale in which the entity textual `description` is + # expressed. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale - # The location information for the detected entity. Multiple - # `LocationInfo` elements can be present because one location may - # indicate the location of the scene in the image, and another location - # may indicate the location of the place where the image was taken. - # Location information is usually present for landmarks. + # The location information for the detected entity. Multiple `LocationInfo` + # elements can be present because one location may indicate the location of the + # scene in the image, and another location may indicate the location of the + # place where the image was taken. Location information is usually present for + # landmarks. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `mid` # @return [String] attr_accessor :mid - # Some entities may have optional user-supplied `Property` (name/value) - # fields, such a score or string that qualifies the entity. + # Some entities may have optional user-supplied `Property` (name/value) fields, + # such a score or string that qualifies the entity. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -7755,11 +7263,11 @@ module Google # @return [Float] attr_accessor :score - # The relevancy of the ICA (Image Content Annotation) label to the - # image. For example, the relevancy of "tower" is likely higher to an image - # containing the detected "Eiffel Tower" than to an image containing a - # detected distant towering building, even though the confidence that - # there is a tower in each image may be the same. Range [0, 1]. + # The relevancy of the ICA (Image Content Annotation) label to the image. For + # example, the relevancy of "tower" is likely higher to an image containing the + # detected "Eiffel Tower" than to an image containing a detected distant + # towering building, even though the confidence that there is a tower in each + # image may be the same. Range [0, 1]. # Corresponds to the JSON property `topicality` # @return [Float] attr_accessor :topicality @@ -7832,23 +7340,23 @@ module Google attr_accessor :landmarks # Yaw angle, which indicates the leftward/rightward angle that the face is - # pointing relative to the vertical plane perpendicular to the image. Range - # [-180,180]. + # pointing relative to the vertical plane perpendicular to the image. Range [- + # 180,180]. # Corresponds to the JSON property `panAngle` # @return [Float] attr_accessor :pan_angle - # Additional recognition information. Only computed if - # image_context.face_recognition_params is provided, **and** a match is found - # to a Celebrity in the input CelebritySet. This field is - # sorted in order of decreasing confidence values. + # Additional recognition information. Only computed if image_context. + # face_recognition_params is provided, **and** a match is found to a Celebrity + # in the input CelebritySet. This field is sorted in order of decreasing + # confidence values. # Corresponds to the JSON property `recognitionResult` # @return [Array] attr_accessor :recognition_result - # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation - # of the face relative to the image vertical about the axis perpendicular to - # the face. Range [-180,180]. + # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of + # the face relative to the image vertical about the axis perpendicular to the + # face. Range [-180,180]. # Corresponds to the JSON property `rollAngle` # @return [Float] attr_accessor :roll_angle @@ -7903,9 +7411,9 @@ module Google class GoogleCloudVisionV1p4beta1FaceAnnotationLandmark include Google::Apis::Core::Hashable - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. # Corresponds to the JSON property `position` # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p4beta1Position] attr_accessor :position @@ -7955,24 +7463,20 @@ module Google class GoogleCloudVisionV1p4beta1GcsDestination include Google::Apis::Core::Hashable - # Google Cloud Storage URI prefix where the results will be stored. Results - # will be in JSON format and preceded by its corresponding input URI prefix. - # This field can either represent a gcs file prefix or gcs directory. In - # either case, the uri should be unique because in order to get all of the - # output files, you will need to do a wildcard gcs search on the uri prefix - # you provide. - # Examples: - # * File Prefix: gs://bucket-name/here/filenameprefix The output files - # will be created in gs://bucket-name/here/ and the names of the - # output files will begin with "filenameprefix". - # * Directory Prefix: gs://bucket-name/some/location/ The output files - # will be created in gs://bucket-name/some/location/ and the names of the - # output files could be anything because there was no filename prefix - # specified. - # If multiple outputs, each response is still AnnotateFileResponse, each of - # which contains some subset of the full list of AnnotateImageResponse. - # Multiple outputs can happen if, for example, the output JSON is too large - # and overflows into multiple sharded files. + # Google Cloud Storage URI prefix where the results will be stored. Results will + # be in JSON format and preceded by its corresponding input URI prefix. This + # field can either represent a gcs file prefix or gcs directory. In either case, + # the uri should be unique because in order to get all of the output files, you + # will need to do a wildcard gcs search on the uri prefix you provide. Examples: + # * File Prefix: gs://bucket-name/here/filenameprefix The output files will be + # created in gs://bucket-name/here/ and the names of the output files will begin + # with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The + # output files will be created in gs://bucket-name/some/location/ and the names + # of the output files could be anything because there was no filename prefix + # specified. If multiple outputs, each response is still AnnotateFileResponse, + # each of which contains some subset of the full list of AnnotateImageResponse. + # Multiple outputs can happen if, for example, the output JSON is too large and + # overflows into multiple sharded files. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -7991,8 +7495,8 @@ module Google class GoogleCloudVisionV1p4beta1GcsSource include Google::Apis::Core::Hashable - # Google Cloud Storage URI for the input file. This must only be a - # Google Cloud Storage object. Wildcards are not currently supported. + # Google Cloud Storage URI for the input file. This must only be a Google Cloud + # Storage object. Wildcards are not currently supported. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -8012,8 +7516,8 @@ module Google class GoogleCloudVisionV1p4beta1ImageAnnotationContext include Google::Apis::Core::Hashable - # If the file was a PDF or TIFF, this field gives the page number within - # the file used to produce the image. + # If the file was a PDF or TIFF, this field gives the page number within the + # file used to produce the image. # Corresponds to the JSON property `pageNumber` # @return [Fixnum] attr_accessor :page_number @@ -8053,9 +7557,8 @@ module Google end end - # Response message for the `ImportProductSets` method. - # This message is returned by the - # google.longrunning.Operations.GetOperation method in the returned + # Response message for the `ImportProductSets` method. This message is returned + # by the google.longrunning.Operations.GetOperation method in the returned # google.longrunning.Operation.response field. class GoogleCloudVisionV1p4beta1ImportProductSetsResponse include Google::Apis::Core::Hashable @@ -8065,11 +7568,10 @@ module Google # @return [Array] attr_accessor :reference_images - # The rpc status for each ImportProductSet request, including both successes - # and errors. - # The number of statuses here matches the number of lines in the csv file, - # and statuses[i] stores the success or failure status of processing the i-th - # line of the csv, starting from line 0. + # The rpc status for each ImportProductSet request, including both successes and + # errors. The number of statuses here matches the number of lines in the csv + # file, and statuses[i] stores the success or failure status of processing the i- + # th line of the csv, starting from line 0. # Corresponds to the JSON property `statuses` # @return [Array] attr_accessor :statuses @@ -8089,11 +7591,11 @@ module Google class GoogleCloudVisionV1p4beta1InputConfig include Google::Apis::Core::Hashable - # File content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateFiles requests. It does - # not work for AsyncBatchAnnotateFiles requests. + # File content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -8104,8 +7606,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p4beta1GcsSource] attr_accessor :gcs_source - # The type of the file. Currently only "application/pdf", "image/tiff" and - # "image/gif" are supported. Wildcards are not supported. + # The type of the file. Currently only "application/pdf", "image/tiff" and " + # image/gif" are supported. Wildcards are not supported. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -8131,9 +7633,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p4beta1BoundingPoly] attr_accessor :bounding_poly - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -8173,9 +7674,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::VisionV1p1beta1::LatLng] attr_accessor :lat_lng @@ -8190,9 +7690,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVisionV1p4beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -8252,13 +7751,11 @@ module Google class GoogleCloudVisionV1p4beta1OutputConfig include Google::Apis::Core::Hashable - # The max number of response protos to put into each output JSON file on - # Google Cloud Storage. - # The valid range is [1, 100]. If not specified, the default value is 20. - # For example, for one pdf file with 100 pages, 100 response protos will - # be generated. If `batch_size` = 20, then 5 json files each - # containing 20 response protos will be written under the prefix - # `gcs_destination`.`uri`. + # The max number of response protos to put into each output JSON file on Google + # Cloud Storage. The valid range is [1, 100]. If not specified, the default + # value is 20. For example, for one pdf file with 100 pages, 100 response protos + # will be generated. If `batch_size` = 20, then 5 json files each containing 20 + # response protos will be written under the prefix `gcs_destination`.`uri`. # Currently, batch_size only applies to GcsDestination, with potential future # support for other output configurations. # Corresponds to the JSON property `batchSize` @@ -8295,8 +7792,8 @@ module Google # @return [Float] attr_accessor :confidence - # Page height. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page height. For PDFs the unit is points. For images (including TIFFs) the + # unit is pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -8306,8 +7803,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p4beta1TextAnnotationTextProperty] attr_accessor :property - # Page width. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page width. For PDFs the unit is points. For images (including TIFFs) the unit + # is pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -8363,9 +7860,9 @@ module Google end end - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. class GoogleCloudVisionV1p4beta1Position include Google::Apis::Core::Hashable @@ -8412,33 +7909,28 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the product. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - # This field is ignored when creating a product. + # The resource name of the product. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Immutable. The category for the product identified by the reference image. - # This should - # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories - # "homegoods", "apparel", and "toys" are still supported, but these should - # not be used for new products. + # This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods- + # v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" + # are still supported, but these should not be used for new products. # Corresponds to the JSON property `productCategory` # @return [String] attr_accessor :product_category - # Key-value pairs that can be attached to a product. At query time, - # constraints can be specified based on the product_labels. - # Note that integer values can be provided as strings, e.g. "1199". Only - # strings with integer values can match a range-based restriction which is - # to be supported soon. - # Multiple values can be assigned to the same key. One product may have up to - # 500 product_labels. - # Notice that the total number of distinct product_labels over all products - # in one ProductSet cannot exceed 1M, otherwise the product search pipeline - # will refuse to work for that ProductSet. + # Key-value pairs that can be attached to a product. At query time, constraints + # can be specified based on the product_labels. Note that integer values can be + # provided as strings, e.g. "1199". Only strings with integer values can match a + # range-based restriction which is to be supported soon. Multiple values can be + # assigned to the same key. One product may have up to 500 product_labels. + # Notice that the total number of distinct product_labels over all products in + # one ProductSet cannot exceed 1M, otherwise the product search pipeline will + # refuse to work for that ProductSet. # Corresponds to the JSON property `productLabels` # @return [Array] attr_accessor :product_labels @@ -8467,8 +7959,8 @@ module Google # @return [String] attr_accessor :key - # The value of the label attached to the product. Cannot be empty and - # cannot exceed 128 bytes. + # The value of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -8489,8 +7981,8 @@ module Google include Google::Apis::Core::Hashable # Timestamp of the index which provided these results. Products added to the - # product set and products removed from the product set after this time are - # not reflected in the current results. + # product set and products removed from the product set after this time are not + # reflected in the current results. # Corresponds to the JSON property `indexTime` # @return [String] attr_accessor :index_time @@ -8520,8 +8012,7 @@ module Google end end - # Information about the products similar to a single product in a query - # image. + # Information about the products similar to a single product in a query image. class GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult include Google::Apis::Core::Hashable @@ -8556,9 +8047,8 @@ module Google class GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation include Google::Apis::Core::Hashable - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -8595,8 +8085,8 @@ module Google class GoogleCloudVisionV1p4beta1ProductSearchResultsResult include Google::Apis::Core::Hashable - # The resource name of the image from the product that is the closest match - # to the query. + # The resource name of the image from the product that is the closest match to + # the query. # Corresponds to the JSON property `image` # @return [String] attr_accessor :image @@ -8606,8 +8096,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p4beta1Product] attr_accessor :product - # A confidence level on the match, ranging from 0 (no confidence) to - # 1 (full confidence). + # A confidence level on the match, ranging from 0 (no confidence) to 1 (full + # confidence). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -8661,28 +8151,24 @@ module Google include Google::Apis::Core::Hashable # Optional. Bounding polygons around the areas of interest in the reference - # image. - # If this field is empty, the system will try to detect regions of - # interest. At most 10 bounding polygons will be used. - # The provided shape is converted into a non-rotated rectangle. Once - # converted, the small edge of the rectangle must be greater than or equal - # to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 - # is not). + # image. If this field is empty, the system will try to detect regions of + # interest. At most 10 bounding polygons will be used. The provided shape is + # converted into a non-rotated rectangle. Once converted, the small edge of the + # rectangle must be greater than or equal to 300 pixels. The aspect ratio must + # be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). # Corresponds to the JSON property `boundingPolys` # @return [Array] attr_accessor :bounding_polys - # The resource name of the reference image. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ - # IMAGE_ID`. - # This field is ignored when creating a reference image. + # The resource name of the reference image. Format is: `projects/PROJECT_ID/ + # locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is + # ignored when creating a reference image. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The Google Cloud Storage URI of the reference image. - # The URI must start with `gs://`. + # Required. The Google Cloud Storage URI of the reference image. The URI must + # start with `gs://`. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -8699,15 +8185,14 @@ module Google end end - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). class GoogleCloudVisionV1p4beta1SafeSearchAnnotation include Google::Apis::Core::Hashable # Represents the adult content likelihood for the image. Adult content may - # contain elements such as nudity, pornographic images or cartoons, or - # sexual activities. + # contain elements such as nudity, pornographic images or cartoons, or sexual + # activities. # Corresponds to the JSON property `adult` # @return [String] attr_accessor :adult @@ -8719,15 +8204,14 @@ module Google # Likelihood that the request image contains racy content. Racy content may # include (but is not limited to) skimpy or sheer clothing, strategically - # covered nudity, lewd or provocative poses, or close-ups of sensitive - # body areas. + # covered nudity, lewd or provocative poses, or close-ups of sensitive body + # areas. # Corresponds to the JSON property `racy` # @return [String] attr_accessor :racy - # Spoof likelihood. The likelihood that an modification - # was made to the image's canonical version to make it appear - # funny or offensive. + # Spoof likelihood. The likelihood that an modification was made to the image's + # canonical version to make it appear funny or offensive. # Corresponds to the JSON property `spoof` # @return [String] attr_accessor :spoof @@ -8788,13 +8272,12 @@ module Google end end - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. class GoogleCloudVisionV1p4beta1TextAnnotation include Google::Apis::Core::Hashable @@ -8854,9 +8337,8 @@ module Google # @return [Float] attr_accessor :confidence - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -8897,8 +8379,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the vertex coordinates are in the same scale as the original image. + # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are + # in the same scale as the original image. class GoogleCloudVisionV1p4beta1Vertex include Google::Apis::Core::Hashable @@ -8927,14 +8409,14 @@ module Google class GoogleCloudVisionV1p4beta1WebDetection include Google::Apis::Core::Hashable - # The service's best guess as to the topic of the request image. - # Inferred from similar images on the open web. + # The service's best guess as to the topic of the request image. Inferred from + # similar images on the open web. # Corresponds to the JSON property `bestGuessLabels` # @return [Array] attr_accessor :best_guess_labels - # Fully matching images from the Internet. - # Can include resized copies of the query image. + # Fully matching images from the Internet. Can include resized copies of the + # query image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -8944,9 +8426,9 @@ module Google # @return [Array] attr_accessor :pages_with_matching_images - # Partial matching images from the Internet. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its crops. + # Partial matching images from the Internet. Those images are similar enough to + # share some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -8990,8 +8472,8 @@ module Google # @return [String] attr_accessor :entity_id - # Overall relevancy score for the entity. - # Not normalized and not comparable across different image queries. + # Overall relevancy score for the entity. Not normalized and not comparable + # across different image queries. # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -9042,9 +8524,9 @@ module Google # @return [String] attr_accessor :label - # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - # For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more + # information, see http://www.unicode.org/reports/tr35/# + # Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -9064,8 +8546,8 @@ module Google class GoogleCloudVisionV1p4beta1WebDetectionWebPage include Google::Apis::Core::Hashable - # Fully matching images on the page. - # Can include resized copies of the query image. + # Fully matching images on the page. Can include resized copies of the query + # image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -9075,10 +8557,9 @@ module Google # @return [String] attr_accessor :page_title - # Partial matching images on the page. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its - # crops. + # Partial matching images on the page. Those images are similar enough to share + # some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -9126,8 +8607,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p4beta1TextAnnotationTextProperty] attr_accessor :property - # List of symbols in the word. - # The order of the symbols follows the natural reading order. + # List of symbols in the word. The order of the symbols follows the natural + # reading order. # Corresponds to the JSON property `symbols` # @return [Array] attr_accessor :symbols @@ -9145,8 +8626,7 @@ module Google end end - # Information about the products similar to a single product in a query - # image. + # Information about the products similar to a single product in a query image. class GroupedResult include Google::Apis::Core::Hashable @@ -9182,8 +8662,8 @@ module Google class ImageAnnotationContext include Google::Apis::Core::Hashable - # If the file was a PDF or TIFF, this field gives the page number within - # the file used to produce the image. + # If the file was a PDF or TIFF, this field gives the page number within the + # file used to produce the image. # Corresponds to the JSON property `pageNumber` # @return [Fixnum] attr_accessor :page_number @@ -9223,9 +8703,8 @@ module Google end end - # Response message for the `ImportProductSets` method. - # This message is returned by the - # google.longrunning.Operations.GetOperation method in the returned + # Response message for the `ImportProductSets` method. This message is returned + # by the google.longrunning.Operations.GetOperation method in the returned # google.longrunning.Operation.response field. class ImportProductSetsResponse include Google::Apis::Core::Hashable @@ -9235,11 +8714,10 @@ module Google # @return [Array] attr_accessor :reference_images - # The rpc status for each ImportProductSet request, including both successes - # and errors. - # The number of statuses here matches the number of lines in the csv file, - # and statuses[i] stores the success or failure status of processing the i-th - # line of the csv, starting from line 0. + # The rpc status for each ImportProductSet request, including both successes and + # errors. The number of statuses here matches the number of lines in the csv + # file, and statuses[i] stores the success or failure status of processing the i- + # th line of the csv, starting from line 0. # Corresponds to the JSON property `statuses` # @return [Array] attr_accessor :statuses @@ -9259,11 +8737,11 @@ module Google class InputConfig include Google::Apis::Core::Hashable - # File content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateFiles requests. It does - # not work for AsyncBatchAnnotateFiles requests. + # File content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -9274,8 +8752,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::GcsSource] attr_accessor :gcs_source - # The type of the file. Currently only "application/pdf", "image/tiff" and - # "image/gif" are supported. Wildcards are not supported. + # The type of the file. Currently only "application/pdf", "image/tiff" and " + # image/gif" are supported. Wildcards are not supported. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -9302,8 +8780,8 @@ module Google # @return [String] attr_accessor :key - # The value of the label attached to the product. Cannot be empty and - # cannot exceed 128 bytes. + # The value of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -9323,9 +8801,9 @@ module Google class Landmark include Google::Apis::Core::Hashable - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. # Corresponds to the JSON property `position` # @return [Google::Apis::VisionV1p1beta1::Position] attr_accessor :position @@ -9348,9 +8826,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. class LatLng include Google::Apis::Core::Hashable @@ -9384,9 +8861,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::BoundingPoly] attr_accessor :bounding_poly - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -9426,9 +8902,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::VisionV1p1beta1::LatLng] attr_accessor :lat_lng @@ -9443,9 +8918,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class NormalizedVertex include Google::Apis::Core::Hashable @@ -9474,9 +8948,8 @@ module Google class ObjectAnnotation include Google::Apis::Core::Hashable - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -9514,47 +8987,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::VisionV1p1beta1::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 @@ -9608,13 +9079,11 @@ module Google class OutputConfig include Google::Apis::Core::Hashable - # The max number of response protos to put into each output JSON file on - # Google Cloud Storage. - # The valid range is [1, 100]. If not specified, the default value is 20. - # For example, for one pdf file with 100 pages, 100 response protos will - # be generated. If `batch_size` = 20, then 5 json files each - # containing 20 response protos will be written under the prefix - # `gcs_destination`.`uri`. + # The max number of response protos to put into each output JSON file on Google + # Cloud Storage. The valid range is [1, 100]. If not specified, the default + # value is 20. For example, for one pdf file with 100 pages, 100 response protos + # will be generated. If `batch_size` = 20, then 5 json files each containing 20 + # response protos will be written under the prefix `gcs_destination`.`uri`. # Currently, batch_size only applies to GcsDestination, with potential future # support for other output configurations. # Corresponds to the JSON property `batchSize` @@ -9651,8 +9120,8 @@ module Google # @return [Float] attr_accessor :confidence - # Page height. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page height. For PDFs the unit is points. For images (including TIFFs) the + # unit is pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -9662,8 +9131,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::TextProperty] attr_accessor :property - # Page width. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page width. For PDFs the unit is points. For images (including TIFFs) the unit + # is pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -9719,9 +9188,9 @@ module Google end end - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. class Position include Google::Apis::Core::Hashable @@ -9768,33 +9237,28 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the product. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - # This field is ignored when creating a product. + # The resource name of the product. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Immutable. The category for the product identified by the reference image. - # This should - # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories - # "homegoods", "apparel", and "toys" are still supported, but these should - # not be used for new products. + # This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods- + # v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" + # are still supported, but these should not be used for new products. # Corresponds to the JSON property `productCategory` # @return [String] attr_accessor :product_category - # Key-value pairs that can be attached to a product. At query time, - # constraints can be specified based on the product_labels. - # Note that integer values can be provided as strings, e.g. "1199". Only - # strings with integer values can match a range-based restriction which is - # to be supported soon. - # Multiple values can be assigned to the same key. One product may have up to - # 500 product_labels. - # Notice that the total number of distinct product_labels over all products - # in one ProductSet cannot exceed 1M, otherwise the product search pipeline - # will refuse to work for that ProductSet. + # Key-value pairs that can be attached to a product. At query time, constraints + # can be specified based on the product_labels. Note that integer values can be + # provided as strings, e.g. "1199". Only strings with integer values can match a + # range-based restriction which is to be supported soon. Multiple values can be + # assigned to the same key. One product may have up to 500 product_labels. + # Notice that the total number of distinct product_labels over all products in + # one ProductSet cannot exceed 1M, otherwise the product search pipeline will + # refuse to work for that ProductSet. # Corresponds to the JSON property `productLabels` # @return [Array] attr_accessor :product_labels @@ -9818,8 +9282,8 @@ module Google include Google::Apis::Core::Hashable # Timestamp of the index which provided these results. Products added to the - # product set and products removed from the product set after this time are - # not reflected in the current results. + # product set and products removed from the product set after this time are not + # reflected in the current results. # Corresponds to the JSON property `indexTime` # @return [String] attr_accessor :index_time @@ -9886,28 +9350,24 @@ module Google include Google::Apis::Core::Hashable # Optional. Bounding polygons around the areas of interest in the reference - # image. - # If this field is empty, the system will try to detect regions of - # interest. At most 10 bounding polygons will be used. - # The provided shape is converted into a non-rotated rectangle. Once - # converted, the small edge of the rectangle must be greater than or equal - # to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 - # is not). + # image. If this field is empty, the system will try to detect regions of + # interest. At most 10 bounding polygons will be used. The provided shape is + # converted into a non-rotated rectangle. Once converted, the small edge of the + # rectangle must be greater than or equal to 300 pixels. The aspect ratio must + # be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). # Corresponds to the JSON property `boundingPolys` # @return [Array] attr_accessor :bounding_polys - # The resource name of the reference image. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ - # IMAGE_ID`. - # This field is ignored when creating a reference image. + # The resource name of the reference image. Format is: `projects/PROJECT_ID/ + # locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is + # ignored when creating a reference image. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The Google Cloud Storage URI of the reference image. - # The URI must start with `gs://`. + # Required. The Google Cloud Storage URI of the reference image. The URI must + # start with `gs://`. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -9928,8 +9388,8 @@ module Google class Result include Google::Apis::Core::Hashable - # The resource name of the image from the product that is the closest match - # to the query. + # The resource name of the image from the product that is the closest match to + # the query. # Corresponds to the JSON property `image` # @return [String] attr_accessor :image @@ -9939,8 +9399,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::Product] attr_accessor :product - # A confidence level on the match, ranging from 0 (no confidence) to - # 1 (full confidence). + # A confidence level on the match, ranging from 0 (no confidence) to 1 (full + # confidence). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -9957,15 +9417,14 @@ module Google end end - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). class SafeSearchAnnotation include Google::Apis::Core::Hashable # Represents the adult content likelihood for the image. Adult content may - # contain elements such as nudity, pornographic images or cartoons, or - # sexual activities. + # contain elements such as nudity, pornographic images or cartoons, or sexual + # activities. # Corresponds to the JSON property `adult` # @return [String] attr_accessor :adult @@ -9977,15 +9436,14 @@ module Google # Likelihood that the request image contains racy content. Racy content may # include (but is not limited to) skimpy or sheer clothing, strategically - # covered nudity, lewd or provocative poses, or close-ups of sensitive - # body areas. + # covered nudity, lewd or provocative poses, or close-ups of sensitive body + # areas. # Corresponds to the JSON property `racy` # @return [String] attr_accessor :racy - # Spoof likelihood. The likelihood that an modification - # was made to the image's canonical version to make it appear - # funny or offensive. + # Spoof likelihood. The likelihood that an modification was made to the image's + # canonical version to make it appear funny or offensive. # Corresponds to the JSON property `spoof` # @return [String] attr_accessor :spoof @@ -10009,12 +9467,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 @@ -10023,15 +9481,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 @@ -10085,13 +9543,12 @@ module Google end end - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. class TextAnnotation include Google::Apis::Core::Hashable @@ -10141,8 +9598,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the vertex coordinates are in the same scale as the original image. + # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are + # in the same scale as the original image. class Vertex include Google::Apis::Core::Hashable @@ -10171,14 +9628,14 @@ module Google class WebDetection include Google::Apis::Core::Hashable - # The service's best guess as to the topic of the request image. - # Inferred from similar images on the open web. + # The service's best guess as to the topic of the request image. Inferred from + # similar images on the open web. # Corresponds to the JSON property `bestGuessLabels` # @return [Array] attr_accessor :best_guess_labels - # Fully matching images from the Internet. - # Can include resized copies of the query image. + # Fully matching images from the Internet. Can include resized copies of the + # query image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -10188,9 +9645,9 @@ module Google # @return [Array] attr_accessor :pages_with_matching_images - # Partial matching images from the Internet. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its crops. + # Partial matching images from the Internet. Those images are similar enough to + # share some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -10234,8 +9691,8 @@ module Google # @return [String] attr_accessor :entity_id - # Overall relevancy score for the entity. - # Not normalized and not comparable across different image queries. + # Overall relevancy score for the entity. Not normalized and not comparable + # across different image queries. # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -10286,9 +9743,9 @@ module Google # @return [String] attr_accessor :label - # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - # For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more + # information, see http://www.unicode.org/reports/tr35/# + # Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -10308,8 +9765,8 @@ module Google class WebPage include Google::Apis::Core::Hashable - # Fully matching images on the page. - # Can include resized copies of the query image. + # Fully matching images on the page. Can include resized copies of the query + # image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -10319,10 +9776,9 @@ module Google # @return [String] attr_accessor :page_title - # Partial matching images on the page. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its - # crops. + # Partial matching images on the page. Those images are similar enough to share + # some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -10370,8 +9826,8 @@ module Google # @return [Google::Apis::VisionV1p1beta1::TextProperty] attr_accessor :property - # List of symbols in the word. - # The order of the symbols follows the natural reading order. + # List of symbols in the word. The order of the symbols follows the natural + # reading order. # Corresponds to the JSON property `symbols` # @return [Array] attr_accessor :symbols diff --git a/generated/google/apis/vision_v1p1beta1/service.rb b/generated/google/apis/vision_v1p1beta1/service.rb index 37ed0bb96..95937a6e7 100644 --- a/generated/google/apis/vision_v1p1beta1/service.rb +++ b/generated/google/apis/vision_v1p1beta1/service.rb @@ -49,12 +49,11 @@ module Google @batch_path = 'batch' end - # Service that performs image detection and annotation for a batch of files. - # Now only "application/pdf", "image/tiff" and "image/gif" are supported. - # This service will extract at most 5 (customers can specify which 5 in - # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each - # file provided and perform detection and annotation for each image - # extracted. + # Service that performs image detection and annotation for a batch of files. Now + # only "application/pdf", "image/tiff" and "image/gif" are supported. This + # service will extract at most 5 (customers can specify which 5 in + # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file + # provided and perform detection and annotation for each image extracted. # @param [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest] google_cloud_vision_v1p1beta1_batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -84,12 +83,12 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of generic - # files, such as PDF files, which may contain multiple pages and multiple - # images per page. Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). + # Run asynchronous image detection and annotation for a list of generic files, + # such as PDF files, which may contain multiple pages and multiple images per + # page. Progress and results can be retrieved through the `google.longrunning. + # Operations` interface. `Operation.metadata` contains `OperationMetadata` ( + # metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` ( + # results). # @param [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest] google_cloud_vision_v1p1beta1_async_batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -149,13 +148,12 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of images. - # Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). - # This service will write image annotation outputs to json files in customer - # GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + # Run asynchronous image detection and annotation for a list of images. Progress + # and results can be retrieved through the `google.longrunning.Operations` + # interface. `Operation.metadata` contains `OperationMetadata` (metadata). ` + # Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). + # This service will write image annotation outputs to json files in customer GCS + # bucket, each json file containing BatchAnnotateImagesResponse proto. # @param [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest] google_cloud_vision_v1p1beta1_async_batch_annotate_images_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -185,21 +183,17 @@ module Google execute_or_queue_command(command, &block) end - # Service that performs image detection and annotation for a batch of files. - # Now only "application/pdf", "image/tiff" and "image/gif" are supported. - # This service will extract at most 5 (customers can specify which 5 in - # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each - # file provided and perform detection and annotation for each image - # extracted. + # Service that performs image detection and annotation for a batch of files. Now + # only "application/pdf", "image/tiff" and "image/gif" are supported. This + # service will extract at most 5 (customers can specify which 5 in + # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file + # provided and perform detection and annotation for each image extracted. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest] google_cloud_vision_v1p1beta1_batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -230,21 +224,18 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of generic - # files, such as PDF files, which may contain multiple pages and multiple - # images per page. Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). + # Run asynchronous image detection and annotation for a list of generic files, + # such as PDF files, which may contain multiple pages and multiple images per + # page. Progress and results can be retrieved through the `google.longrunning. + # Operations` interface. `Operation.metadata` contains `OperationMetadata` ( + # metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` ( + # results). # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest] google_cloud_vision_v1p1beta1_async_batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -277,14 +268,11 @@ module Google # Run image detection and annotation for a batch of images. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest] google_cloud_vision_v1p1beta1_batch_annotate_images_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -315,22 +303,18 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of images. - # Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). - # This service will write image annotation outputs to json files in customer - # GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + # Run asynchronous image detection and annotation for a list of images. Progress + # and results can be retrieved through the `google.longrunning.Operations` + # interface. `Operation.metadata` contains `OperationMetadata` (metadata). ` + # Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). + # This service will write image annotation outputs to json files in customer GCS + # bucket, each json file containing BatchAnnotateImagesResponse proto. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest] google_cloud_vision_v1p1beta1_async_batch_annotate_images_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -361,21 +345,17 @@ module Google execute_or_queue_command(command, &block) end - # Service that performs image detection and annotation for a batch of files. - # Now only "application/pdf", "image/tiff" and "image/gif" are supported. - # This service will extract at most 5 (customers can specify which 5 in - # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each - # file provided and perform detection and annotation for each image - # extracted. + # Service that performs image detection and annotation for a batch of files. Now + # only "application/pdf", "image/tiff" and "image/gif" are supported. This + # service will extract at most 5 (customers can specify which 5 in + # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file + # provided and perform detection and annotation for each image extracted. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateFilesRequest] google_cloud_vision_v1p1beta1_batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -406,21 +386,18 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of generic - # files, such as PDF files, which may contain multiple pages and multiple - # images per page. Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). + # Run asynchronous image detection and annotation for a list of generic files, + # such as PDF files, which may contain multiple pages and multiple images per + # page. Progress and results can be retrieved through the `google.longrunning. + # Operations` interface. `Operation.metadata` contains `OperationMetadata` ( + # metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` ( + # results). # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AsyncBatchAnnotateFilesRequest] google_cloud_vision_v1p1beta1_async_batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -453,14 +430,11 @@ module Google # Run image detection and annotation for a batch of images. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest] google_cloud_vision_v1p1beta1_batch_annotate_images_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -491,22 +465,18 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of images. - # Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). - # This service will write image annotation outputs to json files in customer - # GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + # Run asynchronous image detection and annotation for a list of images. Progress + # and results can be retrieved through the `google.longrunning.Operations` + # interface. `Operation.metadata` contains `OperationMetadata` (metadata). ` + # Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). + # This service will write image annotation outputs to json files in customer GCS + # bucket, each json file containing BatchAnnotateImagesResponse proto. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1p1beta1::GoogleCloudVisionV1p1beta1AsyncBatchAnnotateImagesRequest] google_cloud_vision_v1p1beta1_async_batch_annotate_images_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. diff --git a/generated/google/apis/vision_v1p2beta1.rb b/generated/google/apis/vision_v1p2beta1.rb index 42fac71a9..5f57d2d38 100644 --- a/generated/google/apis/vision_v1p2beta1.rb +++ b/generated/google/apis/vision_v1p2beta1.rb @@ -27,7 +27,7 @@ module Google # @see https://cloud.google.com/vision/ module VisionV1p2beta1 VERSION = 'V1p2beta1' - REVISION = '20200710' + 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/vision_v1p2beta1/classes.rb b/generated/google/apis/vision_v1p2beta1/classes.rb index 083e2ee44..6271f9d52 100644 --- a/generated/google/apis/vision_v1p2beta1/classes.rb +++ b/generated/google/apis/vision_v1p2beta1/classes.rb @@ -27,12 +27,12 @@ module Google class AnnotateFileResponse 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::VisionV1p2beta1::Status] attr_accessor :error @@ -42,8 +42,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::InputConfig] attr_accessor :input_config - # Individual responses to images found within the file. This field will be - # empty if the `error` field is set. + # Individual responses to images found within the file. This field will be empty + # if the `error` field is set. # Corresponds to the JSON property `responses` # @return [Array] attr_accessor :responses @@ -81,12 +81,12 @@ module Google # @return [Google::Apis::VisionV1p2beta1::CropHintsAnnotation] attr_accessor :crop_hints_annotation - # 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::VisionV1p2beta1::Status] attr_accessor :error @@ -96,13 +96,12 @@ module Google # @return [Array] attr_accessor :face_annotations - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. # Corresponds to the JSON property `fullTextAnnotation` # @return [Google::Apis::VisionV1p2beta1::TextAnnotation] attr_accessor :full_text_annotation @@ -122,8 +121,8 @@ module Google # @return [Array] attr_accessor :landmark_annotations - # If present, localized object detection has completed successfully. - # This will be sorted descending by confidence score. + # If present, localized object detection has completed successfully. This will + # be sorted descending by confidence score. # Corresponds to the JSON property `localizedObjectAnnotations` # @return [Array] attr_accessor :localized_object_annotations @@ -138,9 +137,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::ProductSearchResults] attr_accessor :product_search_results - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). # Corresponds to the JSON property `safeSearchAnnotation` # @return [Google::Apis::VisionV1p2beta1::SafeSearchAnnotation] attr_accessor :safe_search_annotation @@ -256,14 +254,14 @@ module Google end end - # Metadata for the batch operations such as the current state. - # This is included in the `metadata` field of the `Operation` returned by the - # `GetOperation` call of the `google::longrunning::Operations` service. + # Metadata for the batch operations such as the current state. This is included + # in the `metadata` field of the `Operation` returned by the `GetOperation` call + # of the `google::longrunning::Operations` service. class BatchOperationMetadata include Google::Apis::Core::Hashable - # The time when the batch request is finished and - # google.longrunning.Operation.done is set to true. + # The time when the batch request is finished and google.longrunning.Operation. + # done is set to true. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -360,122 +358,61 @@ module Google # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... class Color include Google::Apis::Core::Hashable - # The fraction of this color that should be applied to the pixel. That is, - # the final pixel color is defined by the equation: - # pixel color = alpha * (this color) + (1.0 - alpha) * (background color) - # This means that a value of 1.0 corresponds to a solid color, whereas - # a value of 0.0 corresponds to a completely transparent color. This - # uses a wrapper message rather than a simple float scalar so that it is - # possible to distinguish between a default value and the value being unset. - # If omitted, this color object is to be rendered as a solid color - # (as if the alpha value had been explicitly given with a value of 1.0). + # The fraction of this color that should be applied to the pixel. That is, the + # final pixel color is defined by the equation: pixel color = alpha * (this + # color) + (1.0 - alpha) * (background color) This means that a value of 1.0 + # corresponds to a solid color, whereas a value of 0.0 corresponds to a + # completely transparent color. This uses a wrapper message rather than a simple + # float scalar so that it is possible to distinguish between a default value and + # the value being unset. If omitted, this color object is to be rendered as a + # solid color (as if the alpha value had been explicitly given with a value of 1. + # 0). # Corresponds to the JSON property `alpha` # @return [Float] attr_accessor :alpha @@ -508,123 +445,61 @@ module Google end end - # Color information consists of RGB channels, score, and the fraction of - # the image that the color occupies in the image. + # Color information consists of RGB channels, score, and the fraction of the + # image that the color occupies in the image. class ColorInfo include Google::Apis::Core::Hashable # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... # Corresponds to the JSON property `color` # @return [Google::Apis::VisionV1p2beta1::Color] attr_accessor :color - # The fraction of pixels the color occupies in the image. - # Value in range [0, 1]. + # The fraction of pixels the color occupies in the image. Value in range [0, 1]. # Corresponds to the JSON property `pixelFraction` # @return [Float] attr_accessor :pixel_fraction @@ -655,7 +530,7 @@ module Google # @return [Google::Apis::VisionV1p2beta1::BoundingPoly] attr_accessor :bounding_poly - # Confidence of this being a salient region. Range [0, 1]. + # Confidence of this being a salient region. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -732,9 +607,8 @@ module Google # @return [Float] attr_accessor :confidence - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -778,11 +652,10 @@ module Google # @return [Google::Apis::VisionV1p2beta1::BoundingPoly] attr_accessor :bounding_poly - # **Deprecated. Use `score` instead.** - # The accuracy of the entity detection in an image. - # For example, for an image in which the "Eiffel Tower" entity is detected, - # this field represents the confidence that there is a tower in the query - # image. Range [0, 1]. + # **Deprecated. Use `score` instead.** The accuracy of the entity detection in + # an image. For example, for an image in which the "Eiffel Tower" entity is + # detected, this field represents the confidence that there is a tower in the + # query image. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -792,30 +665,29 @@ module Google # @return [String] attr_accessor :description - # The language code for the locale in which the entity textual - # `description` is expressed. + # The language code for the locale in which the entity textual `description` is + # expressed. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale - # The location information for the detected entity. Multiple - # `LocationInfo` elements can be present because one location may - # indicate the location of the scene in the image, and another location - # may indicate the location of the place where the image was taken. - # Location information is usually present for landmarks. + # The location information for the detected entity. Multiple `LocationInfo` + # elements can be present because one location may indicate the location of the + # scene in the image, and another location may indicate the location of the + # place where the image was taken. Location information is usually present for + # landmarks. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `mid` # @return [String] attr_accessor :mid - # Some entities may have optional user-supplied `Property` (name/value) - # fields, such a score or string that qualifies the entity. + # Some entities may have optional user-supplied `Property` (name/value) fields, + # such a score or string that qualifies the entity. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -825,11 +697,11 @@ module Google # @return [Float] attr_accessor :score - # The relevancy of the ICA (Image Content Annotation) label to the - # image. For example, the relevancy of "tower" is likely higher to an image - # containing the detected "Eiffel Tower" than to an image containing a - # detected distant towering building, even though the confidence that - # there is a tower in each image may be the same. Range [0, 1]. + # The relevancy of the ICA (Image Content Annotation) label to the image. For + # example, the relevancy of "tower" is likely higher to an image containing the + # detected "Eiffel Tower" than to an image containing a detected distant + # towering building, even though the confidence that there is a tower in each + # image may be the same. Range [0, 1]. # Corresponds to the JSON property `topicality` # @return [Float] attr_accessor :topicality @@ -902,15 +774,15 @@ module Google attr_accessor :landmarks # Yaw angle, which indicates the leftward/rightward angle that the face is - # pointing relative to the vertical plane perpendicular to the image. Range - # [-180,180]. + # pointing relative to the vertical plane perpendicular to the image. Range [- + # 180,180]. # Corresponds to the JSON property `panAngle` # @return [Float] attr_accessor :pan_angle - # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation - # of the face relative to the image vertical about the axis perpendicular to - # the face. Range [-180,180]. + # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of + # the face relative to the image vertical about the axis perpendicular to the + # face. Range [-180,180]. # Corresponds to the JSON property `rollAngle` # @return [Float] attr_accessor :roll_angle @@ -964,24 +836,20 @@ module Google class GcsDestination include Google::Apis::Core::Hashable - # Google Cloud Storage URI prefix where the results will be stored. Results - # will be in JSON format and preceded by its corresponding input URI prefix. - # This field can either represent a gcs file prefix or gcs directory. In - # either case, the uri should be unique because in order to get all of the - # output files, you will need to do a wildcard gcs search on the uri prefix - # you provide. - # Examples: - # * File Prefix: gs://bucket-name/here/filenameprefix The output files - # will be created in gs://bucket-name/here/ and the names of the - # output files will begin with "filenameprefix". - # * Directory Prefix: gs://bucket-name/some/location/ The output files - # will be created in gs://bucket-name/some/location/ and the names of the - # output files could be anything because there was no filename prefix - # specified. - # If multiple outputs, each response is still AnnotateFileResponse, each of - # which contains some subset of the full list of AnnotateImageResponse. - # Multiple outputs can happen if, for example, the output JSON is too large - # and overflows into multiple sharded files. + # Google Cloud Storage URI prefix where the results will be stored. Results will + # be in JSON format and preceded by its corresponding input URI prefix. This + # field can either represent a gcs file prefix or gcs directory. In either case, + # the uri should be unique because in order to get all of the output files, you + # will need to do a wildcard gcs search on the uri prefix you provide. Examples: + # * File Prefix: gs://bucket-name/here/filenameprefix The output files will be + # created in gs://bucket-name/here/ and the names of the output files will begin + # with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The + # output files will be created in gs://bucket-name/some/location/ and the names + # of the output files could be anything because there was no filename prefix + # specified. If multiple outputs, each response is still AnnotateFileResponse, + # each of which contains some subset of the full list of AnnotateImageResponse. + # Multiple outputs can happen if, for example, the output JSON is too large and + # overflows into multiple sharded files. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -1000,8 +868,8 @@ module Google class GcsSource include Google::Apis::Core::Hashable - # Google Cloud Storage URI for the input file. This must only be a - # Google Cloud Storage object. Wildcards are not currently supported. + # Google Cloud Storage URI for the input file. This must only be a Google Cloud + # Storage object. Wildcards are not currently supported. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -1021,12 +889,12 @@ module Google class GoogleCloudVisionV1p1beta1AnnotateFileResponse 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::VisionV1p2beta1::Status] attr_accessor :error @@ -1036,8 +904,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1InputConfig] attr_accessor :input_config - # Individual responses to images found within the file. This field will be - # empty if the `error` field is set. + # Individual responses to images found within the file. This field will be empty + # if the `error` field is set. # Corresponds to the JSON property `responses` # @return [Array] attr_accessor :responses @@ -1075,12 +943,12 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1CropHintsAnnotation] attr_accessor :crop_hints_annotation - # 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::VisionV1p2beta1::Status] attr_accessor :error @@ -1090,13 +958,12 @@ module Google # @return [Array] attr_accessor :face_annotations - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. # Corresponds to the JSON property `fullTextAnnotation` # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1TextAnnotation] attr_accessor :full_text_annotation @@ -1116,8 +983,8 @@ module Google # @return [Array] attr_accessor :landmark_annotations - # If present, localized object detection has completed successfully. - # This will be sorted descending by confidence score. + # If present, localized object detection has completed successfully. This will + # be sorted descending by confidence score. # Corresponds to the JSON property `localizedObjectAnnotations` # @return [Array] attr_accessor :localized_object_annotations @@ -1132,9 +999,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1ProductSearchResults] attr_accessor :product_search_results - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). # Corresponds to the JSON property `safeSearchAnnotation` # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1SafeSearchAnnotation] attr_accessor :safe_search_annotation @@ -1279,123 +1145,61 @@ module Google end end - # Color information consists of RGB channels, score, and the fraction of - # the image that the color occupies in the image. + # Color information consists of RGB channels, score, and the fraction of the + # image that the color occupies in the image. class GoogleCloudVisionV1p1beta1ColorInfo include Google::Apis::Core::Hashable # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... # Corresponds to the JSON property `color` # @return [Google::Apis::VisionV1p2beta1::Color] attr_accessor :color - # The fraction of pixels the color occupies in the image. - # Value in range [0, 1]. + # The fraction of pixels the color occupies in the image. Value in range [0, 1]. # Corresponds to the JSON property `pixelFraction` # @return [Float] attr_accessor :pixel_fraction @@ -1426,7 +1230,7 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1BoundingPoly] attr_accessor :bounding_poly - # Confidence of this being a salient region. Range [0, 1]. + # Confidence of this being a salient region. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -1496,11 +1300,10 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1BoundingPoly] attr_accessor :bounding_poly - # **Deprecated. Use `score` instead.** - # The accuracy of the entity detection in an image. - # For example, for an image in which the "Eiffel Tower" entity is detected, - # this field represents the confidence that there is a tower in the query - # image. Range [0, 1]. + # **Deprecated. Use `score` instead.** The accuracy of the entity detection in + # an image. For example, for an image in which the "Eiffel Tower" entity is + # detected, this field represents the confidence that there is a tower in the + # query image. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -1510,30 +1313,29 @@ module Google # @return [String] attr_accessor :description - # The language code for the locale in which the entity textual - # `description` is expressed. + # The language code for the locale in which the entity textual `description` is + # expressed. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale - # The location information for the detected entity. Multiple - # `LocationInfo` elements can be present because one location may - # indicate the location of the scene in the image, and another location - # may indicate the location of the place where the image was taken. - # Location information is usually present for landmarks. + # The location information for the detected entity. Multiple `LocationInfo` + # elements can be present because one location may indicate the location of the + # scene in the image, and another location may indicate the location of the + # place where the image was taken. Location information is usually present for + # landmarks. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `mid` # @return [String] attr_accessor :mid - # Some entities may have optional user-supplied `Property` (name/value) - # fields, such a score or string that qualifies the entity. + # Some entities may have optional user-supplied `Property` (name/value) fields, + # such a score or string that qualifies the entity. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -1543,11 +1345,11 @@ module Google # @return [Float] attr_accessor :score - # The relevancy of the ICA (Image Content Annotation) label to the - # image. For example, the relevancy of "tower" is likely higher to an image - # containing the detected "Eiffel Tower" than to an image containing a - # detected distant towering building, even though the confidence that - # there is a tower in each image may be the same. Range [0, 1]. + # The relevancy of the ICA (Image Content Annotation) label to the image. For + # example, the relevancy of "tower" is likely higher to an image containing the + # detected "Eiffel Tower" than to an image containing a detected distant + # towering building, even though the confidence that there is a tower in each + # image may be the same. Range [0, 1]. # Corresponds to the JSON property `topicality` # @return [Float] attr_accessor :topicality @@ -1620,15 +1422,15 @@ module Google attr_accessor :landmarks # Yaw angle, which indicates the leftward/rightward angle that the face is - # pointing relative to the vertical plane perpendicular to the image. Range - # [-180,180]. + # pointing relative to the vertical plane perpendicular to the image. Range [- + # 180,180]. # Corresponds to the JSON property `panAngle` # @return [Float] attr_accessor :pan_angle - # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation - # of the face relative to the image vertical about the axis perpendicular to - # the face. Range [-180,180]. + # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of + # the face relative to the image vertical about the axis perpendicular to the + # face. Range [-180,180]. # Corresponds to the JSON property `rollAngle` # @return [Float] attr_accessor :roll_angle @@ -1682,9 +1484,9 @@ module Google class GoogleCloudVisionV1p1beta1FaceAnnotationLandmark include Google::Apis::Core::Hashable - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. # Corresponds to the JSON property `position` # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1Position] attr_accessor :position @@ -1709,24 +1511,20 @@ module Google class GoogleCloudVisionV1p1beta1GcsDestination include Google::Apis::Core::Hashable - # Google Cloud Storage URI prefix where the results will be stored. Results - # will be in JSON format and preceded by its corresponding input URI prefix. - # This field can either represent a gcs file prefix or gcs directory. In - # either case, the uri should be unique because in order to get all of the - # output files, you will need to do a wildcard gcs search on the uri prefix - # you provide. - # Examples: - # * File Prefix: gs://bucket-name/here/filenameprefix The output files - # will be created in gs://bucket-name/here/ and the names of the - # output files will begin with "filenameprefix". - # * Directory Prefix: gs://bucket-name/some/location/ The output files - # will be created in gs://bucket-name/some/location/ and the names of the - # output files could be anything because there was no filename prefix - # specified. - # If multiple outputs, each response is still AnnotateFileResponse, each of - # which contains some subset of the full list of AnnotateImageResponse. - # Multiple outputs can happen if, for example, the output JSON is too large - # and overflows into multiple sharded files. + # Google Cloud Storage URI prefix where the results will be stored. Results will + # be in JSON format and preceded by its corresponding input URI prefix. This + # field can either represent a gcs file prefix or gcs directory. In either case, + # the uri should be unique because in order to get all of the output files, you + # will need to do a wildcard gcs search on the uri prefix you provide. Examples: + # * File Prefix: gs://bucket-name/here/filenameprefix The output files will be + # created in gs://bucket-name/here/ and the names of the output files will begin + # with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The + # output files will be created in gs://bucket-name/some/location/ and the names + # of the output files could be anything because there was no filename prefix + # specified. If multiple outputs, each response is still AnnotateFileResponse, + # each of which contains some subset of the full list of AnnotateImageResponse. + # Multiple outputs can happen if, for example, the output JSON is too large and + # overflows into multiple sharded files. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -1745,8 +1543,8 @@ module Google class GoogleCloudVisionV1p1beta1GcsSource include Google::Apis::Core::Hashable - # Google Cloud Storage URI for the input file. This must only be a - # Google Cloud Storage object. Wildcards are not currently supported. + # Google Cloud Storage URI for the input file. This must only be a Google Cloud + # Storage object. Wildcards are not currently supported. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -1766,8 +1564,8 @@ module Google class GoogleCloudVisionV1p1beta1ImageAnnotationContext include Google::Apis::Core::Hashable - # If the file was a PDF or TIFF, this field gives the page number within - # the file used to produce the image. + # If the file was a PDF or TIFF, this field gives the page number within the + # file used to produce the image. # Corresponds to the JSON property `pageNumber` # @return [Fixnum] attr_accessor :page_number @@ -1811,11 +1609,11 @@ module Google class GoogleCloudVisionV1p1beta1InputConfig include Google::Apis::Core::Hashable - # File content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateFiles requests. It does - # not work for AsyncBatchAnnotateFiles requests. + # File content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1826,8 +1624,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1GcsSource] attr_accessor :gcs_source - # The type of the file. Currently only "application/pdf", "image/tiff" and - # "image/gif" are supported. Wildcards are not supported. + # The type of the file. Currently only "application/pdf", "image/tiff" and " + # image/gif" are supported. Wildcards are not supported. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -1853,9 +1651,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1BoundingPoly] attr_accessor :bounding_poly - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -1895,9 +1692,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::VisionV1p2beta1::LatLng] attr_accessor :lat_lng @@ -1912,9 +1708,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVisionV1p1beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -1974,13 +1769,11 @@ module Google class GoogleCloudVisionV1p1beta1OutputConfig include Google::Apis::Core::Hashable - # The max number of response protos to put into each output JSON file on - # Google Cloud Storage. - # The valid range is [1, 100]. If not specified, the default value is 20. - # For example, for one pdf file with 100 pages, 100 response protos will - # be generated. If `batch_size` = 20, then 5 json files each - # containing 20 response protos will be written under the prefix - # `gcs_destination`.`uri`. + # The max number of response protos to put into each output JSON file on Google + # Cloud Storage. The valid range is [1, 100]. If not specified, the default + # value is 20. For example, for one pdf file with 100 pages, 100 response protos + # will be generated. If `batch_size` = 20, then 5 json files each containing 20 + # response protos will be written under the prefix `gcs_destination`.`uri`. # Currently, batch_size only applies to GcsDestination, with potential future # support for other output configurations. # Corresponds to the JSON property `batchSize` @@ -2017,8 +1810,8 @@ module Google # @return [Float] attr_accessor :confidence - # Page height. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page height. For PDFs the unit is points. For images (including TIFFs) the + # unit is pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -2028,8 +1821,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty] attr_accessor :property - # Page width. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page width. For PDFs the unit is points. For images (including TIFFs) the unit + # is pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -2085,9 +1878,9 @@ module Google end end - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. class GoogleCloudVisionV1p1beta1Position include Google::Apis::Core::Hashable @@ -2134,33 +1927,28 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the product. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - # This field is ignored when creating a product. + # The resource name of the product. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Immutable. The category for the product identified by the reference image. - # This should - # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories - # "homegoods", "apparel", and "toys" are still supported, but these should - # not be used for new products. + # This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods- + # v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" + # are still supported, but these should not be used for new products. # Corresponds to the JSON property `productCategory` # @return [String] attr_accessor :product_category - # Key-value pairs that can be attached to a product. At query time, - # constraints can be specified based on the product_labels. - # Note that integer values can be provided as strings, e.g. "1199". Only - # strings with integer values can match a range-based restriction which is - # to be supported soon. - # Multiple values can be assigned to the same key. One product may have up to - # 500 product_labels. - # Notice that the total number of distinct product_labels over all products - # in one ProductSet cannot exceed 1M, otherwise the product search pipeline - # will refuse to work for that ProductSet. + # Key-value pairs that can be attached to a product. At query time, constraints + # can be specified based on the product_labels. Note that integer values can be + # provided as strings, e.g. "1199". Only strings with integer values can match a + # range-based restriction which is to be supported soon. Multiple values can be + # assigned to the same key. One product may have up to 500 product_labels. + # Notice that the total number of distinct product_labels over all products in + # one ProductSet cannot exceed 1M, otherwise the product search pipeline will + # refuse to work for that ProductSet. # Corresponds to the JSON property `productLabels` # @return [Array] attr_accessor :product_labels @@ -2189,8 +1977,8 @@ module Google # @return [String] attr_accessor :key - # The value of the label attached to the product. Cannot be empty and - # cannot exceed 128 bytes. + # The value of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -2211,8 +1999,8 @@ module Google include Google::Apis::Core::Hashable # Timestamp of the index which provided these results. Products added to the - # product set and products removed from the product set after this time are - # not reflected in the current results. + # product set and products removed from the product set after this time are not + # reflected in the current results. # Corresponds to the JSON property `indexTime` # @return [String] attr_accessor :index_time @@ -2242,8 +2030,7 @@ module Google end end - # Information about the products similar to a single product in a query - # image. + # Information about the products similar to a single product in a query image. class GoogleCloudVisionV1p1beta1ProductSearchResultsGroupedResult include Google::Apis::Core::Hashable @@ -2278,9 +2065,8 @@ module Google class GoogleCloudVisionV1p1beta1ProductSearchResultsObjectAnnotation include Google::Apis::Core::Hashable - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -2317,8 +2103,8 @@ module Google class GoogleCloudVisionV1p1beta1ProductSearchResultsResult include Google::Apis::Core::Hashable - # The resource name of the image from the product that is the closest match - # to the query. + # The resource name of the image from the product that is the closest match to + # the query. # Corresponds to the JSON property `image` # @return [String] attr_accessor :image @@ -2328,8 +2114,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1Product] attr_accessor :product - # A confidence level on the match, ranging from 0 (no confidence) to - # 1 (full confidence). + # A confidence level on the match, ranging from 0 (no confidence) to 1 (full + # confidence). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -2377,15 +2163,14 @@ module Google end end - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). class GoogleCloudVisionV1p1beta1SafeSearchAnnotation include Google::Apis::Core::Hashable # Represents the adult content likelihood for the image. Adult content may - # contain elements such as nudity, pornographic images or cartoons, or - # sexual activities. + # contain elements such as nudity, pornographic images or cartoons, or sexual + # activities. # Corresponds to the JSON property `adult` # @return [String] attr_accessor :adult @@ -2397,15 +2182,14 @@ module Google # Likelihood that the request image contains racy content. Racy content may # include (but is not limited to) skimpy or sheer clothing, strategically - # covered nudity, lewd or provocative poses, or close-ups of sensitive - # body areas. + # covered nudity, lewd or provocative poses, or close-ups of sensitive body + # areas. # Corresponds to the JSON property `racy` # @return [String] attr_accessor :racy - # Spoof likelihood. The likelihood that an modification - # was made to the image's canonical version to make it appear - # funny or offensive. + # Spoof likelihood. The likelihood that an modification was made to the image's + # canonical version to make it appear funny or offensive. # Corresponds to the JSON property `spoof` # @return [String] attr_accessor :spoof @@ -2466,13 +2250,12 @@ module Google end end - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. class GoogleCloudVisionV1p1beta1TextAnnotation include Google::Apis::Core::Hashable @@ -2532,9 +2315,8 @@ module Google # @return [Float] attr_accessor :confidence - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -2575,8 +2357,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the vertex coordinates are in the same scale as the original image. + # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are + # in the same scale as the original image. class GoogleCloudVisionV1p1beta1Vertex include Google::Apis::Core::Hashable @@ -2605,14 +2387,14 @@ module Google class GoogleCloudVisionV1p1beta1WebDetection include Google::Apis::Core::Hashable - # The service's best guess as to the topic of the request image. - # Inferred from similar images on the open web. + # The service's best guess as to the topic of the request image. Inferred from + # similar images on the open web. # Corresponds to the JSON property `bestGuessLabels` # @return [Array] attr_accessor :best_guess_labels - # Fully matching images from the Internet. - # Can include resized copies of the query image. + # Fully matching images from the Internet. Can include resized copies of the + # query image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -2622,9 +2404,9 @@ module Google # @return [Array] attr_accessor :pages_with_matching_images - # Partial matching images from the Internet. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its crops. + # Partial matching images from the Internet. Those images are similar enough to + # share some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -2668,8 +2450,8 @@ module Google # @return [String] attr_accessor :entity_id - # Overall relevancy score for the entity. - # Not normalized and not comparable across different image queries. + # Overall relevancy score for the entity. Not normalized and not comparable + # across different image queries. # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -2720,9 +2502,9 @@ module Google # @return [String] attr_accessor :label - # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - # For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more + # information, see http://www.unicode.org/reports/tr35/# + # Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -2742,8 +2524,8 @@ module Google class GoogleCloudVisionV1p1beta1WebDetectionWebPage include Google::Apis::Core::Hashable - # Fully matching images on the page. - # Can include resized copies of the query image. + # Fully matching images on the page. Can include resized copies of the query + # image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -2753,10 +2535,9 @@ module Google # @return [String] attr_accessor :page_title - # Partial matching images on the page. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its - # crops. + # Partial matching images on the page. Those images are similar enough to share + # some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -2804,8 +2585,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p1beta1TextAnnotationTextProperty] attr_accessor :property - # List of symbols in the word. - # The order of the symbols follows the natural reading order. + # List of symbols in the word. The order of the symbols follows the natural + # reading order. # Corresponds to the JSON property `symbols` # @return [Array] attr_accessor :symbols @@ -2842,16 +2623,13 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1InputConfig] attr_accessor :input_config - # Pages of the file to perform image annotation. - # Pages starts from 1, we assume the first page of the file is page 1. - # At most 5 pages are supported per request. Pages can be negative. - # Page 1 means the first page. - # Page 2 means the second page. - # Page -1 means the last page. - # Page -2 means the second to the last page. - # If the file is GIF instead of PDF or TIFF, page refers to GIF frames. - # If this field is empty, by default the service performs image annotation - # for the first 5 pages of the file. + # Pages of the file to perform image annotation. Pages starts from 1, we assume + # the first page of the file is page 1. At most 5 pages are supported per + # request. Pages can be negative. Page 1 means the first page. Page 2 means the + # second page. Page -1 means the last page. Page -2 means the second to the last + # page. If the file is GIF instead of PDF or TIFF, page refers to GIF frames. If + # this field is empty, by default the service performs image annotation for the + # first 5 pages of the file. # Corresponds to the JSON property `pages` # @return [Array] attr_accessor :pages @@ -2874,12 +2652,12 @@ module Google class GoogleCloudVisionV1p2beta1AnnotateFileResponse 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::VisionV1p2beta1::Status] attr_accessor :error @@ -2889,8 +2667,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1InputConfig] attr_accessor :input_config - # Individual responses to images found within the file. This field will be - # empty if the `error` field is set. + # Individual responses to images found within the file. This field will be empty + # if the `error` field is set. # Corresponds to the JSON property `responses` # @return [Array] attr_accessor :responses @@ -2960,12 +2738,12 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1CropHintsAnnotation] attr_accessor :crop_hints_annotation - # 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::VisionV1p2beta1::Status] attr_accessor :error @@ -2975,13 +2753,12 @@ module Google # @return [Array] attr_accessor :face_annotations - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. # Corresponds to the JSON property `fullTextAnnotation` # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1TextAnnotation] attr_accessor :full_text_annotation @@ -3001,8 +2778,8 @@ module Google # @return [Array] attr_accessor :landmark_annotations - # If present, localized object detection has completed successfully. - # This will be sorted descending by confidence score. + # If present, localized object detection has completed successfully. This will + # be sorted descending by confidence score. # Corresponds to the JSON property `localizedObjectAnnotations` # @return [Array] attr_accessor :localized_object_annotations @@ -3017,9 +2794,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1ProductSearchResults] attr_accessor :product_search_results - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). # Corresponds to the JSON property `safeSearchAnnotation` # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1SafeSearchAnnotation] attr_accessor :safe_search_annotation @@ -3113,19 +2889,15 @@ module Google end end - # Multiple async file annotation requests are batched into a single service - # call. + # Multiple async file annotation requests are batched into a single service call. class GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest include Google::Apis::Core::Hashable - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -3175,14 +2947,11 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1OutputConfig] attr_accessor :output_config - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -3208,14 +2977,11 @@ module Google class GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest include Google::Apis::Core::Hashable - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -3261,14 +3027,11 @@ module Google class GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest include Google::Apis::Core::Hashable - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -3376,123 +3139,61 @@ module Google end end - # Color information consists of RGB channels, score, and the fraction of - # the image that the color occupies in the image. + # Color information consists of RGB channels, score, and the fraction of the + # image that the color occupies in the image. class GoogleCloudVisionV1p2beta1ColorInfo include Google::Apis::Core::Hashable # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... # Corresponds to the JSON property `color` # @return [Google::Apis::VisionV1p2beta1::Color] attr_accessor :color - # The fraction of pixels the color occupies in the image. - # Value in range [0, 1]. + # The fraction of pixels the color occupies in the image. Value in range [0, 1]. # Corresponds to the JSON property `pixelFraction` # @return [Float] attr_accessor :pixel_fraction @@ -3523,7 +3224,7 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1BoundingPoly] attr_accessor :bounding_poly - # Confidence of this being a salient region. Range [0, 1]. + # Confidence of this being a salient region. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -3569,12 +3270,11 @@ module Google class GoogleCloudVisionV1p2beta1CropHintsParams include Google::Apis::Core::Hashable - # Aspect ratios in floats, representing the ratio of the width to the height - # of the image. For example, if the desired aspect ratio is 4/3, the - # corresponding float value should be 1.33333. If not specified, the - # best possible crop is returned. The number of provided aspect ratios is - # limited to a maximum of 16; any aspect ratios provided after the 16th are - # ignored. + # Aspect ratios in floats, representing the ratio of the width to the height of + # the image. For example, if the desired aspect ratio is 4/3, the corresponding + # float value should be 1.33333. If not specified, the best possible crop is + # returned. The number of provided aspect ratios is limited to a maximum of 16; + # any aspect ratios provided after the 16th are ignored. # Corresponds to the JSON property `aspectRatios` # @return [Array] attr_accessor :aspect_ratios @@ -3617,11 +3317,10 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1BoundingPoly] attr_accessor :bounding_poly - # **Deprecated. Use `score` instead.** - # The accuracy of the entity detection in an image. - # For example, for an image in which the "Eiffel Tower" entity is detected, - # this field represents the confidence that there is a tower in the query - # image. Range [0, 1]. + # **Deprecated. Use `score` instead.** The accuracy of the entity detection in + # an image. For example, for an image in which the "Eiffel Tower" entity is + # detected, this field represents the confidence that there is a tower in the + # query image. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -3631,30 +3330,29 @@ module Google # @return [String] attr_accessor :description - # The language code for the locale in which the entity textual - # `description` is expressed. + # The language code for the locale in which the entity textual `description` is + # expressed. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale - # The location information for the detected entity. Multiple - # `LocationInfo` elements can be present because one location may - # indicate the location of the scene in the image, and another location - # may indicate the location of the place where the image was taken. - # Location information is usually present for landmarks. + # The location information for the detected entity. Multiple `LocationInfo` + # elements can be present because one location may indicate the location of the + # scene in the image, and another location may indicate the location of the + # place where the image was taken. Location information is usually present for + # landmarks. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `mid` # @return [String] attr_accessor :mid - # Some entities may have optional user-supplied `Property` (name/value) - # fields, such a score or string that qualifies the entity. + # Some entities may have optional user-supplied `Property` (name/value) fields, + # such a score or string that qualifies the entity. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -3664,11 +3362,11 @@ module Google # @return [Float] attr_accessor :score - # The relevancy of the ICA (Image Content Annotation) label to the - # image. For example, the relevancy of "tower" is likely higher to an image - # containing the detected "Eiffel Tower" than to an image containing a - # detected distant towering building, even though the confidence that - # there is a tower in each image may be the same. Range [0, 1]. + # The relevancy of the ICA (Image Content Annotation) label to the image. For + # example, the relevancy of "tower" is likely higher to an image containing the + # detected "Eiffel Tower" than to an image containing a detected distant + # towering building, even though the confidence that there is a tower in each + # image may be the same. Range [0, 1]. # Corresponds to the JSON property `topicality` # @return [Float] attr_accessor :topicality @@ -3741,15 +3439,15 @@ module Google attr_accessor :landmarks # Yaw angle, which indicates the leftward/rightward angle that the face is - # pointing relative to the vertical plane perpendicular to the image. Range - # [-180,180]. + # pointing relative to the vertical plane perpendicular to the image. Range [- + # 180,180]. # Corresponds to the JSON property `panAngle` # @return [Float] attr_accessor :pan_angle - # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation - # of the face relative to the image vertical about the axis perpendicular to - # the face. Range [-180,180]. + # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of + # the face relative to the image vertical about the axis perpendicular to the + # face. Range [-180,180]. # Corresponds to the JSON property `rollAngle` # @return [Float] attr_accessor :roll_angle @@ -3803,9 +3501,9 @@ module Google class GoogleCloudVisionV1p2beta1FaceAnnotationLandmark include Google::Apis::Core::Hashable - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. # Corresponds to the JSON property `position` # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1Position] attr_accessor :position @@ -3827,20 +3525,19 @@ module Google end # The type of Google Cloud Vision API detection to perform, and the maximum - # number of results to return for that type. Multiple `Feature` objects can - # be specified in the `features` list. + # number of results to return for that type. Multiple `Feature` objects can be + # specified in the `features` list. class GoogleCloudVisionV1p2beta1Feature include Google::Apis::Core::Hashable - # Maximum number of results of this type. Does not apply to - # `TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. + # Maximum number of results of this type. Does not apply to `TEXT_DETECTION`, ` + # DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`. # Corresponds to the JSON property `maxResults` # @return [Fixnum] attr_accessor :max_results - # Model to use for the feature. - # Supported values: "builtin/stable" (the default if unset) and - # "builtin/latest". + # Model to use for the feature. Supported values: "builtin/stable" (the default + # if unset) and "builtin/latest". # Corresponds to the JSON property `model` # @return [String] attr_accessor :model @@ -3866,24 +3563,20 @@ module Google class GoogleCloudVisionV1p2beta1GcsDestination include Google::Apis::Core::Hashable - # Google Cloud Storage URI prefix where the results will be stored. Results - # will be in JSON format and preceded by its corresponding input URI prefix. - # This field can either represent a gcs file prefix or gcs directory. In - # either case, the uri should be unique because in order to get all of the - # output files, you will need to do a wildcard gcs search on the uri prefix - # you provide. - # Examples: - # * File Prefix: gs://bucket-name/here/filenameprefix The output files - # will be created in gs://bucket-name/here/ and the names of the - # output files will begin with "filenameprefix". - # * Directory Prefix: gs://bucket-name/some/location/ The output files - # will be created in gs://bucket-name/some/location/ and the names of the - # output files could be anything because there was no filename prefix - # specified. - # If multiple outputs, each response is still AnnotateFileResponse, each of - # which contains some subset of the full list of AnnotateImageResponse. - # Multiple outputs can happen if, for example, the output JSON is too large - # and overflows into multiple sharded files. + # Google Cloud Storage URI prefix where the results will be stored. Results will + # be in JSON format and preceded by its corresponding input URI prefix. This + # field can either represent a gcs file prefix or gcs directory. In either case, + # the uri should be unique because in order to get all of the output files, you + # will need to do a wildcard gcs search on the uri prefix you provide. Examples: + # * File Prefix: gs://bucket-name/here/filenameprefix The output files will be + # created in gs://bucket-name/here/ and the names of the output files will begin + # with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The + # output files will be created in gs://bucket-name/some/location/ and the names + # of the output files could be anything because there was no filename prefix + # specified. If multiple outputs, each response is still AnnotateFileResponse, + # each of which contains some subset of the full list of AnnotateImageResponse. + # Multiple outputs can happen if, for example, the output JSON is too large and + # overflows into multiple sharded files. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -3902,8 +3595,8 @@ module Google class GoogleCloudVisionV1p2beta1GcsSource include Google::Apis::Core::Hashable - # Google Cloud Storage URI for the input file. This must only be a - # Google Cloud Storage object. Wildcards are not currently supported. + # Google Cloud Storage URI for the input file. This must only be a Google Cloud + # Storage object. Wildcards are not currently supported. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -3922,11 +3615,11 @@ module Google class GoogleCloudVisionV1p2beta1Image include Google::Apis::Core::Hashable - # Image content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateImages requests. It does - # not work for AsyncBatchAnnotateImages requests. + # Image content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateImages requests. It does not work for AsyncBatchAnnotateImages + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -3953,8 +3646,8 @@ module Google class GoogleCloudVisionV1p2beta1ImageAnnotationContext include Google::Apis::Core::Hashable - # If the file was a PDF or TIFF, this field gives the page number within - # the file used to produce the image. + # If the file was a PDF or TIFF, this field gives the page number within the + # file used to produce the image. # Corresponds to the JSON property `pageNumber` # @return [Fixnum] attr_accessor :page_number @@ -3986,12 +3679,12 @@ module Google # List of languages to use for TEXT_DETECTION. In most cases, an empty value # yields the best results since it enables automatic language detection. For - # languages based on the Latin alphabet, setting `language_hints` is not - # needed. In rare cases, when the language of the text in the image is known, - # setting a hint will help get better results (although it will be a - # significant hindrance if the hint is wrong). Text detection returns an - # error if one or more of the specified languages is not one of the - # [supported languages](https://cloud.google.com/vision/docs/languages). + # languages based on the Latin alphabet, setting `language_hints` is not needed. + # In rare cases, when the language of the text in the image is known, setting a + # hint will help get better results (although it will be a significant hindrance + # if the hint is wrong). Text detection returns an error if one or more of the + # specified languages is not one of the [supported languages](https://cloud. + # google.com/vision/docs/languages). # Corresponds to the JSON property `languageHints` # @return [Array] attr_accessor :language_hints @@ -4048,29 +3741,24 @@ module Google class GoogleCloudVisionV1p2beta1ImageSource include Google::Apis::Core::Hashable - # **Use `image_uri` instead.** - # The Google Cloud Storage URI of the form - # `gs://bucket_name/object_name`. Object versioning is not supported. See - # [Google Cloud Storage Request - # URIs](https://cloud.google.com/storage/docs/reference-uris) for more info. + # **Use `image_uri` instead.** The Google Cloud Storage URI of the form `gs:// + # bucket_name/object_name`. Object versioning is not supported. See [Google + # Cloud Storage Request URIs](https://cloud.google.com/storage/docs/reference- + # uris) for more info. # Corresponds to the JSON property `gcsImageUri` # @return [String] attr_accessor :gcs_image_uri - # The URI of the source image. Can be either: - # 1. A Google Cloud Storage URI of the form - # `gs://bucket_name/object_name`. Object versioning is not supported. See - # [Google Cloud Storage Request - # URIs](https://cloud.google.com/storage/docs/reference-uris) for more - # info. - # 2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from - # HTTP/HTTPS URLs, Google cannot guarantee that the request will be - # completed. Your request may fail if the specified host denies the - # request (e.g. due to request throttling or DOS prevention), or if Google - # throttles requests to the site for abuse prevention. You should not - # depend on externally-hosted images for production applications. - # When both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes - # precedence. + # The URI of the source image. Can be either: 1. A Google Cloud Storage URI of + # the form `gs://bucket_name/object_name`. Object versioning is not supported. + # See [Google Cloud Storage Request URIs](https://cloud.google.com/storage/docs/ + # reference-uris) for more info. 2. A publicly-accessible image HTTP/HTTPS URL. + # When fetching images from HTTP/HTTPS URLs, Google cannot guarantee that the + # request will be completed. Your request may fail if the specified host denies + # the request (e.g. due to request throttling or DOS prevention), or if Google + # throttles requests to the site for abuse prevention. You should not depend on + # externally-hosted images for production applications. When both `gcs_image_uri` + # and `image_uri` are specified, `image_uri` takes precedence. # Corresponds to the JSON property `imageUri` # @return [String] attr_accessor :image_uri @@ -4090,11 +3778,11 @@ module Google class GoogleCloudVisionV1p2beta1InputConfig include Google::Apis::Core::Hashable - # File content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateFiles requests. It does - # not work for AsyncBatchAnnotateFiles requests. + # File content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -4105,8 +3793,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1GcsSource] attr_accessor :gcs_source - # The type of the file. Currently only "application/pdf", "image/tiff" and - # "image/gif" are supported. Wildcards are not supported. + # The type of the file. Currently only "application/pdf", "image/tiff" and " + # image/gif" are supported. Wildcards are not supported. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -4129,18 +3817,16 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `maxLatLng` # @return [Google::Apis::VisionV1p2beta1::LatLng] attr_accessor :max_lat_lng # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `minLatLng` # @return [Google::Apis::VisionV1p2beta1::LatLng] attr_accessor :min_lat_lng @@ -4165,9 +3851,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1BoundingPoly] attr_accessor :bounding_poly - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -4207,9 +3892,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::VisionV1p2beta1::LatLng] attr_accessor :lat_lng @@ -4224,9 +3908,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVisionV1p2beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -4286,13 +3969,11 @@ module Google class GoogleCloudVisionV1p2beta1OutputConfig include Google::Apis::Core::Hashable - # The max number of response protos to put into each output JSON file on - # Google Cloud Storage. - # The valid range is [1, 100]. If not specified, the default value is 20. - # For example, for one pdf file with 100 pages, 100 response protos will - # be generated. If `batch_size` = 20, then 5 json files each - # containing 20 response protos will be written under the prefix - # `gcs_destination`.`uri`. + # The max number of response protos to put into each output JSON file on Google + # Cloud Storage. The valid range is [1, 100]. If not specified, the default + # value is 20. For example, for one pdf file with 100 pages, 100 response protos + # will be generated. If `batch_size` = 20, then 5 json files each containing 20 + # response protos will be written under the prefix `gcs_destination`.`uri`. # Currently, batch_size only applies to GcsDestination, with potential future # support for other output configurations. # Corresponds to the JSON property `batchSize` @@ -4329,8 +4010,8 @@ module Google # @return [Float] attr_accessor :confidence - # Page height. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page height. For PDFs the unit is points. For images (including TIFFs) the + # unit is pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -4340,8 +4021,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1TextAnnotationTextProperty] attr_accessor :property - # Page width. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page width. For PDFs the unit is points. For images (including TIFFs) the unit + # is pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -4397,9 +4078,9 @@ module Google end end - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. class GoogleCloudVisionV1p2beta1Position include Google::Apis::Core::Hashable @@ -4446,33 +4127,28 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the product. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - # This field is ignored when creating a product. + # The resource name of the product. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Immutable. The category for the product identified by the reference image. - # This should - # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories - # "homegoods", "apparel", and "toys" are still supported, but these should - # not be used for new products. + # This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods- + # v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" + # are still supported, but these should not be used for new products. # Corresponds to the JSON property `productCategory` # @return [String] attr_accessor :product_category - # Key-value pairs that can be attached to a product. At query time, - # constraints can be specified based on the product_labels. - # Note that integer values can be provided as strings, e.g. "1199". Only - # strings with integer values can match a range-based restriction which is - # to be supported soon. - # Multiple values can be assigned to the same key. One product may have up to - # 500 product_labels. - # Notice that the total number of distinct product_labels over all products - # in one ProductSet cannot exceed 1M, otherwise the product search pipeline - # will refuse to work for that ProductSet. + # Key-value pairs that can be attached to a product. At query time, constraints + # can be specified based on the product_labels. Note that integer values can be + # provided as strings, e.g. "1199". Only strings with integer values can match a + # range-based restriction which is to be supported soon. Multiple values can be + # assigned to the same key. One product may have up to 500 product_labels. + # Notice that the total number of distinct product_labels over all products in + # one ProductSet cannot exceed 1M, otherwise the product search pipeline will + # refuse to work for that ProductSet. # Corresponds to the JSON property `productLabels` # @return [Array] attr_accessor :product_labels @@ -4501,8 +4177,8 @@ module Google # @return [String] attr_accessor :key - # The value of the label attached to the product. Cannot be empty and - # cannot exceed 128 bytes. + # The value of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -4527,30 +4203,29 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1BoundingPoly] attr_accessor :bounding_poly - # The filtering expression. This can be used to restrict search results based - # on Product labels. We currently support an AND of OR of key-value - # expressions, where each expression within an OR must have the same key. An - # '=' should be used to connect the key and value. - # For example, "(color = red OR color = blue) AND brand = Google" is - # acceptable, but "(color = red OR brand = Google)" is not acceptable. - # "color: red" is not acceptable because it uses a ':' instead of an '='. + # The filtering expression. This can be used to restrict search results based on + # Product labels. We currently support an AND of OR of key-value expressions, + # where each expression within an OR must have the same key. An '=' should be + # used to connect the key and value. For example, "(color = red OR color = blue) + # AND brand = Google" is acceptable, but "(color = red OR brand = Google)" is + # not acceptable. "color: red" is not acceptable because it uses a ':' instead + # of an '='. # Corresponds to the JSON property `filter` # @return [String] attr_accessor :filter - # The list of product categories to search in. Currently, we only consider - # the first category, and either "homegoods-v2", "apparel-v2", "toys-v2", - # "packagedgoods-v1", or "general-v1" should be specified. The legacy - # categories "homegoods", "apparel", and "toys" are still supported but will - # be deprecated. For new products, please use "homegoods-v2", "apparel-v2", - # or "toys-v2" for better product search accuracy. It is recommended to - # migrate existing products to these categories as well. + # The list of product categories to search in. Currently, we only consider the + # first category, and either "homegoods-v2", "apparel-v2", "toys-v2", " + # packagedgoods-v1", or "general-v1" should be specified. The legacy categories " + # homegoods", "apparel", and "toys" are still supported but will be deprecated. + # For new products, please use "homegoods-v2", "apparel-v2", or "toys-v2" for + # better product search accuracy. It is recommended to migrate existing products + # to these categories as well. # Corresponds to the JSON property `productCategories` # @return [Array] attr_accessor :product_categories - # The resource name of a ProductSet to be searched for similar images. - # Format is: + # The resource name of a ProductSet to be searched for similar images. Format is: # `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. # Corresponds to the JSON property `productSet` # @return [String] @@ -4574,8 +4249,8 @@ module Google include Google::Apis::Core::Hashable # Timestamp of the index which provided these results. Products added to the - # product set and products removed from the product set after this time are - # not reflected in the current results. + # product set and products removed from the product set after this time are not + # reflected in the current results. # Corresponds to the JSON property `indexTime` # @return [String] attr_accessor :index_time @@ -4605,8 +4280,7 @@ module Google end end - # Information about the products similar to a single product in a query - # image. + # Information about the products similar to a single product in a query image. class GoogleCloudVisionV1p2beta1ProductSearchResultsGroupedResult include Google::Apis::Core::Hashable @@ -4641,9 +4315,8 @@ module Google class GoogleCloudVisionV1p2beta1ProductSearchResultsObjectAnnotation include Google::Apis::Core::Hashable - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -4680,8 +4353,8 @@ module Google class GoogleCloudVisionV1p2beta1ProductSearchResultsResult include Google::Apis::Core::Hashable - # The resource name of the image from the product that is the closest match - # to the query. + # The resource name of the image from the product that is the closest match to + # the query. # Corresponds to the JSON property `image` # @return [String] attr_accessor :image @@ -4691,8 +4364,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1Product] attr_accessor :product - # A confidence level on the match, ranging from 0 (no confidence) to - # 1 (full confidence). + # A confidence level on the match, ranging from 0 (no confidence) to 1 (full + # confidence). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -4740,15 +4413,14 @@ module Google end end - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). class GoogleCloudVisionV1p2beta1SafeSearchAnnotation include Google::Apis::Core::Hashable # Represents the adult content likelihood for the image. Adult content may - # contain elements such as nudity, pornographic images or cartoons, or - # sexual activities. + # contain elements such as nudity, pornographic images or cartoons, or sexual + # activities. # Corresponds to the JSON property `adult` # @return [String] attr_accessor :adult @@ -4760,15 +4432,14 @@ module Google # Likelihood that the request image contains racy content. Racy content may # include (but is not limited to) skimpy or sheer clothing, strategically - # covered nudity, lewd or provocative poses, or close-ups of sensitive - # body areas. + # covered nudity, lewd or provocative poses, or close-ups of sensitive body + # areas. # Corresponds to the JSON property `racy` # @return [String] attr_accessor :racy - # Spoof likelihood. The likelihood that an modification - # was made to the image's canonical version to make it appear - # funny or offensive. + # Spoof likelihood. The likelihood that an modification was made to the image's + # canonical version to make it appear funny or offensive. # Corresponds to the JSON property `spoof` # @return [String] attr_accessor :spoof @@ -4829,13 +4500,12 @@ module Google end end - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. class GoogleCloudVisionV1p2beta1TextAnnotation include Google::Apis::Core::Hashable @@ -4895,9 +4565,8 @@ module Google # @return [Float] attr_accessor :confidence - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -4938,8 +4607,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the vertex coordinates are in the same scale as the original image. + # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are + # in the same scale as the original image. class GoogleCloudVisionV1p2beta1Vertex include Google::Apis::Core::Hashable @@ -4968,14 +4637,14 @@ module Google class GoogleCloudVisionV1p2beta1WebDetection include Google::Apis::Core::Hashable - # The service's best guess as to the topic of the request image. - # Inferred from similar images on the open web. + # The service's best guess as to the topic of the request image. Inferred from + # similar images on the open web. # Corresponds to the JSON property `bestGuessLabels` # @return [Array] attr_accessor :best_guess_labels - # Fully matching images from the Internet. - # Can include resized copies of the query image. + # Fully matching images from the Internet. Can include resized copies of the + # query image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -4985,9 +4654,9 @@ module Google # @return [Array] attr_accessor :pages_with_matching_images - # Partial matching images from the Internet. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its crops. + # Partial matching images from the Internet. Those images are similar enough to + # share some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -5051,8 +4720,8 @@ module Google # @return [String] attr_accessor :entity_id - # Overall relevancy score for the entity. - # Not normalized and not comparable across different image queries. + # Overall relevancy score for the entity. Not normalized and not comparable + # across different image queries. # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -5103,9 +4772,9 @@ module Google # @return [String] attr_accessor :label - # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - # For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more + # information, see http://www.unicode.org/reports/tr35/# + # Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -5125,8 +4794,8 @@ module Google class GoogleCloudVisionV1p2beta1WebDetectionWebPage include Google::Apis::Core::Hashable - # Fully matching images on the page. - # Can include resized copies of the query image. + # Fully matching images on the page. Can include resized copies of the query + # image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -5136,10 +4805,9 @@ module Google # @return [String] attr_accessor :page_title - # Partial matching images on the page. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its - # crops. + # Partial matching images on the page. Those images are similar enough to share + # some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -5187,8 +4855,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1TextAnnotationTextProperty] attr_accessor :property - # List of symbols in the word. - # The order of the symbols follows the natural reading order. + # List of symbols in the word. The order of the symbols follows the natural + # reading order. # Corresponds to the JSON property `symbols` # @return [Array] attr_accessor :symbols @@ -5211,12 +4879,12 @@ module Google class GoogleCloudVisionV1p3beta1AnnotateFileResponse 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::VisionV1p2beta1::Status] attr_accessor :error @@ -5226,8 +4894,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1InputConfig] attr_accessor :input_config - # Individual responses to images found within the file. This field will be - # empty if the `error` field is set. + # Individual responses to images found within the file. This field will be empty + # if the `error` field is set. # Corresponds to the JSON property `responses` # @return [Array] attr_accessor :responses @@ -5265,12 +4933,12 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1CropHintsAnnotation] attr_accessor :crop_hints_annotation - # 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::VisionV1p2beta1::Status] attr_accessor :error @@ -5280,13 +4948,12 @@ module Google # @return [Array] attr_accessor :face_annotations - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. # Corresponds to the JSON property `fullTextAnnotation` # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1TextAnnotation] attr_accessor :full_text_annotation @@ -5306,8 +4973,8 @@ module Google # @return [Array] attr_accessor :landmark_annotations - # If present, localized object detection has completed successfully. - # This will be sorted descending by confidence score. + # If present, localized object detection has completed successfully. This will + # be sorted descending by confidence score. # Corresponds to the JSON property `localizedObjectAnnotations` # @return [Array] attr_accessor :localized_object_annotations @@ -5322,9 +4989,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1ProductSearchResults] attr_accessor :product_search_results - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). # Corresponds to the JSON property `safeSearchAnnotation` # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1SafeSearchAnnotation] attr_accessor :safe_search_annotation @@ -5401,14 +5067,14 @@ module Google end end - # Metadata for the batch operations such as the current state. - # This is included in the `metadata` field of the `Operation` returned by the - # `GetOperation` call of the `google::longrunning::Operations` service. + # Metadata for the batch operations such as the current state. This is included + # in the `metadata` field of the `Operation` returned by the `GetOperation` call + # of the `google::longrunning::Operations` service. class GoogleCloudVisionV1p3beta1BatchOperationMetadata include Google::Apis::Core::Hashable - # The time when the batch request is finished and - # google.longrunning.Operation.done is set to true. + # The time when the batch request is finished and google.longrunning.Operation. + # done is set to true. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -5503,123 +5169,61 @@ module Google end end - # Color information consists of RGB channels, score, and the fraction of - # the image that the color occupies in the image. + # Color information consists of RGB channels, score, and the fraction of the + # image that the color occupies in the image. class GoogleCloudVisionV1p3beta1ColorInfo include Google::Apis::Core::Hashable # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... # Corresponds to the JSON property `color` # @return [Google::Apis::VisionV1p2beta1::Color] attr_accessor :color - # The fraction of pixels the color occupies in the image. - # Value in range [0, 1]. + # The fraction of pixels the color occupies in the image. Value in range [0, 1]. # Corresponds to the JSON property `pixelFraction` # @return [Float] attr_accessor :pixel_fraction @@ -5650,7 +5254,7 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1BoundingPoly] attr_accessor :bounding_poly - # Confidence of this being a salient region. Range [0, 1]. + # Confidence of this being a salient region. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -5720,11 +5324,10 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1BoundingPoly] attr_accessor :bounding_poly - # **Deprecated. Use `score` instead.** - # The accuracy of the entity detection in an image. - # For example, for an image in which the "Eiffel Tower" entity is detected, - # this field represents the confidence that there is a tower in the query - # image. Range [0, 1]. + # **Deprecated. Use `score` instead.** The accuracy of the entity detection in + # an image. For example, for an image in which the "Eiffel Tower" entity is + # detected, this field represents the confidence that there is a tower in the + # query image. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -5734,30 +5337,29 @@ module Google # @return [String] attr_accessor :description - # The language code for the locale in which the entity textual - # `description` is expressed. + # The language code for the locale in which the entity textual `description` is + # expressed. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale - # The location information for the detected entity. Multiple - # `LocationInfo` elements can be present because one location may - # indicate the location of the scene in the image, and another location - # may indicate the location of the place where the image was taken. - # Location information is usually present for landmarks. + # The location information for the detected entity. Multiple `LocationInfo` + # elements can be present because one location may indicate the location of the + # scene in the image, and another location may indicate the location of the + # place where the image was taken. Location information is usually present for + # landmarks. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `mid` # @return [String] attr_accessor :mid - # Some entities may have optional user-supplied `Property` (name/value) - # fields, such a score or string that qualifies the entity. + # Some entities may have optional user-supplied `Property` (name/value) fields, + # such a score or string that qualifies the entity. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -5767,11 +5369,11 @@ module Google # @return [Float] attr_accessor :score - # The relevancy of the ICA (Image Content Annotation) label to the - # image. For example, the relevancy of "tower" is likely higher to an image - # containing the detected "Eiffel Tower" than to an image containing a - # detected distant towering building, even though the confidence that - # there is a tower in each image may be the same. Range [0, 1]. + # The relevancy of the ICA (Image Content Annotation) label to the image. For + # example, the relevancy of "tower" is likely higher to an image containing the + # detected "Eiffel Tower" than to an image containing a detected distant + # towering building, even though the confidence that there is a tower in each + # image may be the same. Range [0, 1]. # Corresponds to the JSON property `topicality` # @return [Float] attr_accessor :topicality @@ -5844,15 +5446,15 @@ module Google attr_accessor :landmarks # Yaw angle, which indicates the leftward/rightward angle that the face is - # pointing relative to the vertical plane perpendicular to the image. Range - # [-180,180]. + # pointing relative to the vertical plane perpendicular to the image. Range [- + # 180,180]. # Corresponds to the JSON property `panAngle` # @return [Float] attr_accessor :pan_angle - # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation - # of the face relative to the image vertical about the axis perpendicular to - # the face. Range [-180,180]. + # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of + # the face relative to the image vertical about the axis perpendicular to the + # face. Range [-180,180]. # Corresponds to the JSON property `rollAngle` # @return [Float] attr_accessor :roll_angle @@ -5906,9 +5508,9 @@ module Google class GoogleCloudVisionV1p3beta1FaceAnnotationLandmark include Google::Apis::Core::Hashable - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. # Corresponds to the JSON property `position` # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1Position] attr_accessor :position @@ -5933,24 +5535,20 @@ module Google class GoogleCloudVisionV1p3beta1GcsDestination include Google::Apis::Core::Hashable - # Google Cloud Storage URI prefix where the results will be stored. Results - # will be in JSON format and preceded by its corresponding input URI prefix. - # This field can either represent a gcs file prefix or gcs directory. In - # either case, the uri should be unique because in order to get all of the - # output files, you will need to do a wildcard gcs search on the uri prefix - # you provide. - # Examples: - # * File Prefix: gs://bucket-name/here/filenameprefix The output files - # will be created in gs://bucket-name/here/ and the names of the - # output files will begin with "filenameprefix". - # * Directory Prefix: gs://bucket-name/some/location/ The output files - # will be created in gs://bucket-name/some/location/ and the names of the - # output files could be anything because there was no filename prefix - # specified. - # If multiple outputs, each response is still AnnotateFileResponse, each of - # which contains some subset of the full list of AnnotateImageResponse. - # Multiple outputs can happen if, for example, the output JSON is too large - # and overflows into multiple sharded files. + # Google Cloud Storage URI prefix where the results will be stored. Results will + # be in JSON format and preceded by its corresponding input URI prefix. This + # field can either represent a gcs file prefix or gcs directory. In either case, + # the uri should be unique because in order to get all of the output files, you + # will need to do a wildcard gcs search on the uri prefix you provide. Examples: + # * File Prefix: gs://bucket-name/here/filenameprefix The output files will be + # created in gs://bucket-name/here/ and the names of the output files will begin + # with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The + # output files will be created in gs://bucket-name/some/location/ and the names + # of the output files could be anything because there was no filename prefix + # specified. If multiple outputs, each response is still AnnotateFileResponse, + # each of which contains some subset of the full list of AnnotateImageResponse. + # Multiple outputs can happen if, for example, the output JSON is too large and + # overflows into multiple sharded files. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -5969,8 +5567,8 @@ module Google class GoogleCloudVisionV1p3beta1GcsSource include Google::Apis::Core::Hashable - # Google Cloud Storage URI for the input file. This must only be a - # Google Cloud Storage object. Wildcards are not currently supported. + # Google Cloud Storage URI for the input file. This must only be a Google Cloud + # Storage object. Wildcards are not currently supported. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -5990,8 +5588,8 @@ module Google class GoogleCloudVisionV1p3beta1ImageAnnotationContext include Google::Apis::Core::Hashable - # If the file was a PDF or TIFF, this field gives the page number within - # the file used to produce the image. + # If the file was a PDF or TIFF, this field gives the page number within the + # file used to produce the image. # Corresponds to the JSON property `pageNumber` # @return [Fixnum] attr_accessor :page_number @@ -6031,9 +5629,8 @@ module Google end end - # Response message for the `ImportProductSets` method. - # This message is returned by the - # google.longrunning.Operations.GetOperation method in the returned + # Response message for the `ImportProductSets` method. This message is returned + # by the google.longrunning.Operations.GetOperation method in the returned # google.longrunning.Operation.response field. class GoogleCloudVisionV1p3beta1ImportProductSetsResponse include Google::Apis::Core::Hashable @@ -6043,11 +5640,10 @@ module Google # @return [Array] attr_accessor :reference_images - # The rpc status for each ImportProductSet request, including both successes - # and errors. - # The number of statuses here matches the number of lines in the csv file, - # and statuses[i] stores the success or failure status of processing the i-th - # line of the csv, starting from line 0. + # The rpc status for each ImportProductSet request, including both successes and + # errors. The number of statuses here matches the number of lines in the csv + # file, and statuses[i] stores the success or failure status of processing the i- + # th line of the csv, starting from line 0. # Corresponds to the JSON property `statuses` # @return [Array] attr_accessor :statuses @@ -6067,11 +5663,11 @@ module Google class GoogleCloudVisionV1p3beta1InputConfig include Google::Apis::Core::Hashable - # File content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateFiles requests. It does - # not work for AsyncBatchAnnotateFiles requests. + # File content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -6082,8 +5678,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1GcsSource] attr_accessor :gcs_source - # The type of the file. Currently only "application/pdf", "image/tiff" and - # "image/gif" are supported. Wildcards are not supported. + # The type of the file. Currently only "application/pdf", "image/tiff" and " + # image/gif" are supported. Wildcards are not supported. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -6109,9 +5705,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1BoundingPoly] attr_accessor :bounding_poly - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -6151,9 +5746,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::VisionV1p2beta1::LatLng] attr_accessor :lat_lng @@ -6168,9 +5762,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVisionV1p3beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -6230,13 +5823,11 @@ module Google class GoogleCloudVisionV1p3beta1OutputConfig include Google::Apis::Core::Hashable - # The max number of response protos to put into each output JSON file on - # Google Cloud Storage. - # The valid range is [1, 100]. If not specified, the default value is 20. - # For example, for one pdf file with 100 pages, 100 response protos will - # be generated. If `batch_size` = 20, then 5 json files each - # containing 20 response protos will be written under the prefix - # `gcs_destination`.`uri`. + # The max number of response protos to put into each output JSON file on Google + # Cloud Storage. The valid range is [1, 100]. If not specified, the default + # value is 20. For example, for one pdf file with 100 pages, 100 response protos + # will be generated. If `batch_size` = 20, then 5 json files each containing 20 + # response protos will be written under the prefix `gcs_destination`.`uri`. # Currently, batch_size only applies to GcsDestination, with potential future # support for other output configurations. # Corresponds to the JSON property `batchSize` @@ -6273,8 +5864,8 @@ module Google # @return [Float] attr_accessor :confidence - # Page height. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page height. For PDFs the unit is points. For images (including TIFFs) the + # unit is pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -6284,8 +5875,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1TextAnnotationTextProperty] attr_accessor :property - # Page width. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page width. For PDFs the unit is points. For images (including TIFFs) the unit + # is pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -6341,9 +5932,9 @@ module Google end end - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. class GoogleCloudVisionV1p3beta1Position include Google::Apis::Core::Hashable @@ -6390,33 +5981,28 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the product. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - # This field is ignored when creating a product. + # The resource name of the product. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Immutable. The category for the product identified by the reference image. - # This should - # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories - # "homegoods", "apparel", and "toys" are still supported, but these should - # not be used for new products. + # This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods- + # v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" + # are still supported, but these should not be used for new products. # Corresponds to the JSON property `productCategory` # @return [String] attr_accessor :product_category - # Key-value pairs that can be attached to a product. At query time, - # constraints can be specified based on the product_labels. - # Note that integer values can be provided as strings, e.g. "1199". Only - # strings with integer values can match a range-based restriction which is - # to be supported soon. - # Multiple values can be assigned to the same key. One product may have up to - # 500 product_labels. - # Notice that the total number of distinct product_labels over all products - # in one ProductSet cannot exceed 1M, otherwise the product search pipeline - # will refuse to work for that ProductSet. + # Key-value pairs that can be attached to a product. At query time, constraints + # can be specified based on the product_labels. Note that integer values can be + # provided as strings, e.g. "1199". Only strings with integer values can match a + # range-based restriction which is to be supported soon. Multiple values can be + # assigned to the same key. One product may have up to 500 product_labels. + # Notice that the total number of distinct product_labels over all products in + # one ProductSet cannot exceed 1M, otherwise the product search pipeline will + # refuse to work for that ProductSet. # Corresponds to the JSON property `productLabels` # @return [Array] attr_accessor :product_labels @@ -6445,8 +6031,8 @@ module Google # @return [String] attr_accessor :key - # The value of the label attached to the product. Cannot be empty and - # cannot exceed 128 bytes. + # The value of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -6467,8 +6053,8 @@ module Google include Google::Apis::Core::Hashable # Timestamp of the index which provided these results. Products added to the - # product set and products removed from the product set after this time are - # not reflected in the current results. + # product set and products removed from the product set after this time are not + # reflected in the current results. # Corresponds to the JSON property `indexTime` # @return [String] attr_accessor :index_time @@ -6498,8 +6084,7 @@ module Google end end - # Information about the products similar to a single product in a query - # image. + # Information about the products similar to a single product in a query image. class GoogleCloudVisionV1p3beta1ProductSearchResultsGroupedResult include Google::Apis::Core::Hashable @@ -6534,9 +6119,8 @@ module Google class GoogleCloudVisionV1p3beta1ProductSearchResultsObjectAnnotation include Google::Apis::Core::Hashable - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -6573,8 +6157,8 @@ module Google class GoogleCloudVisionV1p3beta1ProductSearchResultsResult include Google::Apis::Core::Hashable - # The resource name of the image from the product that is the closest match - # to the query. + # The resource name of the image from the product that is the closest match to + # the query. # Corresponds to the JSON property `image` # @return [String] attr_accessor :image @@ -6584,8 +6168,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1Product] attr_accessor :product - # A confidence level on the match, ranging from 0 (no confidence) to - # 1 (full confidence). + # A confidence level on the match, ranging from 0 (no confidence) to 1 (full + # confidence). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -6639,28 +6223,24 @@ module Google include Google::Apis::Core::Hashable # Optional. Bounding polygons around the areas of interest in the reference - # image. - # If this field is empty, the system will try to detect regions of - # interest. At most 10 bounding polygons will be used. - # The provided shape is converted into a non-rotated rectangle. Once - # converted, the small edge of the rectangle must be greater than or equal - # to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 - # is not). + # image. If this field is empty, the system will try to detect regions of + # interest. At most 10 bounding polygons will be used. The provided shape is + # converted into a non-rotated rectangle. Once converted, the small edge of the + # rectangle must be greater than or equal to 300 pixels. The aspect ratio must + # be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). # Corresponds to the JSON property `boundingPolys` # @return [Array] attr_accessor :bounding_polys - # The resource name of the reference image. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ - # IMAGE_ID`. - # This field is ignored when creating a reference image. + # The resource name of the reference image. Format is: `projects/PROJECT_ID/ + # locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is + # ignored when creating a reference image. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The Google Cloud Storage URI of the reference image. - # The URI must start with `gs://`. + # Required. The Google Cloud Storage URI of the reference image. The URI must + # start with `gs://`. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -6677,15 +6257,14 @@ module Google end end - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). class GoogleCloudVisionV1p3beta1SafeSearchAnnotation include Google::Apis::Core::Hashable # Represents the adult content likelihood for the image. Adult content may - # contain elements such as nudity, pornographic images or cartoons, or - # sexual activities. + # contain elements such as nudity, pornographic images or cartoons, or sexual + # activities. # Corresponds to the JSON property `adult` # @return [String] attr_accessor :adult @@ -6697,15 +6276,14 @@ module Google # Likelihood that the request image contains racy content. Racy content may # include (but is not limited to) skimpy or sheer clothing, strategically - # covered nudity, lewd or provocative poses, or close-ups of sensitive - # body areas. + # covered nudity, lewd or provocative poses, or close-ups of sensitive body + # areas. # Corresponds to the JSON property `racy` # @return [String] attr_accessor :racy - # Spoof likelihood. The likelihood that an modification - # was made to the image's canonical version to make it appear - # funny or offensive. + # Spoof likelihood. The likelihood that an modification was made to the image's + # canonical version to make it appear funny or offensive. # Corresponds to the JSON property `spoof` # @return [String] attr_accessor :spoof @@ -6766,13 +6344,12 @@ module Google end end - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. class GoogleCloudVisionV1p3beta1TextAnnotation include Google::Apis::Core::Hashable @@ -6832,9 +6409,8 @@ module Google # @return [Float] attr_accessor :confidence - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -6875,8 +6451,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the vertex coordinates are in the same scale as the original image. + # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are + # in the same scale as the original image. class GoogleCloudVisionV1p3beta1Vertex include Google::Apis::Core::Hashable @@ -6905,14 +6481,14 @@ module Google class GoogleCloudVisionV1p3beta1WebDetection include Google::Apis::Core::Hashable - # The service's best guess as to the topic of the request image. - # Inferred from similar images on the open web. + # The service's best guess as to the topic of the request image. Inferred from + # similar images on the open web. # Corresponds to the JSON property `bestGuessLabels` # @return [Array] attr_accessor :best_guess_labels - # Fully matching images from the Internet. - # Can include resized copies of the query image. + # Fully matching images from the Internet. Can include resized copies of the + # query image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -6922,9 +6498,9 @@ module Google # @return [Array] attr_accessor :pages_with_matching_images - # Partial matching images from the Internet. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its crops. + # Partial matching images from the Internet. Those images are similar enough to + # share some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -6968,8 +6544,8 @@ module Google # @return [String] attr_accessor :entity_id - # Overall relevancy score for the entity. - # Not normalized and not comparable across different image queries. + # Overall relevancy score for the entity. Not normalized and not comparable + # across different image queries. # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -7020,9 +6596,9 @@ module Google # @return [String] attr_accessor :label - # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - # For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more + # information, see http://www.unicode.org/reports/tr35/# + # Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -7042,8 +6618,8 @@ module Google class GoogleCloudVisionV1p3beta1WebDetectionWebPage include Google::Apis::Core::Hashable - # Fully matching images on the page. - # Can include resized copies of the query image. + # Fully matching images on the page. Can include resized copies of the query + # image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -7053,10 +6629,9 @@ module Google # @return [String] attr_accessor :page_title - # Partial matching images on the page. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its - # crops. + # Partial matching images on the page. Those images are similar enough to share + # some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -7104,8 +6679,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p3beta1TextAnnotationTextProperty] attr_accessor :property - # List of symbols in the word. - # The order of the symbols follows the natural reading order. + # List of symbols in the word. The order of the symbols follows the natural + # reading order. # Corresponds to the JSON property `symbols` # @return [Array] attr_accessor :symbols @@ -7128,12 +6703,12 @@ module Google class GoogleCloudVisionV1p4beta1AnnotateFileResponse 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::VisionV1p2beta1::Status] attr_accessor :error @@ -7143,8 +6718,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p4beta1InputConfig] attr_accessor :input_config - # Individual responses to images found within the file. This field will be - # empty if the `error` field is set. + # Individual responses to images found within the file. This field will be empty + # if the `error` field is set. # Corresponds to the JSON property `responses` # @return [Array] attr_accessor :responses @@ -7182,12 +6757,12 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p4beta1CropHintsAnnotation] attr_accessor :crop_hints_annotation - # 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::VisionV1p2beta1::Status] attr_accessor :error @@ -7197,13 +6772,12 @@ module Google # @return [Array] attr_accessor :face_annotations - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. # Corresponds to the JSON property `fullTextAnnotation` # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p4beta1TextAnnotation] attr_accessor :full_text_annotation @@ -7223,8 +6797,8 @@ module Google # @return [Array] attr_accessor :landmark_annotations - # If present, localized object detection has completed successfully. - # This will be sorted descending by confidence score. + # If present, localized object detection has completed successfully. This will + # be sorted descending by confidence score. # Corresponds to the JSON property `localizedObjectAnnotations` # @return [Array] attr_accessor :localized_object_annotations @@ -7239,9 +6813,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p4beta1ProductSearchResults] attr_accessor :product_search_results - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). # Corresponds to the JSON property `safeSearchAnnotation` # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p4beta1SafeSearchAnnotation] attr_accessor :safe_search_annotation @@ -7357,14 +6930,14 @@ module Google end end - # Metadata for the batch operations such as the current state. - # This is included in the `metadata` field of the `Operation` returned by the - # `GetOperation` call of the `google::longrunning::Operations` service. + # Metadata for the batch operations such as the current state. This is included + # in the `metadata` field of the `Operation` returned by the `GetOperation` call + # of the `google::longrunning::Operations` service. class GoogleCloudVisionV1p4beta1BatchOperationMetadata include Google::Apis::Core::Hashable - # The time when the batch request is finished and - # google.longrunning.Operation.done is set to true. + # The time when the batch request is finished and google.longrunning.Operation. + # done is set to true. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -7473,8 +7046,7 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the preloaded Celebrity. Has the format - # `builtin/`mid``. + # The resource name of the preloaded Celebrity. Has the format `builtin/`mid``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -7491,123 +7063,61 @@ module Google end end - # Color information consists of RGB channels, score, and the fraction of - # the image that the color occupies in the image. + # Color information consists of RGB channels, score, and the fraction of the + # image that the color occupies in the image. class GoogleCloudVisionV1p4beta1ColorInfo include Google::Apis::Core::Hashable # Represents a color in the RGBA color space. This representation is designed # for simplicity of conversion to/from color representations in various - # languages over compactness; for example, the fields of this representation - # can be trivially provided to the constructor of "java.awt.Color" in Java; it - # can also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" - # method in iOS; and, with just a little work, it can be easily formatted into - # a CSS "rgba()" string in JavaScript, as well. - # Note: this proto does not carry information about the absolute color space - # that should be used to interpret the RGB value (e.g. sRGB, Adobe RGB, - # DCI-P3, BT.2020, etc.). By default, applications SHOULD assume the sRGB color - # space. - # Note: when color equality needs to be decided, implementations, unless - # documented otherwise, will treat two colors to be equal if all their red, - # green, blue and alpha values each differ by at most 1e-5. - # Example (Java): - # import com.google.type.Color; - # // ... - # public static java.awt.Color fromProto(Color protocolor) ` - # float alpha = protocolor.hasAlpha() - # ? protocolor.getAlpha().getValue() - # : 1.0; - # return new java.awt.Color( - # protocolor.getRed(), - # protocolor.getGreen(), - # protocolor.getBlue(), - # alpha); - # ` - # public static Color toProto(java.awt.Color color) ` - # float red = (float) color.getRed(); - # float green = (float) color.getGreen(); - # float blue = (float) color.getBlue(); - # float denominator = 255.0; - # Color.Builder resultBuilder = - # Color - # .newBuilder() - # .setRed(red / denominator) - # .setGreen(green / denominator) - # .setBlue(blue / denominator); - # int alpha = color.getAlpha(); - # if (alpha != 255) ` - # result.setAlpha( - # FloatValue - # .newBuilder() - # .setValue(((float) alpha) / denominator) - # .build()); - # ` - # return resultBuilder.build(); - # ` - # // ... - # Example (iOS / Obj-C): - # // ... - # static UIColor* fromProto(Color* protocolor) ` - # float red = [protocolor red]; - # float green = [protocolor green]; - # float blue = [protocolor blue]; - # FloatValue* alpha_wrapper = [protocolor alpha]; - # float alpha = 1.0; - # if (alpha_wrapper != nil) ` - # alpha = [alpha_wrapper value]; - # ` - # return [UIColor colorWithRed:red green:green blue:blue alpha:alpha]; - # ` - # static Color* toProto(UIColor* color) ` - # CGFloat red, green, blue, alpha; - # if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) ` - # return nil; - # ` - # Color* result = [[Color alloc] init]; - # [result setRed:red]; - # [result setGreen:green]; - # [result setBlue:blue]; - # if (alpha <= 0.9999) ` - # [result setAlpha:floatWrapperWithValue(alpha)]; - # ` - # [result autorelease]; - # return result; - # ` - # // ... - # Example (JavaScript): - # // ... - # var protoToCssColor = function(rgb_color) ` - # var redFrac = rgb_color.red || 0.0; - # var greenFrac = rgb_color.green || 0.0; - # var blueFrac = rgb_color.blue || 0.0; - # var red = Math.floor(redFrac * 255); - # var green = Math.floor(greenFrac * 255); - # var blue = Math.floor(blueFrac * 255); - # if (!('alpha' in rgb_color)) ` - # return rgbToCssColor_(red, green, blue); - # ` - # var alphaFrac = rgb_color.alpha.value || 0.0; - # var rgbParams = [red, green, blue].join(','); - # return ['rgba(', rgbParams, ',', alphaFrac, ')'].join(''); - # `; - # var rgbToCssColor_ = function(red, green, blue) ` - # var rgbNumber = new Number((red << 16) | (green << 8) | blue); - # var hexString = rgbNumber.toString(16); - # var missingZeros = 6 - hexString.length; - # var resultBuilder = ['#']; - # for (var i = 0; i < missingZeros; i++) ` - # resultBuilder.push('0'); - # ` - # resultBuilder.push(hexString); - # return resultBuilder.join(''); - # `; - # // ... + # languages over compactness; for example, the fields of this representation can + # be trivially provided to the constructor of "java.awt.Color" in Java; it can + # also be trivially provided to UIColor's "+colorWithRed:green:blue:alpha" + # method in iOS; and, with just a little work, it can be easily formatted into a + # CSS "rgba()" string in JavaScript, as well. Note: this proto does not carry + # information about the absolute color space that should be used to interpret + # the RGB value (e.g. sRGB, Adobe RGB, DCI-P3, BT.2020, etc.). By default, + # applications SHOULD assume the sRGB color space. Note: when color equality + # needs to be decided, implementations, unless documented otherwise, will treat + # two colors to be equal if all their red, green, blue and alpha values each + # differ by at most 1e-5. Example (Java): import com.google.type.Color; // ... + # public static java.awt.Color fromProto(Color protocolor) ` float alpha = + # protocolor.hasAlpha() ? protocolor.getAlpha().getValue() : 1.0; return new + # java.awt.Color( protocolor.getRed(), protocolor.getGreen(), protocolor.getBlue( + # ), alpha); ` public static Color toProto(java.awt.Color color) ` float red = ( + # float) color.getRed(); float green = (float) color.getGreen(); float blue = ( + # float) color.getBlue(); float denominator = 255.0; Color.Builder resultBuilder + # = Color .newBuilder() .setRed(red / denominator) .setGreen(green / denominator) + # .setBlue(blue / denominator); int alpha = color.getAlpha(); if (alpha != 255) + # ` result.setAlpha( FloatValue .newBuilder() .setValue(((float) alpha) / + # denominator) .build()); ` return resultBuilder.build(); ` // ... Example (iOS / + # Obj-C): // ... static UIColor* fromProto(Color* protocolor) ` float red = [ + # protocolor red]; float green = [protocolor green]; float blue = [protocolor + # blue]; FloatValue* alpha_wrapper = [protocolor alpha]; float alpha = 1.0; if ( + # alpha_wrapper != nil) ` alpha = [alpha_wrapper value]; ` return [UIColor + # colorWithRed:red green:green blue:blue alpha:alpha]; ` static Color* toProto( + # UIColor* color) ` CGFloat red, green, blue, alpha; if (![color getRed:&red + # green:&green blue:&blue alpha:&alpha]) ` return nil; ` Color* result = [[Color + # alloc] init]; [result setRed:red]; [result setGreen:green]; [result setBlue: + # blue]; if (alpha <= 0.9999) ` [result setAlpha:floatWrapperWithValue(alpha)]; ` + # [result autorelease]; return result; ` // ... Example (JavaScript): // ... + # var protoToCssColor = function(rgb_color) ` var redFrac = rgb_color.red || 0.0; + # var greenFrac = rgb_color.green || 0.0; var blueFrac = rgb_color.blue || 0.0; + # var red = Math.floor(redFrac * 255); var green = Math.floor(greenFrac * 255); + # var blue = Math.floor(blueFrac * 255); if (!('alpha' in rgb_color)) ` return + # rgbToCssColor_(red, green, blue); ` var alphaFrac = rgb_color.alpha.value || 0. + # 0; var rgbParams = [red, green, blue].join(','); return ['rgba(', rgbParams, ', + # ', alphaFrac, ')'].join(''); `; var rgbToCssColor_ = function(red, green, blue) + # ` var rgbNumber = new Number((red << 16) | (green << 8) | blue); var + # hexString = rgbNumber.toString(16); var missingZeros = 6 - hexString.length; + # var resultBuilder = ['#']; for (var i = 0; i < missingZeros; i++) ` + # resultBuilder.push('0'); ` resultBuilder.push(hexString); return resultBuilder. + # join(''); `; // ... # Corresponds to the JSON property `color` # @return [Google::Apis::VisionV1p2beta1::Color] attr_accessor :color - # The fraction of pixels the color occupies in the image. - # Value in range [0, 1]. + # The fraction of pixels the color occupies in the image. Value in range [0, 1]. # Corresponds to the JSON property `pixelFraction` # @return [Float] attr_accessor :pixel_fraction @@ -7638,7 +7148,7 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p4beta1BoundingPoly] attr_accessor :bounding_poly - # Confidence of this being a salient region. Range [0, 1]. + # Confidence of this being a salient region. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -7708,11 +7218,10 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p4beta1BoundingPoly] attr_accessor :bounding_poly - # **Deprecated. Use `score` instead.** - # The accuracy of the entity detection in an image. - # For example, for an image in which the "Eiffel Tower" entity is detected, - # this field represents the confidence that there is a tower in the query - # image. Range [0, 1]. + # **Deprecated. Use `score` instead.** The accuracy of the entity detection in + # an image. For example, for an image in which the "Eiffel Tower" entity is + # detected, this field represents the confidence that there is a tower in the + # query image. Range [0, 1]. # Corresponds to the JSON property `confidence` # @return [Float] attr_accessor :confidence @@ -7722,30 +7231,29 @@ module Google # @return [String] attr_accessor :description - # The language code for the locale in which the entity textual - # `description` is expressed. + # The language code for the locale in which the entity textual `description` is + # expressed. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale - # The location information for the detected entity. Multiple - # `LocationInfo` elements can be present because one location may - # indicate the location of the scene in the image, and another location - # may indicate the location of the place where the image was taken. - # Location information is usually present for landmarks. + # The location information for the detected entity. Multiple `LocationInfo` + # elements can be present because one location may indicate the location of the + # scene in the image, and another location may indicate the location of the + # place where the image was taken. Location information is usually present for + # landmarks. # Corresponds to the JSON property `locations` # @return [Array] attr_accessor :locations - # Opaque entity ID. Some IDs may be available in - # [Google Knowledge Graph Search + # Opaque entity ID. Some IDs may be available in [Google Knowledge Graph Search # API](https://developers.google.com/knowledge-graph/). # Corresponds to the JSON property `mid` # @return [String] attr_accessor :mid - # Some entities may have optional user-supplied `Property` (name/value) - # fields, such a score or string that qualifies the entity. + # Some entities may have optional user-supplied `Property` (name/value) fields, + # such a score or string that qualifies the entity. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties @@ -7755,11 +7263,11 @@ module Google # @return [Float] attr_accessor :score - # The relevancy of the ICA (Image Content Annotation) label to the - # image. For example, the relevancy of "tower" is likely higher to an image - # containing the detected "Eiffel Tower" than to an image containing a - # detected distant towering building, even though the confidence that - # there is a tower in each image may be the same. Range [0, 1]. + # The relevancy of the ICA (Image Content Annotation) label to the image. For + # example, the relevancy of "tower" is likely higher to an image containing the + # detected "Eiffel Tower" than to an image containing a detected distant + # towering building, even though the confidence that there is a tower in each + # image may be the same. Range [0, 1]. # Corresponds to the JSON property `topicality` # @return [Float] attr_accessor :topicality @@ -7832,23 +7340,23 @@ module Google attr_accessor :landmarks # Yaw angle, which indicates the leftward/rightward angle that the face is - # pointing relative to the vertical plane perpendicular to the image. Range - # [-180,180]. + # pointing relative to the vertical plane perpendicular to the image. Range [- + # 180,180]. # Corresponds to the JSON property `panAngle` # @return [Float] attr_accessor :pan_angle - # Additional recognition information. Only computed if - # image_context.face_recognition_params is provided, **and** a match is found - # to a Celebrity in the input CelebritySet. This field is - # sorted in order of decreasing confidence values. + # Additional recognition information. Only computed if image_context. + # face_recognition_params is provided, **and** a match is found to a Celebrity + # in the input CelebritySet. This field is sorted in order of decreasing + # confidence values. # Corresponds to the JSON property `recognitionResult` # @return [Array] attr_accessor :recognition_result - # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation - # of the face relative to the image vertical about the axis perpendicular to - # the face. Range [-180,180]. + # Roll angle, which indicates the amount of clockwise/anti-clockwise rotation of + # the face relative to the image vertical about the axis perpendicular to the + # face. Range [-180,180]. # Corresponds to the JSON property `rollAngle` # @return [Float] attr_accessor :roll_angle @@ -7903,9 +7411,9 @@ module Google class GoogleCloudVisionV1p4beta1FaceAnnotationLandmark include Google::Apis::Core::Hashable - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. # Corresponds to the JSON property `position` # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p4beta1Position] attr_accessor :position @@ -7955,24 +7463,20 @@ module Google class GoogleCloudVisionV1p4beta1GcsDestination include Google::Apis::Core::Hashable - # Google Cloud Storage URI prefix where the results will be stored. Results - # will be in JSON format and preceded by its corresponding input URI prefix. - # This field can either represent a gcs file prefix or gcs directory. In - # either case, the uri should be unique because in order to get all of the - # output files, you will need to do a wildcard gcs search on the uri prefix - # you provide. - # Examples: - # * File Prefix: gs://bucket-name/here/filenameprefix The output files - # will be created in gs://bucket-name/here/ and the names of the - # output files will begin with "filenameprefix". - # * Directory Prefix: gs://bucket-name/some/location/ The output files - # will be created in gs://bucket-name/some/location/ and the names of the - # output files could be anything because there was no filename prefix - # specified. - # If multiple outputs, each response is still AnnotateFileResponse, each of - # which contains some subset of the full list of AnnotateImageResponse. - # Multiple outputs can happen if, for example, the output JSON is too large - # and overflows into multiple sharded files. + # Google Cloud Storage URI prefix where the results will be stored. Results will + # be in JSON format and preceded by its corresponding input URI prefix. This + # field can either represent a gcs file prefix or gcs directory. In either case, + # the uri should be unique because in order to get all of the output files, you + # will need to do a wildcard gcs search on the uri prefix you provide. Examples: + # * File Prefix: gs://bucket-name/here/filenameprefix The output files will be + # created in gs://bucket-name/here/ and the names of the output files will begin + # with "filenameprefix". * Directory Prefix: gs://bucket-name/some/location/ The + # output files will be created in gs://bucket-name/some/location/ and the names + # of the output files could be anything because there was no filename prefix + # specified. If multiple outputs, each response is still AnnotateFileResponse, + # each of which contains some subset of the full list of AnnotateImageResponse. + # Multiple outputs can happen if, for example, the output JSON is too large and + # overflows into multiple sharded files. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -7991,8 +7495,8 @@ module Google class GoogleCloudVisionV1p4beta1GcsSource include Google::Apis::Core::Hashable - # Google Cloud Storage URI for the input file. This must only be a - # Google Cloud Storage object. Wildcards are not currently supported. + # Google Cloud Storage URI for the input file. This must only be a Google Cloud + # Storage object. Wildcards are not currently supported. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -8012,8 +7516,8 @@ module Google class GoogleCloudVisionV1p4beta1ImageAnnotationContext include Google::Apis::Core::Hashable - # If the file was a PDF or TIFF, this field gives the page number within - # the file used to produce the image. + # If the file was a PDF or TIFF, this field gives the page number within the + # file used to produce the image. # Corresponds to the JSON property `pageNumber` # @return [Fixnum] attr_accessor :page_number @@ -8053,9 +7557,8 @@ module Google end end - # Response message for the `ImportProductSets` method. - # This message is returned by the - # google.longrunning.Operations.GetOperation method in the returned + # Response message for the `ImportProductSets` method. This message is returned + # by the google.longrunning.Operations.GetOperation method in the returned # google.longrunning.Operation.response field. class GoogleCloudVisionV1p4beta1ImportProductSetsResponse include Google::Apis::Core::Hashable @@ -8065,11 +7568,10 @@ module Google # @return [Array] attr_accessor :reference_images - # The rpc status for each ImportProductSet request, including both successes - # and errors. - # The number of statuses here matches the number of lines in the csv file, - # and statuses[i] stores the success or failure status of processing the i-th - # line of the csv, starting from line 0. + # The rpc status for each ImportProductSet request, including both successes and + # errors. The number of statuses here matches the number of lines in the csv + # file, and statuses[i] stores the success or failure status of processing the i- + # th line of the csv, starting from line 0. # Corresponds to the JSON property `statuses` # @return [Array] attr_accessor :statuses @@ -8089,11 +7591,11 @@ module Google class GoogleCloudVisionV1p4beta1InputConfig include Google::Apis::Core::Hashable - # File content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateFiles requests. It does - # not work for AsyncBatchAnnotateFiles requests. + # File content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -8104,8 +7606,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p4beta1GcsSource] attr_accessor :gcs_source - # The type of the file. Currently only "application/pdf", "image/tiff" and - # "image/gif" are supported. Wildcards are not supported. + # The type of the file. Currently only "application/pdf", "image/tiff" and " + # image/gif" are supported. Wildcards are not supported. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -8131,9 +7633,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p4beta1BoundingPoly] attr_accessor :bounding_poly - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -8173,9 +7674,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::VisionV1p2beta1::LatLng] attr_accessor :lat_lng @@ -8190,9 +7690,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class GoogleCloudVisionV1p4beta1NormalizedVertex include Google::Apis::Core::Hashable @@ -8252,13 +7751,11 @@ module Google class GoogleCloudVisionV1p4beta1OutputConfig include Google::Apis::Core::Hashable - # The max number of response protos to put into each output JSON file on - # Google Cloud Storage. - # The valid range is [1, 100]. If not specified, the default value is 20. - # For example, for one pdf file with 100 pages, 100 response protos will - # be generated. If `batch_size` = 20, then 5 json files each - # containing 20 response protos will be written under the prefix - # `gcs_destination`.`uri`. + # The max number of response protos to put into each output JSON file on Google + # Cloud Storage. The valid range is [1, 100]. If not specified, the default + # value is 20. For example, for one pdf file with 100 pages, 100 response protos + # will be generated. If `batch_size` = 20, then 5 json files each containing 20 + # response protos will be written under the prefix `gcs_destination`.`uri`. # Currently, batch_size only applies to GcsDestination, with potential future # support for other output configurations. # Corresponds to the JSON property `batchSize` @@ -8295,8 +7792,8 @@ module Google # @return [Float] attr_accessor :confidence - # Page height. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page height. For PDFs the unit is points. For images (including TIFFs) the + # unit is pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -8306,8 +7803,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p4beta1TextAnnotationTextProperty] attr_accessor :property - # Page width. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page width. For PDFs the unit is points. For images (including TIFFs) the unit + # is pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -8363,9 +7860,9 @@ module Google end end - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. class GoogleCloudVisionV1p4beta1Position include Google::Apis::Core::Hashable @@ -8412,33 +7909,28 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the product. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - # This field is ignored when creating a product. + # The resource name of the product. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Immutable. The category for the product identified by the reference image. - # This should - # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories - # "homegoods", "apparel", and "toys" are still supported, but these should - # not be used for new products. + # This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods- + # v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" + # are still supported, but these should not be used for new products. # Corresponds to the JSON property `productCategory` # @return [String] attr_accessor :product_category - # Key-value pairs that can be attached to a product. At query time, - # constraints can be specified based on the product_labels. - # Note that integer values can be provided as strings, e.g. "1199". Only - # strings with integer values can match a range-based restriction which is - # to be supported soon. - # Multiple values can be assigned to the same key. One product may have up to - # 500 product_labels. - # Notice that the total number of distinct product_labels over all products - # in one ProductSet cannot exceed 1M, otherwise the product search pipeline - # will refuse to work for that ProductSet. + # Key-value pairs that can be attached to a product. At query time, constraints + # can be specified based on the product_labels. Note that integer values can be + # provided as strings, e.g. "1199". Only strings with integer values can match a + # range-based restriction which is to be supported soon. Multiple values can be + # assigned to the same key. One product may have up to 500 product_labels. + # Notice that the total number of distinct product_labels over all products in + # one ProductSet cannot exceed 1M, otherwise the product search pipeline will + # refuse to work for that ProductSet. # Corresponds to the JSON property `productLabels` # @return [Array] attr_accessor :product_labels @@ -8467,8 +7959,8 @@ module Google # @return [String] attr_accessor :key - # The value of the label attached to the product. Cannot be empty and - # cannot exceed 128 bytes. + # The value of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -8489,8 +7981,8 @@ module Google include Google::Apis::Core::Hashable # Timestamp of the index which provided these results. Products added to the - # product set and products removed from the product set after this time are - # not reflected in the current results. + # product set and products removed from the product set after this time are not + # reflected in the current results. # Corresponds to the JSON property `indexTime` # @return [String] attr_accessor :index_time @@ -8520,8 +8012,7 @@ module Google end end - # Information about the products similar to a single product in a query - # image. + # Information about the products similar to a single product in a query image. class GoogleCloudVisionV1p4beta1ProductSearchResultsGroupedResult include Google::Apis::Core::Hashable @@ -8556,9 +8047,8 @@ module Google class GoogleCloudVisionV1p4beta1ProductSearchResultsObjectAnnotation include Google::Apis::Core::Hashable - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -8595,8 +8085,8 @@ module Google class GoogleCloudVisionV1p4beta1ProductSearchResultsResult include Google::Apis::Core::Hashable - # The resource name of the image from the product that is the closest match - # to the query. + # The resource name of the image from the product that is the closest match to + # the query. # Corresponds to the JSON property `image` # @return [String] attr_accessor :image @@ -8606,8 +8096,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p4beta1Product] attr_accessor :product - # A confidence level on the match, ranging from 0 (no confidence) to - # 1 (full confidence). + # A confidence level on the match, ranging from 0 (no confidence) to 1 (full + # confidence). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -8661,28 +8151,24 @@ module Google include Google::Apis::Core::Hashable # Optional. Bounding polygons around the areas of interest in the reference - # image. - # If this field is empty, the system will try to detect regions of - # interest. At most 10 bounding polygons will be used. - # The provided shape is converted into a non-rotated rectangle. Once - # converted, the small edge of the rectangle must be greater than or equal - # to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 - # is not). + # image. If this field is empty, the system will try to detect regions of + # interest. At most 10 bounding polygons will be used. The provided shape is + # converted into a non-rotated rectangle. Once converted, the small edge of the + # rectangle must be greater than or equal to 300 pixels. The aspect ratio must + # be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). # Corresponds to the JSON property `boundingPolys` # @return [Array] attr_accessor :bounding_polys - # The resource name of the reference image. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ - # IMAGE_ID`. - # This field is ignored when creating a reference image. + # The resource name of the reference image. Format is: `projects/PROJECT_ID/ + # locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is + # ignored when creating a reference image. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The Google Cloud Storage URI of the reference image. - # The URI must start with `gs://`. + # Required. The Google Cloud Storage URI of the reference image. The URI must + # start with `gs://`. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -8699,15 +8185,14 @@ module Google end end - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). class GoogleCloudVisionV1p4beta1SafeSearchAnnotation include Google::Apis::Core::Hashable # Represents the adult content likelihood for the image. Adult content may - # contain elements such as nudity, pornographic images or cartoons, or - # sexual activities. + # contain elements such as nudity, pornographic images or cartoons, or sexual + # activities. # Corresponds to the JSON property `adult` # @return [String] attr_accessor :adult @@ -8719,15 +8204,14 @@ module Google # Likelihood that the request image contains racy content. Racy content may # include (but is not limited to) skimpy or sheer clothing, strategically - # covered nudity, lewd or provocative poses, or close-ups of sensitive - # body areas. + # covered nudity, lewd or provocative poses, or close-ups of sensitive body + # areas. # Corresponds to the JSON property `racy` # @return [String] attr_accessor :racy - # Spoof likelihood. The likelihood that an modification - # was made to the image's canonical version to make it appear - # funny or offensive. + # Spoof likelihood. The likelihood that an modification was made to the image's + # canonical version to make it appear funny or offensive. # Corresponds to the JSON property `spoof` # @return [String] attr_accessor :spoof @@ -8788,13 +8272,12 @@ module Google end end - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. class GoogleCloudVisionV1p4beta1TextAnnotation include Google::Apis::Core::Hashable @@ -8854,9 +8337,8 @@ module Google # @return [Float] attr_accessor :confidence - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -8897,8 +8379,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the vertex coordinates are in the same scale as the original image. + # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are + # in the same scale as the original image. class GoogleCloudVisionV1p4beta1Vertex include Google::Apis::Core::Hashable @@ -8927,14 +8409,14 @@ module Google class GoogleCloudVisionV1p4beta1WebDetection include Google::Apis::Core::Hashable - # The service's best guess as to the topic of the request image. - # Inferred from similar images on the open web. + # The service's best guess as to the topic of the request image. Inferred from + # similar images on the open web. # Corresponds to the JSON property `bestGuessLabels` # @return [Array] attr_accessor :best_guess_labels - # Fully matching images from the Internet. - # Can include resized copies of the query image. + # Fully matching images from the Internet. Can include resized copies of the + # query image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -8944,9 +8426,9 @@ module Google # @return [Array] attr_accessor :pages_with_matching_images - # Partial matching images from the Internet. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its crops. + # Partial matching images from the Internet. Those images are similar enough to + # share some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -8990,8 +8472,8 @@ module Google # @return [String] attr_accessor :entity_id - # Overall relevancy score for the entity. - # Not normalized and not comparable across different image queries. + # Overall relevancy score for the entity. Not normalized and not comparable + # across different image queries. # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -9042,9 +8524,9 @@ module Google # @return [String] attr_accessor :label - # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - # For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more + # information, see http://www.unicode.org/reports/tr35/# + # Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -9064,8 +8546,8 @@ module Google class GoogleCloudVisionV1p4beta1WebDetectionWebPage include Google::Apis::Core::Hashable - # Fully matching images on the page. - # Can include resized copies of the query image. + # Fully matching images on the page. Can include resized copies of the query + # image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -9075,10 +8557,9 @@ module Google # @return [String] attr_accessor :page_title - # Partial matching images on the page. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its - # crops. + # Partial matching images on the page. Those images are similar enough to share + # some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -9126,8 +8607,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p4beta1TextAnnotationTextProperty] attr_accessor :property - # List of symbols in the word. - # The order of the symbols follows the natural reading order. + # List of symbols in the word. The order of the symbols follows the natural + # reading order. # Corresponds to the JSON property `symbols` # @return [Array] attr_accessor :symbols @@ -9145,8 +8626,7 @@ module Google end end - # Information about the products similar to a single product in a query - # image. + # Information about the products similar to a single product in a query image. class GroupedResult include Google::Apis::Core::Hashable @@ -9182,8 +8662,8 @@ module Google class ImageAnnotationContext include Google::Apis::Core::Hashable - # If the file was a PDF or TIFF, this field gives the page number within - # the file used to produce the image. + # If the file was a PDF or TIFF, this field gives the page number within the + # file used to produce the image. # Corresponds to the JSON property `pageNumber` # @return [Fixnum] attr_accessor :page_number @@ -9223,9 +8703,8 @@ module Google end end - # Response message for the `ImportProductSets` method. - # This message is returned by the - # google.longrunning.Operations.GetOperation method in the returned + # Response message for the `ImportProductSets` method. This message is returned + # by the google.longrunning.Operations.GetOperation method in the returned # google.longrunning.Operation.response field. class ImportProductSetsResponse include Google::Apis::Core::Hashable @@ -9235,11 +8714,10 @@ module Google # @return [Array] attr_accessor :reference_images - # The rpc status for each ImportProductSet request, including both successes - # and errors. - # The number of statuses here matches the number of lines in the csv file, - # and statuses[i] stores the success or failure status of processing the i-th - # line of the csv, starting from line 0. + # The rpc status for each ImportProductSet request, including both successes and + # errors. The number of statuses here matches the number of lines in the csv + # file, and statuses[i] stores the success or failure status of processing the i- + # th line of the csv, starting from line 0. # Corresponds to the JSON property `statuses` # @return [Array] attr_accessor :statuses @@ -9259,11 +8737,11 @@ module Google class InputConfig include Google::Apis::Core::Hashable - # File content, represented as a stream of bytes. - # Note: As with all `bytes` fields, protobuffers use a pure binary - # representation, whereas JSON representations use base64. - # Currently, this field only works for BatchAnnotateFiles requests. It does - # not work for AsyncBatchAnnotateFiles requests. + # File content, represented as a stream of bytes. Note: As with all `bytes` + # fields, protobuffers use a pure binary representation, whereas JSON + # representations use base64. Currently, this field only works for + # BatchAnnotateFiles requests. It does not work for AsyncBatchAnnotateFiles + # requests. # Corresponds to the JSON property `content` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -9274,8 +8752,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::GcsSource] attr_accessor :gcs_source - # The type of the file. Currently only "application/pdf", "image/tiff" and - # "image/gif" are supported. Wildcards are not supported. + # The type of the file. Currently only "application/pdf", "image/tiff" and " + # image/gif" are supported. Wildcards are not supported. # Corresponds to the JSON property `mimeType` # @return [String] attr_accessor :mime_type @@ -9302,8 +8780,8 @@ module Google # @return [String] attr_accessor :key - # The value of the label attached to the product. Cannot be empty and - # cannot exceed 128 bytes. + # The value of the label attached to the product. Cannot be empty and cannot + # exceed 128 bytes. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -9323,9 +8801,9 @@ module Google class Landmark include Google::Apis::Core::Hashable - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. # Corresponds to the JSON property `position` # @return [Google::Apis::VisionV1p2beta1::Position] attr_accessor :position @@ -9348,9 +8826,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. class LatLng include Google::Apis::Core::Hashable @@ -9384,9 +8861,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::BoundingPoly] attr_accessor :bounding_poly - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -9426,9 +8902,8 @@ module Google # An object representing a latitude/longitude pair. This is expressed as a pair # of doubles representing degrees latitude and degrees longitude. Unless - # specified otherwise, this must conform to the - # WGS84 - # standard. Values must be within normalized ranges. + # specified otherwise, this must conform to the WGS84 standard. Values must be + # within normalized ranges. # Corresponds to the JSON property `latLng` # @return [Google::Apis::VisionV1p2beta1::LatLng] attr_accessor :lat_lng @@ -9443,9 +8918,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the normalized vertex coordinates are relative to the original image - # and range from 0 to 1. + # A vertex represents a 2D point in the image. NOTE: the normalized vertex + # coordinates are relative to the original image and range from 0 to 1. class NormalizedVertex include Google::Apis::Core::Hashable @@ -9474,9 +8948,8 @@ module Google class ObjectAnnotation include Google::Apis::Core::Hashable - # The BCP-47 language code, such as "en-US" or "sr-Latn". For more - # information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, + # see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -9514,47 +8987,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::VisionV1p2beta1::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 @@ -9608,13 +9079,11 @@ module Google class OutputConfig include Google::Apis::Core::Hashable - # The max number of response protos to put into each output JSON file on - # Google Cloud Storage. - # The valid range is [1, 100]. If not specified, the default value is 20. - # For example, for one pdf file with 100 pages, 100 response protos will - # be generated. If `batch_size` = 20, then 5 json files each - # containing 20 response protos will be written under the prefix - # `gcs_destination`.`uri`. + # The max number of response protos to put into each output JSON file on Google + # Cloud Storage. The valid range is [1, 100]. If not specified, the default + # value is 20. For example, for one pdf file with 100 pages, 100 response protos + # will be generated. If `batch_size` = 20, then 5 json files each containing 20 + # response protos will be written under the prefix `gcs_destination`.`uri`. # Currently, batch_size only applies to GcsDestination, with potential future # support for other output configurations. # Corresponds to the JSON property `batchSize` @@ -9651,8 +9120,8 @@ module Google # @return [Float] attr_accessor :confidence - # Page height. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page height. For PDFs the unit is points. For images (including TIFFs) the + # unit is pixels. # Corresponds to the JSON property `height` # @return [Fixnum] attr_accessor :height @@ -9662,8 +9131,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::TextProperty] attr_accessor :property - # Page width. For PDFs the unit is points. For images (including - # TIFFs) the unit is pixels. + # Page width. For PDFs the unit is points. For images (including TIFFs) the unit + # is pixels. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -9719,9 +9188,9 @@ module Google end end - # A 3D position in the image, used primarily for Face detection landmarks. - # A valid Position must have both x and y coordinates. - # The position coordinates are in the same scale as the original image. + # A 3D position in the image, used primarily for Face detection landmarks. A + # valid Position must have both x and y coordinates. The position coordinates + # are in the same scale as the original image. class Position include Google::Apis::Core::Hashable @@ -9768,33 +9237,28 @@ module Google # @return [String] attr_accessor :display_name - # The resource name of the product. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. - # This field is ignored when creating a product. + # The resource name of the product. Format is: `projects/PROJECT_ID/locations/ + # LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Immutable. The category for the product identified by the reference image. - # This should - # be either "homegoods-v2", "apparel-v2", or "toys-v2". The legacy categories - # "homegoods", "apparel", and "toys" are still supported, but these should - # not be used for new products. + # This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods- + # v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" + # are still supported, but these should not be used for new products. # Corresponds to the JSON property `productCategory` # @return [String] attr_accessor :product_category - # Key-value pairs that can be attached to a product. At query time, - # constraints can be specified based on the product_labels. - # Note that integer values can be provided as strings, e.g. "1199". Only - # strings with integer values can match a range-based restriction which is - # to be supported soon. - # Multiple values can be assigned to the same key. One product may have up to - # 500 product_labels. - # Notice that the total number of distinct product_labels over all products - # in one ProductSet cannot exceed 1M, otherwise the product search pipeline - # will refuse to work for that ProductSet. + # Key-value pairs that can be attached to a product. At query time, constraints + # can be specified based on the product_labels. Note that integer values can be + # provided as strings, e.g. "1199". Only strings with integer values can match a + # range-based restriction which is to be supported soon. Multiple values can be + # assigned to the same key. One product may have up to 500 product_labels. + # Notice that the total number of distinct product_labels over all products in + # one ProductSet cannot exceed 1M, otherwise the product search pipeline will + # refuse to work for that ProductSet. # Corresponds to the JSON property `productLabels` # @return [Array] attr_accessor :product_labels @@ -9818,8 +9282,8 @@ module Google include Google::Apis::Core::Hashable # Timestamp of the index which provided these results. Products added to the - # product set and products removed from the product set after this time are - # not reflected in the current results. + # product set and products removed from the product set after this time are not + # reflected in the current results. # Corresponds to the JSON property `indexTime` # @return [String] attr_accessor :index_time @@ -9886,28 +9350,24 @@ module Google include Google::Apis::Core::Hashable # Optional. Bounding polygons around the areas of interest in the reference - # image. - # If this field is empty, the system will try to detect regions of - # interest. At most 10 bounding polygons will be used. - # The provided shape is converted into a non-rotated rectangle. Once - # converted, the small edge of the rectangle must be greater than or equal - # to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 - # is not). + # image. If this field is empty, the system will try to detect regions of + # interest. At most 10 bounding polygons will be used. The provided shape is + # converted into a non-rotated rectangle. Once converted, the small edge of the + # rectangle must be greater than or equal to 300 pixels. The aspect ratio must + # be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). # Corresponds to the JSON property `boundingPolys` # @return [Array] attr_accessor :bounding_polys - # The resource name of the reference image. - # Format is: - # `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/ - # IMAGE_ID`. - # This field is ignored when creating a reference image. + # The resource name of the reference image. Format is: `projects/PROJECT_ID/ + # locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is + # ignored when creating a reference image. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Required. The Google Cloud Storage URI of the reference image. - # The URI must start with `gs://`. + # Required. The Google Cloud Storage URI of the reference image. The URI must + # start with `gs://`. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -9928,8 +9388,8 @@ module Google class Result include Google::Apis::Core::Hashable - # The resource name of the image from the product that is the closest match - # to the query. + # The resource name of the image from the product that is the closest match to + # the query. # Corresponds to the JSON property `image` # @return [String] attr_accessor :image @@ -9939,8 +9399,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::Product] attr_accessor :product - # A confidence level on the match, ranging from 0 (no confidence) to - # 1 (full confidence). + # A confidence level on the match, ranging from 0 (no confidence) to 1 (full + # confidence). # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -9957,15 +9417,14 @@ module Google end end - # Set of features pertaining to the image, computed by computer vision - # methods over safe-search verticals (for example, adult, spoof, medical, - # violence). + # Set of features pertaining to the image, computed by computer vision methods + # over safe-search verticals (for example, adult, spoof, medical, violence). class SafeSearchAnnotation include Google::Apis::Core::Hashable # Represents the adult content likelihood for the image. Adult content may - # contain elements such as nudity, pornographic images or cartoons, or - # sexual activities. + # contain elements such as nudity, pornographic images or cartoons, or sexual + # activities. # Corresponds to the JSON property `adult` # @return [String] attr_accessor :adult @@ -9977,15 +9436,14 @@ module Google # Likelihood that the request image contains racy content. Racy content may # include (but is not limited to) skimpy or sheer clothing, strategically - # covered nudity, lewd or provocative poses, or close-ups of sensitive - # body areas. + # covered nudity, lewd or provocative poses, or close-ups of sensitive body + # areas. # Corresponds to the JSON property `racy` # @return [String] attr_accessor :racy - # Spoof likelihood. The likelihood that an modification - # was made to the image's canonical version to make it appear - # funny or offensive. + # Spoof likelihood. The likelihood that an modification was made to the image's + # canonical version to make it appear funny or offensive. # Corresponds to the JSON property `spoof` # @return [String] attr_accessor :spoof @@ -10009,12 +9467,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 @@ -10023,15 +9481,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 @@ -10085,13 +9543,12 @@ module Google end end - # TextAnnotation contains a structured representation of OCR extracted text. - # The hierarchy of an OCR extracted text structure is like this: - # TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol - # Each structural component, starting from Page, may further have their own - # properties. Properties describe detected languages, breaks etc.. Please refer - # to the TextAnnotation.TextProperty message definition below for more - # detail. + # TextAnnotation contains a structured representation of OCR extracted text. The + # hierarchy of an OCR extracted text structure is like this: TextAnnotation -> + # Page -> Block -> Paragraph -> Word -> Symbol Each structural component, + # starting from Page, may further have their own properties. Properties describe + # detected languages, breaks etc.. Please refer to the TextAnnotation. + # TextProperty message definition below for more detail. class TextAnnotation include Google::Apis::Core::Hashable @@ -10141,8 +9598,8 @@ module Google end end - # A vertex represents a 2D point in the image. - # NOTE: the vertex coordinates are in the same scale as the original image. + # A vertex represents a 2D point in the image. NOTE: the vertex coordinates are + # in the same scale as the original image. class Vertex include Google::Apis::Core::Hashable @@ -10171,14 +9628,14 @@ module Google class WebDetection include Google::Apis::Core::Hashable - # The service's best guess as to the topic of the request image. - # Inferred from similar images on the open web. + # The service's best guess as to the topic of the request image. Inferred from + # similar images on the open web. # Corresponds to the JSON property `bestGuessLabels` # @return [Array] attr_accessor :best_guess_labels - # Fully matching images from the Internet. - # Can include resized copies of the query image. + # Fully matching images from the Internet. Can include resized copies of the + # query image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -10188,9 +9645,9 @@ module Google # @return [Array] attr_accessor :pages_with_matching_images - # Partial matching images from the Internet. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its crops. + # Partial matching images from the Internet. Those images are similar enough to + # share some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -10234,8 +9691,8 @@ module Google # @return [String] attr_accessor :entity_id - # Overall relevancy score for the entity. - # Not normalized and not comparable across different image queries. + # Overall relevancy score for the entity. Not normalized and not comparable + # across different image queries. # Corresponds to the JSON property `score` # @return [Float] attr_accessor :score @@ -10286,9 +9743,9 @@ module Google # @return [String] attr_accessor :label - # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". - # For more information, see - # http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. + # The BCP-47 language code for `label`, such as "en-US" or "sr-Latn". For more + # information, see http://www.unicode.org/reports/tr35/# + # Unicode_locale_identifier. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code @@ -10308,8 +9765,8 @@ module Google class WebPage include Google::Apis::Core::Hashable - # Fully matching images on the page. - # Can include resized copies of the query image. + # Fully matching images on the page. Can include resized copies of the query + # image. # Corresponds to the JSON property `fullMatchingImages` # @return [Array] attr_accessor :full_matching_images @@ -10319,10 +9776,9 @@ module Google # @return [String] attr_accessor :page_title - # Partial matching images on the page. - # Those images are similar enough to share some key-point features. For - # example an original image will likely have partial matching for its - # crops. + # Partial matching images on the page. Those images are similar enough to share + # some key-point features. For example an original image will likely have + # partial matching for its crops. # Corresponds to the JSON property `partialMatchingImages` # @return [Array] attr_accessor :partial_matching_images @@ -10370,8 +9826,8 @@ module Google # @return [Google::Apis::VisionV1p2beta1::TextProperty] attr_accessor :property - # List of symbols in the word. - # The order of the symbols follows the natural reading order. + # List of symbols in the word. The order of the symbols follows the natural + # reading order. # Corresponds to the JSON property `symbols` # @return [Array] attr_accessor :symbols diff --git a/generated/google/apis/vision_v1p2beta1/service.rb b/generated/google/apis/vision_v1p2beta1/service.rb index 6b02b6692..80431b395 100644 --- a/generated/google/apis/vision_v1p2beta1/service.rb +++ b/generated/google/apis/vision_v1p2beta1/service.rb @@ -49,12 +49,11 @@ module Google @batch_path = 'batch' end - # Service that performs image detection and annotation for a batch of files. - # Now only "application/pdf", "image/tiff" and "image/gif" are supported. - # This service will extract at most 5 (customers can specify which 5 in - # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each - # file provided and perform detection and annotation for each image - # extracted. + # Service that performs image detection and annotation for a batch of files. Now + # only "application/pdf", "image/tiff" and "image/gif" are supported. This + # service will extract at most 5 (customers can specify which 5 in + # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file + # provided and perform detection and annotation for each image extracted. # @param [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest] google_cloud_vision_v1p2beta1_batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -84,12 +83,12 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of generic - # files, such as PDF files, which may contain multiple pages and multiple - # images per page. Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). + # Run asynchronous image detection and annotation for a list of generic files, + # such as PDF files, which may contain multiple pages and multiple images per + # page. Progress and results can be retrieved through the `google.longrunning. + # Operations` interface. `Operation.metadata` contains `OperationMetadata` ( + # metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` ( + # results). # @param [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest] google_cloud_vision_v1p2beta1_async_batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -149,13 +148,12 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of images. - # Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). - # This service will write image annotation outputs to json files in customer - # GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + # Run asynchronous image detection and annotation for a list of images. Progress + # and results can be retrieved through the `google.longrunning.Operations` + # interface. `Operation.metadata` contains `OperationMetadata` (metadata). ` + # Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). + # This service will write image annotation outputs to json files in customer GCS + # bucket, each json file containing BatchAnnotateImagesResponse proto. # @param [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest] google_cloud_vision_v1p2beta1_async_batch_annotate_images_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -185,21 +183,17 @@ module Google execute_or_queue_command(command, &block) end - # Service that performs image detection and annotation for a batch of files. - # Now only "application/pdf", "image/tiff" and "image/gif" are supported. - # This service will extract at most 5 (customers can specify which 5 in - # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each - # file provided and perform detection and annotation for each image - # extracted. + # Service that performs image detection and annotation for a batch of files. Now + # only "application/pdf", "image/tiff" and "image/gif" are supported. This + # service will extract at most 5 (customers can specify which 5 in + # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file + # provided and perform detection and annotation for each image extracted. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest] google_cloud_vision_v1p2beta1_batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -230,21 +224,18 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of generic - # files, such as PDF files, which may contain multiple pages and multiple - # images per page. Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). + # Run asynchronous image detection and annotation for a list of generic files, + # such as PDF files, which may contain multiple pages and multiple images per + # page. Progress and results can be retrieved through the `google.longrunning. + # Operations` interface. `Operation.metadata` contains `OperationMetadata` ( + # metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` ( + # results). # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest] google_cloud_vision_v1p2beta1_async_batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -277,14 +268,11 @@ module Google # Run image detection and annotation for a batch of images. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest] google_cloud_vision_v1p2beta1_batch_annotate_images_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -315,22 +303,18 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of images. - # Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). - # This service will write image annotation outputs to json files in customer - # GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + # Run asynchronous image detection and annotation for a list of images. Progress + # and results can be retrieved through the `google.longrunning.Operations` + # interface. `Operation.metadata` contains `OperationMetadata` (metadata). ` + # Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). + # This service will write image annotation outputs to json files in customer GCS + # bucket, each json file containing BatchAnnotateImagesResponse proto. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest] google_cloud_vision_v1p2beta1_async_batch_annotate_images_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -361,21 +345,17 @@ module Google execute_or_queue_command(command, &block) end - # Service that performs image detection and annotation for a batch of files. - # Now only "application/pdf", "image/tiff" and "image/gif" are supported. - # This service will extract at most 5 (customers can specify which 5 in - # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each - # file provided and perform detection and annotation for each image - # extracted. + # Service that performs image detection and annotation for a batch of files. Now + # only "application/pdf", "image/tiff" and "image/gif" are supported. This + # service will extract at most 5 (customers can specify which 5 in + # AnnotateFileRequest.pages) frames (gif) or pages (pdf or tiff) from each file + # provided and perform detection and annotation for each image extracted. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1BatchAnnotateFilesRequest] google_cloud_vision_v1p2beta1_batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -406,21 +386,18 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of generic - # files, such as PDF files, which may contain multiple pages and multiple - # images per page. Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateFilesResponse` (results). + # Run asynchronous image detection and annotation for a list of generic files, + # such as PDF files, which may contain multiple pages and multiple images per + # page. Progress and results can be retrieved through the `google.longrunning. + # Operations` interface. `Operation.metadata` contains `OperationMetadata` ( + # metadata). `Operation.response` contains `AsyncBatchAnnotateFilesResponse` ( + # results). # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1AsyncBatchAnnotateFilesRequest] google_cloud_vision_v1p2beta1_async_batch_annotate_files_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -453,14 +430,11 @@ module Google # Run image detection and annotation for a batch of images. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1BatchAnnotateImagesRequest] google_cloud_vision_v1p2beta1_batch_annotate_images_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -491,22 +465,18 @@ module Google execute_or_queue_command(command, &block) end - # Run asynchronous image detection and annotation for a list of images. - # Progress and results can be retrieved through the - # `google.longrunning.Operations` interface. - # `Operation.metadata` contains `OperationMetadata` (metadata). - # `Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). - # This service will write image annotation outputs to json files in customer - # GCS bucket, each json file containing BatchAnnotateImagesResponse proto. + # Run asynchronous image detection and annotation for a list of images. Progress + # and results can be retrieved through the `google.longrunning.Operations` + # interface. `Operation.metadata` contains `OperationMetadata` (metadata). ` + # Operation.response` contains `AsyncBatchAnnotateImagesResponse` (results). + # This service will write image annotation outputs to json files in customer GCS + # bucket, each json file containing BatchAnnotateImagesResponse proto. # @param [String] parent - # Optional. Target project and location to make a call. - # Format: `projects/`project-id`/locations/`location-id``. - # If no parent is specified, a region will be chosen automatically. - # Supported location-ids: - # `us`: USA country only, - # `asia`: East asia areas, like Japan, Taiwan, - # `eu`: The European Union. - # Example: `projects/project-A/locations/eu`. + # Optional. Target project and location to make a call. Format: `projects/` + # project-id`/locations/`location-id``. If no parent is specified, a region will + # be chosen automatically. Supported location-ids: `us`: USA country only, `asia` + # : East asia areas, like Japan, Taiwan, `eu`: The European Union. Example: ` + # projects/project-A/locations/eu`. # @param [Google::Apis::VisionV1p2beta1::GoogleCloudVisionV1p2beta1AsyncBatchAnnotateImagesRequest] google_cloud_vision_v1p2beta1_async_batch_annotate_images_request_object # @param [String] fields # Selector specifying which fields to include in a partial response.