From 40a47d47c526b44cdfb91a34d20dd0194d2935a7 Mon Sep 17 00:00:00 2001 From: Google APIs Date: Tue, 18 Aug 2020 00:38:22 +0000 Subject: [PATCH] Autogenerated update (2020-08-18) Update: - androidpublisher_v3 - cloudbilling_v1 - datastore_v1 - datastore_v1beta1 - datastore_v1beta3 - firebaseml_v1beta2 - firestore_v1 - firestore_v1beta1 - firestore_v1beta2 - gmailpostmastertools_v1beta1 - healthcare_v1 - healthcare_v1beta1 - lifesciences_v2beta - oslogin_v1 - oslogin_v1beta - sasportal_v1alpha1 - securitycenter_v1p1beta1 - sheets_v4 --- api_names_out.yaml | 770 ++ generated/google/apis/androidpublisher_v3.rb | 2 +- .../apis/androidpublisher_v3/service.rb | 4 +- generated/google/apis/cloudbilling_v1.rb | 2 +- .../google/apis/cloudbilling_v1/classes.rb | 729 +- .../google/apis/cloudbilling_v1/service.rb | 228 +- generated/google/apis/datastore_v1.rb | 2 +- generated/google/apis/datastore_v1/classes.rb | 802 +- generated/google/apis/datastore_v1/service.rb | 115 +- generated/google/apis/datastore_v1beta1.rb | 2 +- .../google/apis/datastore_v1beta1/classes.rb | 367 +- .../google/apis/datastore_v1beta1/service.rb | 23 +- generated/google/apis/datastore_v1beta3.rb | 2 +- .../google/apis/datastore_v1beta3/classes.rb | 626 +- .../google/apis/datastore_v1beta3/service.rb | 3 +- generated/google/apis/dialogflow_v3beta1.rb | 38 + .../google/apis/dialogflow_v3beta1/classes.rb | 5638 ++++++++++++ .../dialogflow_v3beta1/representations.rb | 2425 ++++++ .../google/apis/dialogflow_v3beta1/service.rb | 288 + generated/google/apis/firebaseml_v1beta2.rb | 2 +- .../google/apis/firebaseml_v1beta2/classes.rb | 8 - .../firebaseml_v1beta2/representations.rb | 1 - generated/google/apis/firestore_v1.rb | 2 +- generated/google/apis/firestore_v1/classes.rb | 900 +- generated/google/apis/firestore_v1/service.rb | 366 +- generated/google/apis/firestore_v1beta1.rb | 2 +- .../google/apis/firestore_v1beta1/classes.rb | 743 +- .../google/apis/firestore_v1beta1/service.rb | 228 +- generated/google/apis/firestore_v1beta2.rb | 2 +- .../google/apis/firestore_v1beta2/classes.rb | 300 +- .../google/apis/firestore_v1beta2/service.rb | 151 +- .../apis/gmailpostmastertools_v1beta1.rb | 4 +- .../gmailpostmastertools_v1beta1/service.rb | 2 +- generated/google/apis/healthcare_v1.rb | 2 +- .../google/apis/healthcare_v1/classes.rb | 4 +- generated/google/apis/healthcare_v1beta1.rb | 2 +- .../google/apis/healthcare_v1beta1/classes.rb | 35 +- .../healthcare_v1beta1/representations.rb | 16 + generated/google/apis/lifesciences_v2beta.rb | 2 +- .../apis/lifesciences_v2beta/classes.rb | 552 +- .../apis/lifesciences_v2beta/service.rb | 72 +- generated/google/apis/oslogin_v1.rb | 2 +- generated/google/apis/oslogin_v1/classes.rb | 6 + .../google/apis/oslogin_v1/representations.rb | 1 + generated/google/apis/oslogin_v1beta.rb | 2 +- .../google/apis/oslogin_v1beta/classes.rb | 6 + .../apis/oslogin_v1beta/representations.rb | 1 + generated/google/apis/sasportal_v1alpha1.rb | 2 +- .../google/apis/sasportal_v1alpha1/classes.rb | 6 + .../sasportal_v1alpha1/representations.rb | 1 + .../google/apis/securitycenter_v1p1beta1.rb | 2 +- .../apis/securitycenter_v1p1beta1/classes.rb | 4 +- .../apis/securitycenter_v1p1beta1/service.rb | 10 +- generated/google/apis/sheets_v4.rb | 2 +- generated/google/apis/sheets_v4/classes.rb | 7561 ++++++----------- generated/google/apis/sheets_v4/service.rb | 262 +- 56 files changed, 14647 insertions(+), 8683 deletions(-) create mode 100644 generated/google/apis/dialogflow_v3beta1.rb create mode 100644 generated/google/apis/dialogflow_v3beta1/classes.rb create mode 100644 generated/google/apis/dialogflow_v3beta1/representations.rb create mode 100644 generated/google/apis/dialogflow_v3beta1/service.rb diff --git a/api_names_out.yaml b/api_names_out.yaml index 088810bcd..966c317a9 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -84433,6 +84433,769 @@ "/dialogflow:v2beta1/fields": fields "/dialogflow:v2beta1/key": key "/dialogflow:v2beta1/quotaUser": quota_user +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata": google_cloud_dialogflow_cx_v3beta1_create_version_operation_metadata +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata/version": version +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ExportAgentResponse": google_cloud_dialogflow_cx_v3beta1_export_agent_response +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ExportAgentResponse/agentContent": agent_content +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ExportAgentResponse/agentUri": agent_uri +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1PageInfo": google_cloud_dialogflow_cx_v3beta1_page_info +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1PageInfo/currentPage": current_page +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1PageInfo/formInfo": form_info +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1PageInfoFormInfo": google_cloud_dialogflow_cx_v3beta1_page_info_form_info +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1PageInfoFormInfo/parameterInfo": parameter_info +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1PageInfoFormInfo/parameterInfo/parameter_info": parameter_info +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo": google_cloud_dialogflow_cx_v3beta1_page_info_form_info_parameter_info +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo/displayName": display_name +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo/justCollected": just_collected +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo/required": required +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo/state": state +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo/value": value +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessage": google_cloud_dialogflow_cx_v3beta1_response_message +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessage/conversationSuccess": conversation_success +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessage/endInteraction": end_interaction +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessage/humanAgentHandoff": human_agent_handoff +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessage/liveAgentHandoff": live_agent_handoff +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessage/mixedAudio": mixed_audio +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessage/outputAudioText": output_audio_text +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessage/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessage/payload/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessage/playAudio": play_audio +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessage/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess": google_cloud_dialogflow_cx_v3beta1_response_message_conversation_success +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess/metadata": metadata +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess/metadata/metadatum": metadatum +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction": google_cloud_dialogflow_cx_v3beta1_response_message_end_interaction +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff": google_cloud_dialogflow_cx_v3beta1_response_message_human_agent_handoff +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff/metadata": metadata +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff/metadata/metadatum": metadatum +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff": google_cloud_dialogflow_cx_v3beta1_response_message_live_agent_handoff +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff/metadata": metadata +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff/metadata/metadatum": metadatum +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio": google_cloud_dialogflow_cx_v3beta1_response_message_mixed_audio +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio/segments": segments +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio/segments/segment": segment +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment": google_cloud_dialogflow_cx_v3beta1_response_message_mixed_audio_segment +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment/allowPlaybackInterruption": allow_playback_interruption +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment/audio": audio +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment/uri": uri +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText": google_cloud_dialogflow_cx_v3beta1_response_message_output_audio_text +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText/ssml": ssml +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio": google_cloud_dialogflow_cx_v3beta1_response_message_play_audio +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio/allowPlaybackInterruption": allow_playback_interruption +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio/audioUri": audio_uri +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageText": google_cloud_dialogflow_cx_v3beta1_response_message_text +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageText/allowPlaybackInterruption": allow_playback_interruption +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageText/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1ResponseMessageText/text/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1SessionInfo": google_cloud_dialogflow_cx_v3beta1_session_info +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1SessionInfo/parameters": parameters +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1SessionInfo/parameters/parameter": parameter +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1SessionInfo/session": session +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequest": google_cloud_dialogflow_cx_v3beta1_webhook_request +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequest/detectIntentResponseId": detect_intent_response_id +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequest/fulfillmentInfo": fulfillment_info +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequest/intentInfo": intent_info +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequest/messages": messages +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequest/messages/message": message +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequest/pageInfo": page_info +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequest/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequest/payload/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequest/sessionInfo": session_info +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo": google_cloud_dialogflow_cx_v3beta1_webhook_request_fulfillment_info +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo/tag": tag +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo": google_cloud_dialogflow_cx_v3beta1_webhook_request_intent_info +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo/lastMatchedIntent": last_matched_intent +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo/parameters": parameters +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo/parameters/parameter": parameter +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue": google_cloud_dialogflow_cx_v3beta1_webhook_request_intent_info_intent_parameter_value +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue/originalValue": original_value +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue/resolvedValue": resolved_value +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookResponse": google_cloud_dialogflow_cx_v3beta1_webhook_response +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookResponse/fulfillmentResponse": fulfillment_response +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookResponse/pageInfo": page_info +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookResponse/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookResponse/payload/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookResponse/sessionInfo": session_info +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookResponse/targetFlow": target_flow +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookResponse/targetPage": target_page +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse": google_cloud_dialogflow_cx_v3beta1_webhook_response_fulfillment_response +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse/mergeBehavior": merge_behavior +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse/messages": messages +"/dialogflow:v3beta1/GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse/messages/message": message +"/dialogflow:v3beta1/GoogleCloudDialogflowV2AnnotatedMessagePart": google_cloud_dialogflow_v2_annotated_message_part +"/dialogflow:v3beta1/GoogleCloudDialogflowV2AnnotatedMessagePart/entityType": entity_type +"/dialogflow:v3beta1/GoogleCloudDialogflowV2AnnotatedMessagePart/formattedValue": formatted_value +"/dialogflow:v3beta1/GoogleCloudDialogflowV2AnnotatedMessagePart/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse": google_cloud_dialogflow_v2_batch_update_entity_types_response +"/dialogflow:v3beta1/GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse/entityTypes": entity_types +"/dialogflow:v3beta1/GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse/entityTypes/entity_type": entity_type +"/dialogflow:v3beta1/GoogleCloudDialogflowV2BatchUpdateIntentsResponse": google_cloud_dialogflow_v2_batch_update_intents_response +"/dialogflow:v3beta1/GoogleCloudDialogflowV2BatchUpdateIntentsResponse/intents": intents +"/dialogflow:v3beta1/GoogleCloudDialogflowV2BatchUpdateIntentsResponse/intents/intent": intent +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Context": google_cloud_dialogflow_v2_context +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Context/lifespanCount": lifespan_count +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Context/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Context/parameters": parameters +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Context/parameters/parameter": parameter +"/dialogflow:v3beta1/GoogleCloudDialogflowV2ConversationEvent": google_cloud_dialogflow_v2_conversation_event +"/dialogflow:v3beta1/GoogleCloudDialogflowV2ConversationEvent/conversation": conversation +"/dialogflow:v3beta1/GoogleCloudDialogflowV2ConversationEvent/errorStatus": error_status +"/dialogflow:v3beta1/GoogleCloudDialogflowV2ConversationEvent/newMessagePayload": new_message_payload +"/dialogflow:v3beta1/GoogleCloudDialogflowV2ConversationEvent/type": type +"/dialogflow:v3beta1/GoogleCloudDialogflowV2EntityType": google_cloud_dialogflow_v2_entity_type +"/dialogflow:v3beta1/GoogleCloudDialogflowV2EntityType/autoExpansionMode": auto_expansion_mode +"/dialogflow:v3beta1/GoogleCloudDialogflowV2EntityType/displayName": display_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2EntityType/enableFuzzyExtraction": enable_fuzzy_extraction +"/dialogflow:v3beta1/GoogleCloudDialogflowV2EntityType/entities": entities +"/dialogflow:v3beta1/GoogleCloudDialogflowV2EntityType/entities/entity": entity +"/dialogflow:v3beta1/GoogleCloudDialogflowV2EntityType/kind": kind +"/dialogflow:v3beta1/GoogleCloudDialogflowV2EntityType/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2EntityTypeEntity": google_cloud_dialogflow_v2_entity_type_entity +"/dialogflow:v3beta1/GoogleCloudDialogflowV2EntityTypeEntity/synonyms": synonyms +"/dialogflow:v3beta1/GoogleCloudDialogflowV2EntityTypeEntity/synonyms/synonym": synonym +"/dialogflow:v3beta1/GoogleCloudDialogflowV2EntityTypeEntity/value": value +"/dialogflow:v3beta1/GoogleCloudDialogflowV2EventInput": google_cloud_dialogflow_v2_event_input +"/dialogflow:v3beta1/GoogleCloudDialogflowV2EventInput/languageCode": language_code +"/dialogflow:v3beta1/GoogleCloudDialogflowV2EventInput/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2EventInput/parameters": parameters +"/dialogflow:v3beta1/GoogleCloudDialogflowV2EventInput/parameters/parameter": parameter +"/dialogflow:v3beta1/GoogleCloudDialogflowV2ExportAgentResponse": google_cloud_dialogflow_v2_export_agent_response +"/dialogflow:v3beta1/GoogleCloudDialogflowV2ExportAgentResponse/agentContent": agent_content +"/dialogflow:v3beta1/GoogleCloudDialogflowV2ExportAgentResponse/agentUri": agent_uri +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent": google_cloud_dialogflow_v2_intent +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/action": action +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/defaultResponsePlatforms": default_response_platforms +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/defaultResponsePlatforms/default_response_platform": default_response_platform +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/displayName": display_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/events": events +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/events/event": event +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/followupIntentInfo": followup_intent_info +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/followupIntentInfo/followup_intent_info": followup_intent_info +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/inputContextNames": input_context_names +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/inputContextNames/input_context_name": input_context_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/isFallback": is_fallback +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/messages": messages +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/messages/message": message +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/mlDisabled": ml_disabled +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/outputContexts": output_contexts +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/outputContexts/output_context": output_context +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/parameters": parameters +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/parameters/parameter": parameter +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/parentFollowupIntentName": parent_followup_intent_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/priority": priority +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/resetContexts": reset_contexts +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/rootFollowupIntentName": root_followup_intent_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/trainingPhrases": training_phrases +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/trainingPhrases/training_phrase": training_phrase +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Intent/webhookState": webhook_state +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentFollowupIntentInfo": google_cloud_dialogflow_v2_intent_followup_intent_info +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentFollowupIntentInfo/followupIntentName": followup_intent_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentFollowupIntentInfo/parentFollowupIntentName": parent_followup_intent_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessage": google_cloud_dialogflow_v2_intent_message +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessage/basicCard": basic_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessage/browseCarouselCard": browse_carousel_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessage/card": card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessage/carouselSelect": carousel_select +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessage/image": image +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessage/linkOutSuggestion": link_out_suggestion +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessage/listSelect": list_select +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessage/mediaContent": media_content +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessage/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessage/payload/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessage/platform": platform +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessage/quickReplies": quick_replies +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessage/simpleResponses": simple_responses +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessage/suggestions": suggestions +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessage/tableCard": table_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessage/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBasicCard": google_cloud_dialogflow_v2_intent_message_basic_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBasicCard/buttons": buttons +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBasicCard/buttons/button": button +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBasicCard/formattedText": formatted_text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBasicCard/image": image +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBasicCard/subtitle": subtitle +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBasicCard/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBasicCardButton": google_cloud_dialogflow_v2_intent_message_basic_card_button +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBasicCardButton/openUriAction": open_uri_action +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBasicCardButton/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction": google_cloud_dialogflow_v2_intent_message_basic_card_button_open_uri_action +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction/uri": uri +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard": google_cloud_dialogflow_v2_intent_message_browse_carousel_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard/imageDisplayOptions": image_display_options +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard/items": items +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard/items/item": item +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem": google_cloud_dialogflow_v2_intent_message_browse_carousel_card_browse_carousel_card_item +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem/description": description +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem/footer": footer +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem/image": image +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem/openUriAction": open_uri_action +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction": google_cloud_dialogflow_v2_intent_message_browse_carousel_card_browse_carousel_card_item_open_url_action +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction/url": url +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction/urlTypeHint": url_type_hint +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageCard": google_cloud_dialogflow_v2_intent_message_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageCard/buttons": buttons +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageCard/buttons/button": button +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageCard/imageUri": image_uri +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageCard/subtitle": subtitle +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageCard/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageCardButton": google_cloud_dialogflow_v2_intent_message_card_button +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageCardButton/postback": postback +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageCardButton/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageCarouselSelect": google_cloud_dialogflow_v2_intent_message_carousel_select +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageCarouselSelect/items": items +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageCarouselSelect/items/item": item +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageCarouselSelectItem": google_cloud_dialogflow_v2_intent_message_carousel_select_item +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageCarouselSelectItem/description": description +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageCarouselSelectItem/image": image +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageCarouselSelectItem/info": info +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageCarouselSelectItem/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageColumnProperties": google_cloud_dialogflow_v2_intent_message_column_properties +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageColumnProperties/header": header +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageColumnProperties/horizontalAlignment": horizontal_alignment +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageImage": google_cloud_dialogflow_v2_intent_message_image +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageImage/accessibilityText": accessibility_text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageImage/imageUri": image_uri +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion": google_cloud_dialogflow_v2_intent_message_link_out_suggestion +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion/destinationName": destination_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion/uri": uri +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageListSelect": google_cloud_dialogflow_v2_intent_message_list_select +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageListSelect/items": items +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageListSelect/items/item": item +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageListSelect/subtitle": subtitle +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageListSelect/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageListSelectItem": google_cloud_dialogflow_v2_intent_message_list_select_item +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageListSelectItem/description": description +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageListSelectItem/image": image +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageListSelectItem/info": info +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageListSelectItem/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageMediaContent": google_cloud_dialogflow_v2_intent_message_media_content +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageMediaContent/mediaObjects": media_objects +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageMediaContent/mediaObjects/media_object": media_object +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageMediaContent/mediaType": media_type +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject": google_cloud_dialogflow_v2_intent_message_media_content_response_media_object +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject/contentUrl": content_url +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject/description": description +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject/icon": icon +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject/largeImage": large_image +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageQuickReplies": google_cloud_dialogflow_v2_intent_message_quick_replies +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageQuickReplies/quickReplies": quick_replies +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageQuickReplies/quickReplies/quick_reply": quick_reply +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageQuickReplies/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageSelectItemInfo": google_cloud_dialogflow_v2_intent_message_select_item_info +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageSelectItemInfo/key": key +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageSelectItemInfo/synonyms": synonyms +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageSelectItemInfo/synonyms/synonym": synonym +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageSimpleResponse": google_cloud_dialogflow_v2_intent_message_simple_response +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageSimpleResponse/displayText": display_text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageSimpleResponse/ssml": ssml +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageSimpleResponse/textToSpeech": text_to_speech +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageSimpleResponses": google_cloud_dialogflow_v2_intent_message_simple_responses +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageSimpleResponses/simpleResponses": simple_responses +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageSimpleResponses/simpleResponses/simple_response": simple_response +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageSuggestion": google_cloud_dialogflow_v2_intent_message_suggestion +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageSuggestion/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageSuggestions": google_cloud_dialogflow_v2_intent_message_suggestions +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageSuggestions/suggestions": suggestions +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageSuggestions/suggestions/suggestion": suggestion +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageTableCard": google_cloud_dialogflow_v2_intent_message_table_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageTableCard/buttons": buttons +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageTableCard/buttons/button": button +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageTableCard/columnProperties": column_properties +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageTableCard/columnProperties/column_property": column_property +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageTableCard/image": image +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageTableCard/rows": rows +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageTableCard/rows/row": row +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageTableCard/subtitle": subtitle +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageTableCard/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageTableCardCell": google_cloud_dialogflow_v2_intent_message_table_card_cell +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageTableCardCell/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageTableCardRow": google_cloud_dialogflow_v2_intent_message_table_card_row +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageTableCardRow/cells": cells +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageTableCardRow/cells/cell": cell +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageTableCardRow/dividerAfter": divider_after +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageText": google_cloud_dialogflow_v2_intent_message_text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageText/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentMessageText/text/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentParameter": google_cloud_dialogflow_v2_intent_parameter +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentParameter/defaultValue": default_value +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentParameter/displayName": display_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentParameter/entityTypeDisplayName": entity_type_display_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentParameter/isList": is_list +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentParameter/mandatory": mandatory +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentParameter/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentParameter/prompts": prompts +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentParameter/prompts/prompt": prompt +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentParameter/value": value +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentTrainingPhrase": google_cloud_dialogflow_v2_intent_training_phrase +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentTrainingPhrase/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentTrainingPhrase/parts": parts +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentTrainingPhrase/parts/part": part +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentTrainingPhrase/timesAddedCount": times_added_count +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentTrainingPhrase/type": type +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentTrainingPhrasePart": google_cloud_dialogflow_v2_intent_training_phrase_part +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentTrainingPhrasePart/alias": alias +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentTrainingPhrasePart/entityType": entity_type +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentTrainingPhrasePart/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2IntentTrainingPhrasePart/userDefined": user_defined +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Message": google_cloud_dialogflow_v2_message +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Message/content": content +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Message/createTime": create_time +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Message/languageCode": language_code +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Message/messageAnnotation": message_annotation +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Message/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Message/participant": participant +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Message/participantRole": participant_role +"/dialogflow:v3beta1/GoogleCloudDialogflowV2MessageAnnotation": google_cloud_dialogflow_v2_message_annotation +"/dialogflow:v3beta1/GoogleCloudDialogflowV2MessageAnnotation/containEntities": contain_entities +"/dialogflow:v3beta1/GoogleCloudDialogflowV2MessageAnnotation/parts": parts +"/dialogflow:v3beta1/GoogleCloudDialogflowV2MessageAnnotation/parts/part": part +"/dialogflow:v3beta1/GoogleCloudDialogflowV2OriginalDetectIntentRequest": google_cloud_dialogflow_v2_original_detect_intent_request +"/dialogflow:v3beta1/GoogleCloudDialogflowV2OriginalDetectIntentRequest/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowV2OriginalDetectIntentRequest/payload/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowV2OriginalDetectIntentRequest/source": source +"/dialogflow:v3beta1/GoogleCloudDialogflowV2OriginalDetectIntentRequest/version": version +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult": google_cloud_dialogflow_v2_query_result +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/action": action +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/allRequiredParamsPresent": all_required_params_present +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/diagnosticInfo": diagnostic_info +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/diagnosticInfo/diagnostic_info": diagnostic_info +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/fulfillmentMessages": fulfillment_messages +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/fulfillmentMessages/fulfillment_message": fulfillment_message +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/fulfillmentText": fulfillment_text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/intent": intent +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/intentDetectionConfidence": intent_detection_confidence +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/languageCode": language_code +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/outputContexts": output_contexts +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/outputContexts/output_context": output_context +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/parameters": parameters +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/parameters/parameter": parameter +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/queryText": query_text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/sentimentAnalysisResult": sentiment_analysis_result +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/speechRecognitionConfidence": speech_recognition_confidence +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/webhookPayload": webhook_payload +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/webhookPayload/webhook_payload": webhook_payload +"/dialogflow:v3beta1/GoogleCloudDialogflowV2QueryResult/webhookSource": webhook_source +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Sentiment": google_cloud_dialogflow_v2_sentiment +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Sentiment/magnitude": magnitude +"/dialogflow:v3beta1/GoogleCloudDialogflowV2Sentiment/score": score +"/dialogflow:v3beta1/GoogleCloudDialogflowV2SentimentAnalysisResult": google_cloud_dialogflow_v2_sentiment_analysis_result +"/dialogflow:v3beta1/GoogleCloudDialogflowV2SentimentAnalysisResult/queryTextSentiment": query_text_sentiment +"/dialogflow:v3beta1/GoogleCloudDialogflowV2SessionEntityType": google_cloud_dialogflow_v2_session_entity_type +"/dialogflow:v3beta1/GoogleCloudDialogflowV2SessionEntityType/entities": entities +"/dialogflow:v3beta1/GoogleCloudDialogflowV2SessionEntityType/entities/entity": entity +"/dialogflow:v3beta1/GoogleCloudDialogflowV2SessionEntityType/entityOverrideMode": entity_override_mode +"/dialogflow:v3beta1/GoogleCloudDialogflowV2SessionEntityType/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2WebhookRequest": google_cloud_dialogflow_v2_webhook_request +"/dialogflow:v3beta1/GoogleCloudDialogflowV2WebhookRequest/originalDetectIntentRequest": original_detect_intent_request +"/dialogflow:v3beta1/GoogleCloudDialogflowV2WebhookRequest/queryResult": query_result +"/dialogflow:v3beta1/GoogleCloudDialogflowV2WebhookRequest/responseId": response_id +"/dialogflow:v3beta1/GoogleCloudDialogflowV2WebhookRequest/session": session +"/dialogflow:v3beta1/GoogleCloudDialogflowV2WebhookResponse": google_cloud_dialogflow_v2_webhook_response +"/dialogflow:v3beta1/GoogleCloudDialogflowV2WebhookResponse/followupEventInput": followup_event_input +"/dialogflow:v3beta1/GoogleCloudDialogflowV2WebhookResponse/fulfillmentMessages": fulfillment_messages +"/dialogflow:v3beta1/GoogleCloudDialogflowV2WebhookResponse/fulfillmentMessages/fulfillment_message": fulfillment_message +"/dialogflow:v3beta1/GoogleCloudDialogflowV2WebhookResponse/fulfillmentText": fulfillment_text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2WebhookResponse/outputContexts": output_contexts +"/dialogflow:v3beta1/GoogleCloudDialogflowV2WebhookResponse/outputContexts/output_context": output_context +"/dialogflow:v3beta1/GoogleCloudDialogflowV2WebhookResponse/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowV2WebhookResponse/payload/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowV2WebhookResponse/sessionEntityTypes": session_entity_types +"/dialogflow:v3beta1/GoogleCloudDialogflowV2WebhookResponse/sessionEntityTypes/session_entity_type": session_entity_type +"/dialogflow:v3beta1/GoogleCloudDialogflowV2WebhookResponse/source": source +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1AnnotatedConversationDataset": google_cloud_dialogflow_v2beta1_annotated_conversation_dataset +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1AnnotatedConversationDataset/completedExampleCount": completed_example_count +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1AnnotatedConversationDataset/createTime": create_time +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1AnnotatedConversationDataset/description": description +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1AnnotatedConversationDataset/displayName": display_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1AnnotatedConversationDataset/exampleCount": example_count +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1AnnotatedConversationDataset/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1AnnotatedConversationDataset/questionTypeName": question_type_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1AutoApproveSmartMessagingEntriesResponse": google_cloud_dialogflow_v2beta1_auto_approve_smart_messaging_entries_response +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1AutoApproveSmartMessagingEntriesResponse/disabledCount": disabled_count +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1AutoApproveSmartMessagingEntriesResponse/enabledCount": enabled_count +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1AutoApproveSmartMessagingEntriesResponse/unreviewedCount": unreviewed_count +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse": google_cloud_dialogflow_v2beta1_batch_update_entity_types_response +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse/entityTypes": entity_types +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse/entityTypes/entity_type": entity_type +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse": google_cloud_dialogflow_v2beta1_batch_update_intents_response +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse/intents": intents +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse/intents/intent": intent +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Context": google_cloud_dialogflow_v2beta1_context +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Context/lifespanCount": lifespan_count +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Context/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Context/parameters": parameters +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Context/parameters/parameter": parameter +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1EntityType": google_cloud_dialogflow_v2beta1_entity_type +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1EntityType/autoExpansionMode": auto_expansion_mode +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1EntityType/displayName": display_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1EntityType/enableFuzzyExtraction": enable_fuzzy_extraction +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1EntityType/entities": entities +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1EntityType/entities/entity": entity +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1EntityType/kind": kind +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1EntityType/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1EntityTypeEntity": google_cloud_dialogflow_v2beta1_entity_type_entity +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1EntityTypeEntity/synonyms": synonyms +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1EntityTypeEntity/synonyms/synonym": synonym +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1EntityTypeEntity/value": value +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1EventInput": google_cloud_dialogflow_v2beta1_event_input +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1EventInput/languageCode": language_code +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1EventInput/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1EventInput/parameters": parameters +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1EventInput/parameters/parameter": parameter +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1ExportAgentResponse": google_cloud_dialogflow_v2beta1_export_agent_response +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1ExportAgentResponse/agentContent": agent_content +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1ExportAgentResponse/agentUri": agent_uri +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent": google_cloud_dialogflow_v2beta1_intent +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/action": action +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/defaultResponsePlatforms": default_response_platforms +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/defaultResponsePlatforms/default_response_platform": default_response_platform +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/displayName": display_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/endInteraction": end_interaction +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/events": events +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/events/event": event +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/followupIntentInfo": followup_intent_info +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/followupIntentInfo/followup_intent_info": followup_intent_info +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/inputContextNames": input_context_names +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/inputContextNames/input_context_name": input_context_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/isFallback": is_fallback +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/messages": messages +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/messages/message": message +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/mlDisabled": ml_disabled +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/mlEnabled": ml_enabled +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/outputContexts": output_contexts +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/outputContexts/output_context": output_context +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/parameters": parameters +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/parameters/parameter": parameter +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/parentFollowupIntentName": parent_followup_intent_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/priority": priority +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/resetContexts": reset_contexts +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/rootFollowupIntentName": root_followup_intent_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/trainingPhrases": training_phrases +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/trainingPhrases/training_phrase": training_phrase +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Intent/webhookState": webhook_state +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo": google_cloud_dialogflow_v2beta1_intent_followup_intent_info +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo/followupIntentName": followup_intent_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo/parentFollowupIntentName": parent_followup_intent_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage": google_cloud_dialogflow_v2beta1_intent_message +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/basicCard": basic_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/browseCarouselCard": browse_carousel_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/card": card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/carouselSelect": carousel_select +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/image": image +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/linkOutSuggestion": link_out_suggestion +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/listSelect": list_select +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/mediaContent": media_content +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/payload/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/platform": platform +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/quickReplies": quick_replies +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/rbmCarouselRichCard": rbm_carousel_rich_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/rbmStandaloneRichCard": rbm_standalone_rich_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/rbmText": rbm_text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/simpleResponses": simple_responses +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/suggestions": suggestions +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/tableCard": table_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/telephonyPlayAudio": telephony_play_audio +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/telephonySynthesizeSpeech": telephony_synthesize_speech +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/telephonyTransferCall": telephony_transfer_call +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessage/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBasicCard": google_cloud_dialogflow_v2beta1_intent_message_basic_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBasicCard/buttons": buttons +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBasicCard/buttons/button": button +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBasicCard/formattedText": formatted_text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBasicCard/image": image +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBasicCard/subtitle": subtitle +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBasicCard/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton": google_cloud_dialogflow_v2beta1_intent_message_basic_card_button +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton/openUriAction": open_uri_action +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction": google_cloud_dialogflow_v2beta1_intent_message_basic_card_button_open_uri_action +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction/uri": uri +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard": google_cloud_dialogflow_v2beta1_intent_message_browse_carousel_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard/imageDisplayOptions": image_display_options +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard/items": items +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard/items/item": item +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem": google_cloud_dialogflow_v2beta1_intent_message_browse_carousel_card_browse_carousel_card_item +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem/description": description +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem/footer": footer +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem/image": image +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem/openUriAction": open_uri_action +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction": google_cloud_dialogflow_v2beta1_intent_message_browse_carousel_card_browse_carousel_card_item_open_url_action +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction/url": url +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction/urlTypeHint": url_type_hint +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageCard": google_cloud_dialogflow_v2beta1_intent_message_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageCard/buttons": buttons +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageCard/buttons/button": button +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageCard/imageUri": image_uri +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageCard/subtitle": subtitle +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageCard/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageCardButton": google_cloud_dialogflow_v2beta1_intent_message_card_button +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageCardButton/postback": postback +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageCardButton/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect": google_cloud_dialogflow_v2beta1_intent_message_carousel_select +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect/items": items +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect/items/item": item +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem": google_cloud_dialogflow_v2beta1_intent_message_carousel_select_item +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem/description": description +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem/image": image +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem/info": info +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageColumnProperties": google_cloud_dialogflow_v2beta1_intent_message_column_properties +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageColumnProperties/header": header +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageColumnProperties/horizontalAlignment": horizontal_alignment +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageImage": google_cloud_dialogflow_v2beta1_intent_message_image +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageImage/accessibilityText": accessibility_text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageImage/imageUri": image_uri +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion": google_cloud_dialogflow_v2beta1_intent_message_link_out_suggestion +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion/destinationName": destination_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion/uri": uri +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageListSelect": google_cloud_dialogflow_v2beta1_intent_message_list_select +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageListSelect/items": items +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageListSelect/items/item": item +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageListSelect/subtitle": subtitle +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageListSelect/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageListSelectItem": google_cloud_dialogflow_v2beta1_intent_message_list_select_item +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageListSelectItem/description": description +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageListSelectItem/image": image +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageListSelectItem/info": info +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageListSelectItem/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageMediaContent": google_cloud_dialogflow_v2beta1_intent_message_media_content +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageMediaContent/mediaObjects": media_objects +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageMediaContent/mediaObjects/media_object": media_object +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageMediaContent/mediaType": media_type +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject": google_cloud_dialogflow_v2beta1_intent_message_media_content_response_media_object +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject/contentUrl": content_url +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject/description": description +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject/icon": icon +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject/largeImage": large_image +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageQuickReplies": google_cloud_dialogflow_v2beta1_intent_message_quick_replies +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageQuickReplies/quickReplies": quick_replies +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageQuickReplies/quickReplies/quick_reply": quick_reply +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageQuickReplies/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent": google_cloud_dialogflow_v2beta1_intent_message_rbm_card_content +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent/description": description +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent/media": media +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent/suggestions": suggestions +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent/suggestions/suggestion": suggestion +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia": google_cloud_dialogflow_v2beta1_intent_message_rbm_card_content_rbm_media +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia/fileUri": file_uri +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia/height": height +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia/thumbnailUri": thumbnail_uri +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard": google_cloud_dialogflow_v2beta1_intent_message_rbm_carousel_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard/cardContents": card_contents +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard/cardContents/card_content": card_content +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard/cardWidth": card_width +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard": google_cloud_dialogflow_v2beta1_intent_message_rbm_standalone_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard/cardContent": card_content +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard/cardOrientation": card_orientation +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard/thumbnailImageAlignment": thumbnail_image_alignment +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction": google_cloud_dialogflow_v2beta1_intent_message_rbm_suggested_action +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction/dial": dial +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction/openUrl": open_url +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction/postbackData": postback_data +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction/shareLocation": share_location +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial": google_cloud_dialogflow_v2beta1_intent_message_rbm_suggested_action_rbm_suggested_action_dial +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial/phoneNumber": phone_number +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri": google_cloud_dialogflow_v2beta1_intent_message_rbm_suggested_action_rbm_suggested_action_open_uri +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri/uri": uri +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation": google_cloud_dialogflow_v2beta1_intent_message_rbm_suggested_action_rbm_suggested_action_share_location +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply": google_cloud_dialogflow_v2beta1_intent_message_rbm_suggested_reply +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply/postbackData": postback_data +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion": google_cloud_dialogflow_v2beta1_intent_message_rbm_suggestion +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion/action": action +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion/reply": reply +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmText": google_cloud_dialogflow_v2beta1_intent_message_rbm_text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmText/rbmSuggestion": rbm_suggestion +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmText/rbmSuggestion/rbm_suggestion": rbm_suggestion +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageRbmText/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo": google_cloud_dialogflow_v2beta1_intent_message_select_item_info +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo/key": key +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo/synonyms": synonyms +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo/synonyms/synonym": synonym +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse": google_cloud_dialogflow_v2beta1_intent_message_simple_response +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse/displayText": display_text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse/ssml": ssml +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse/textToSpeech": text_to_speech +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses": google_cloud_dialogflow_v2beta1_intent_message_simple_responses +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses/simpleResponses": simple_responses +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses/simpleResponses/simple_response": simple_response +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageSuggestion": google_cloud_dialogflow_v2beta1_intent_message_suggestion +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageSuggestion/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageSuggestions": google_cloud_dialogflow_v2beta1_intent_message_suggestions +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageSuggestions/suggestions": suggestions +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageSuggestions/suggestions/suggestion": suggestion +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTableCard": google_cloud_dialogflow_v2beta1_intent_message_table_card +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTableCard/buttons": buttons +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTableCard/buttons/button": button +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTableCard/columnProperties": column_properties +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTableCard/columnProperties/column_property": column_property +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTableCard/image": image +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTableCard/rows": rows +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTableCard/rows/row": row +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTableCard/subtitle": subtitle +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTableCard/title": title +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTableCardCell": google_cloud_dialogflow_v2beta1_intent_message_table_card_cell +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTableCardCell/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTableCardRow": google_cloud_dialogflow_v2beta1_intent_message_table_card_row +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTableCardRow/cells": cells +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTableCardRow/cells/cell": cell +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTableCardRow/dividerAfter": divider_after +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio": google_cloud_dialogflow_v2beta1_intent_message_telephony_play_audio +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio/audioUri": audio_uri +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech": google_cloud_dialogflow_v2beta1_intent_message_telephony_synthesize_speech +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech/ssml": ssml +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall": google_cloud_dialogflow_v2beta1_intent_message_telephony_transfer_call +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall/phoneNumber": phone_number +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageText": google_cloud_dialogflow_v2beta1_intent_message_text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageText/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentMessageText/text/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentParameter": google_cloud_dialogflow_v2beta1_intent_parameter +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentParameter/defaultValue": default_value +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentParameter/displayName": display_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentParameter/entityTypeDisplayName": entity_type_display_name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentParameter/isList": is_list +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentParameter/mandatory": mandatory +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentParameter/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentParameter/prompts": prompts +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentParameter/prompts/prompt": prompt +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentParameter/value": value +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentTrainingPhrase": google_cloud_dialogflow_v2beta1_intent_training_phrase +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentTrainingPhrase/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentTrainingPhrase/parts": parts +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentTrainingPhrase/parts/part": part +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentTrainingPhrase/timesAddedCount": times_added_count +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentTrainingPhrase/type": type +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart": google_cloud_dialogflow_v2beta1_intent_training_phrase_part +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart/alias": alias +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart/entityType": entity_type +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart/text": text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart/userDefined": user_defined +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1KnowledgeAnswers": google_cloud_dialogflow_v2beta1_knowledge_answers +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1KnowledgeAnswers/answers": answers +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1KnowledgeAnswers/answers/answer": answer +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer": google_cloud_dialogflow_v2beta1_knowledge_answers_answer +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer/answer": answer +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer/faqQuestion": faq_question +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer/matchConfidence": match_confidence +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer/matchConfidenceLevel": match_confidence_level +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer/source": source +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata": google_cloud_dialogflow_v2beta1_knowledge_operation_metadata +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata/state": state +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1LabelConversationResponse": google_cloud_dialogflow_v2beta1_label_conversation_response +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1LabelConversationResponse/annotatedConversationDataset": annotated_conversation_dataset +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest": google_cloud_dialogflow_v2beta1_original_detect_intent_request +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest/payload/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest/source": source +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest/version": version +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult": google_cloud_dialogflow_v2beta1_query_result +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/action": action +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/allRequiredParamsPresent": all_required_params_present +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/diagnosticInfo": diagnostic_info +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/diagnosticInfo/diagnostic_info": diagnostic_info +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/fulfillmentMessages": fulfillment_messages +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/fulfillmentMessages/fulfillment_message": fulfillment_message +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/fulfillmentText": fulfillment_text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/intent": intent +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/intentDetectionConfidence": intent_detection_confidence +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/knowledgeAnswers": knowledge_answers +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/languageCode": language_code +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/outputContexts": output_contexts +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/outputContexts/output_context": output_context +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/parameters": parameters +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/parameters/parameter": parameter +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/queryText": query_text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/sentimentAnalysisResult": sentiment_analysis_result +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/speechRecognitionConfidence": speech_recognition_confidence +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/webhookPayload": webhook_payload +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/webhookPayload/webhook_payload": webhook_payload +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1QueryResult/webhookSource": webhook_source +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Sentiment": google_cloud_dialogflow_v2beta1_sentiment +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Sentiment/magnitude": magnitude +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1Sentiment/score": score +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1SentimentAnalysisResult": google_cloud_dialogflow_v2beta1_sentiment_analysis_result +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1SentimentAnalysisResult/queryTextSentiment": query_text_sentiment +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1SessionEntityType": google_cloud_dialogflow_v2beta1_session_entity_type +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1SessionEntityType/entities": entities +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1SessionEntityType/entities/entity": entity +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1SessionEntityType/entityOverrideMode": entity_override_mode +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1SessionEntityType/name": name +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookRequest": google_cloud_dialogflow_v2beta1_webhook_request +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookRequest/alternativeQueryResults": alternative_query_results +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookRequest/alternativeQueryResults/alternative_query_result": alternative_query_result +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookRequest/originalDetectIntentRequest": original_detect_intent_request +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookRequest/queryResult": query_result +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookRequest/responseId": response_id +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookRequest/session": session +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookResponse": google_cloud_dialogflow_v2beta1_webhook_response +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookResponse/endInteraction": end_interaction +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookResponse/followupEventInput": followup_event_input +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookResponse/fulfillmentMessages": fulfillment_messages +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookResponse/fulfillmentMessages/fulfillment_message": fulfillment_message +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookResponse/fulfillmentText": fulfillment_text +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookResponse/outputContexts": output_contexts +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookResponse/outputContexts/output_context": output_context +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookResponse/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookResponse/payload/payload": payload +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookResponse/sessionEntityTypes": session_entity_types +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookResponse/sessionEntityTypes/session_entity_type": session_entity_type +"/dialogflow:v3beta1/GoogleCloudDialogflowV2beta1WebhookResponse/source": source +"/dialogflow:v3beta1/GoogleCloudDialogflowV3alpha1CreateVersionOperationMetadata": google_cloud_dialogflow_v3alpha1_create_version_operation_metadata +"/dialogflow:v3beta1/GoogleCloudDialogflowV3alpha1CreateVersionOperationMetadata/version": version +"/dialogflow:v3beta1/GoogleCloudDialogflowV3alpha1ExportAgentResponse": google_cloud_dialogflow_v3alpha1_export_agent_response +"/dialogflow:v3beta1/GoogleCloudDialogflowV3alpha1ExportAgentResponse/agentContent": agent_content +"/dialogflow:v3beta1/GoogleCloudDialogflowV3alpha1ExportAgentResponse/agentUri": agent_uri +"/dialogflow:v3beta1/GoogleLongrunningListOperationsResponse": google_longrunning_list_operations_response +"/dialogflow:v3beta1/GoogleLongrunningListOperationsResponse/nextPageToken": next_page_token +"/dialogflow:v3beta1/GoogleLongrunningListOperationsResponse/operations": operations +"/dialogflow:v3beta1/GoogleLongrunningListOperationsResponse/operations/operation": operation +"/dialogflow:v3beta1/GoogleLongrunningOperation": google_longrunning_operation +"/dialogflow:v3beta1/GoogleLongrunningOperation/done": done +"/dialogflow:v3beta1/GoogleLongrunningOperation/error": error +"/dialogflow:v3beta1/GoogleLongrunningOperation/metadata": metadata +"/dialogflow:v3beta1/GoogleLongrunningOperation/metadata/metadatum": metadatum +"/dialogflow:v3beta1/GoogleLongrunningOperation/name": name +"/dialogflow:v3beta1/GoogleLongrunningOperation/response": response +"/dialogflow:v3beta1/GoogleLongrunningOperation/response/response": response +"/dialogflow:v3beta1/GoogleProtobufEmpty": google_protobuf_empty +"/dialogflow:v3beta1/GoogleRpcStatus": google_rpc_status +"/dialogflow:v3beta1/GoogleRpcStatus/code": code +"/dialogflow:v3beta1/GoogleRpcStatus/details": details +"/dialogflow:v3beta1/GoogleRpcStatus/details/detail": detail +"/dialogflow:v3beta1/GoogleRpcStatus/details/detail/detail": detail +"/dialogflow:v3beta1/GoogleRpcStatus/message": message +"/dialogflow:v3beta1/dialogflow.projects.locations.operations.cancel": cancel_project_location_operation +"/dialogflow:v3beta1/dialogflow.projects.locations.operations.cancel/name": name +"/dialogflow:v3beta1/dialogflow.projects.locations.operations.get": get_project_location_operation +"/dialogflow:v3beta1/dialogflow.projects.locations.operations.get/name": name +"/dialogflow:v3beta1/dialogflow.projects.locations.operations.list": list_project_location_operations +"/dialogflow:v3beta1/dialogflow.projects.locations.operations.list/filter": filter +"/dialogflow:v3beta1/dialogflow.projects.locations.operations.list/name": name +"/dialogflow:v3beta1/dialogflow.projects.locations.operations.list/pageSize": page_size +"/dialogflow:v3beta1/dialogflow.projects.locations.operations.list/pageToken": page_token +"/dialogflow:v3beta1/dialogflow.projects.operations.cancel": cancel_project_operation +"/dialogflow:v3beta1/dialogflow.projects.operations.cancel/name": name +"/dialogflow:v3beta1/dialogflow.projects.operations.get": get_project_operation +"/dialogflow:v3beta1/dialogflow.projects.operations.get/name": name +"/dialogflow:v3beta1/dialogflow.projects.operations.list": list_project_operations +"/dialogflow:v3beta1/dialogflow.projects.operations.list/filter": filter +"/dialogflow:v3beta1/dialogflow.projects.operations.list/name": name +"/dialogflow:v3beta1/dialogflow.projects.operations.list/pageSize": page_size +"/dialogflow:v3beta1/dialogflow.projects.operations.list/pageToken": page_token +"/dialogflow:v3beta1/fields": fields +"/dialogflow:v3beta1/key": key +"/dialogflow:v3beta1/quotaUser": quota_user "/digitalassetlinks:v1/AndroidAppAsset": android_app_asset "/digitalassetlinks:v1/AndroidAppAsset/certificate": certificate "/digitalassetlinks:v1/AndroidAppAsset/packageName": package_name @@ -101617,6 +102380,8 @@ "/healthcare:v1beta1/DicomStore/labels/label": label "/healthcare:v1beta1/DicomStore/name": name "/healthcare:v1beta1/DicomStore/notificationConfig": notification_config +"/healthcare:v1beta1/DicomStore/streamConfigs": stream_configs +"/healthcare:v1beta1/DicomStore/streamConfigs/stream_config": stream_config "/healthcare:v1beta1/Empty": empty "/healthcare:v1beta1/ErrorDetail": error_detail "/healthcare:v1beta1/ErrorDetail/error": error @@ -101715,6 +102480,8 @@ "/healthcare:v1beta1/GoogleCloudHealthcareV1beta1DicomGcsDestination/uriPrefix": uri_prefix "/healthcare:v1beta1/GoogleCloudHealthcareV1beta1DicomGcsSource": google_cloud_healthcare_v1beta1_dicom_gcs_source "/healthcare:v1beta1/GoogleCloudHealthcareV1beta1DicomGcsSource/uri": uri +"/healthcare:v1beta1/GoogleCloudHealthcareV1beta1DicomStreamConfig": google_cloud_healthcare_v1beta1_dicom_stream_config +"/healthcare:v1beta1/GoogleCloudHealthcareV1beta1DicomStreamConfig/bigqueryDestination": bigquery_destination "/healthcare:v1beta1/GoogleCloudHealthcareV1beta1FhirBigQueryDestination": google_cloud_healthcare_v1beta1_fhir_big_query_destination "/healthcare:v1beta1/GoogleCloudHealthcareV1beta1FhirBigQueryDestination/datasetUri": dataset_uri "/healthcare:v1beta1/GoogleCloudHealthcareV1beta1FhirBigQueryDestination/force": force @@ -111062,6 +111829,7 @@ "/osconfig:v1beta/quotaUser": quota_user "/oslogin:v1/Empty": empty "/oslogin:v1/ImportSshPublicKeyResponse": import_ssh_public_key_response +"/oslogin:v1/ImportSshPublicKeyResponse/details": details "/oslogin:v1/ImportSshPublicKeyResponse/loginProfile": login_profile "/oslogin:v1/LoginProfile": login_profile "/oslogin:v1/LoginProfile/name": name @@ -111156,6 +111924,7 @@ "/oslogin:v1alpha/quotaUser": quota_user "/oslogin:v1beta/Empty": empty "/oslogin:v1beta/ImportSshPublicKeyResponse": import_ssh_public_key_response +"/oslogin:v1beta/ImportSshPublicKeyResponse/details": details "/oslogin:v1beta/ImportSshPublicKeyResponse/loginProfile": login_profile "/oslogin:v1beta/LoginProfile": login_profile "/oslogin:v1beta/LoginProfile/name": name @@ -120920,6 +121689,7 @@ "/sasportal:v1alpha1/SasPortalDeviceGrant/channelType": channel_type "/sasportal:v1alpha1/SasPortalDeviceGrant/expireTime": expire_time "/sasportal:v1alpha1/SasPortalDeviceGrant/frequencyRange": frequency_range +"/sasportal:v1alpha1/SasPortalDeviceGrant/grantId": grant_id "/sasportal:v1alpha1/SasPortalDeviceGrant/maxEirp": max_eirp "/sasportal:v1alpha1/SasPortalDeviceGrant/moveList": move_list "/sasportal:v1alpha1/SasPortalDeviceGrant/moveList/move_list": move_list diff --git a/generated/google/apis/androidpublisher_v3.rb b/generated/google/apis/androidpublisher_v3.rb index 8bc8a9ed3..c8daecd54 100644 --- a/generated/google/apis/androidpublisher_v3.rb +++ b/generated/google/apis/androidpublisher_v3.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/android-publisher module AndroidpublisherV3 VERSION = 'V3' - REVISION = '20200801' + REVISION = '20200817' # View and manage your Google Play Developer account AUTH_ANDROIDPUBLISHER = 'https://www.googleapis.com/auth/androidpublisher' diff --git a/generated/google/apis/androidpublisher_v3/service.rb b/generated/google/apis/androidpublisher_v3/service.rb index 2e9c73b65..609a223bd 100644 --- a/generated/google/apis/androidpublisher_v3/service.rb +++ b/generated/google/apis/androidpublisher_v3/service.rb @@ -43,8 +43,8 @@ module Google attr_accessor :quota_user def initialize - super('https://www.googleapis.com/', '') - @batch_path = 'batch/androidpublisher/v3' + super('https://androidpublisher.googleapis.com/', '') + @batch_path = 'batch' end # Commits an app edit. diff --git a/generated/google/apis/cloudbilling_v1.rb b/generated/google/apis/cloudbilling_v1.rb index b5ee6f94f..f603f2b09 100644 --- a/generated/google/apis/cloudbilling_v1.rb +++ b/generated/google/apis/cloudbilling_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/billing/ module CloudbillingV1 VERSION = 'V1' - REVISION = '20200623' + REVISION = '20200817' # 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/cloudbilling_v1/classes.rb b/generated/google/apis/cloudbilling_v1/classes.rb index c20aa6fea..6e13aa52f 100644 --- a/generated/google/apis/cloudbilling_v1/classes.rb +++ b/generated/google/apis/cloudbilling_v1/classes.rb @@ -26,9 +26,8 @@ module Google class AggregationInfo include Google::Apis::Core::Hashable - # The number of intervals to aggregate over. - # Example: If aggregation_level is "DAILY" and aggregation_count is 14, - # aggregation will be over 14 days. + # The number of intervals to aggregate over. Example: If aggregation_level is " + # DAILY" and aggregation_count is 14, aggregation will be over 14 days. # Corresponds to the JSON property `aggregationCount` # @return [Fixnum] attr_accessor :aggregation_count @@ -55,53 +54,21 @@ module Google end end - # Specifies the audit configuration for a service. - # The configuration determines which permission types are logged, and what - # identities, if any, are exempted from logging. - # An AuditConfig must have one or more AuditLogConfigs. - # If there are AuditConfigs for both `allServices` and a specific service, - # the union of the two AuditConfigs is used for that service: the log_types - # specified in each AuditConfig are enabled, and the exempted_members in each - # AuditLogConfig are exempted. - # Example Policy with multiple AuditConfigs: - # ` - # "audit_configs": [ - # ` - # "service": "allServices", - # "audit_log_configs": [ - # ` - # "log_type": "DATA_READ", - # "exempted_members": [ - # "user:jose@example.com" - # ] - # `, - # ` - # "log_type": "DATA_WRITE" - # `, - # ` - # "log_type": "ADMIN_READ" - # ` - # ] - # `, - # ` - # "service": "sampleservice.googleapis.com", - # "audit_log_configs": [ - # ` - # "log_type": "DATA_READ" - # `, - # ` - # "log_type": "DATA_WRITE", - # "exempted_members": [ - # "user:aliya@example.com" - # ] - # ` - # ] - # ` - # ] - # ` - # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ - # logging. It also exempts jose@example.com from DATA_READ logging, and - # aliya@example.com from DATA_WRITE logging. + # Specifies the audit configuration for a service. The configuration determines + # which permission types are logged, and what identities, if any, are exempted + # from logging. An AuditConfig must have one or more AuditLogConfigs. If there + # are AuditConfigs for both `allServices` and a specific service, the union of + # the two AuditConfigs is used for that service: the log_types specified in each + # AuditConfig are enabled, and the exempted_members in each AuditLogConfig are + # exempted. Example Policy with multiple AuditConfigs: ` "audit_configs": [ ` " + # service": "allServices", "audit_log_configs": [ ` "log_type": "DATA_READ", " + # exempted_members": [ "user:jose@example.com" ] `, ` "log_type": "DATA_WRITE" `, + # ` "log_type": "ADMIN_READ" ` ] `, ` "service": "sampleservice.googleapis.com", + # "audit_log_configs": [ ` "log_type": "DATA_READ" `, ` "log_type": "DATA_WRITE" + # , "exempted_members": [ "user:aliya@example.com" ] ` ] ` ] ` For sampleservice, + # this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also + # exempts jose@example.com from DATA_READ logging, and aliya@example.com from + # DATA_WRITE logging. class AuditConfig include Google::Apis::Core::Hashable @@ -110,9 +77,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 @@ -128,28 +95,15 @@ module Google end end - # Provides the configuration for logging a type of permissions. - # Example: - # ` - # "audit_log_configs": [ - # ` - # "log_type": "DATA_READ", - # "exempted_members": [ - # "user:jose@example.com" - # ] - # `, - # ` - # "log_type": "DATA_WRITE" - # ` - # ] - # ` - # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting - # jose@example.com from DATA_READ logging. + # Provides the configuration for logging a type of permissions. Example: ` " + # audit_log_configs": [ ` "log_type": "DATA_READ", "exempted_members": [ "user: + # jose@example.com" ] `, ` "log_type": "DATA_WRITE" ` ] ` This enables ' + # DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from + # DATA_READ logging. class AuditLogConfig include Google::Apis::Core::Hashable - # Specifies the identities that do not cause logging for this type of - # permission. + # Specifies the identities that do not cause logging for this type of permission. # Follows the same format of Binding.members. # Corresponds to the JSON property `exemptedMembers` # @return [Array] @@ -171,38 +125,36 @@ module Google end end - # A billing account in [GCP Console](https://console.cloud.google.com/). - # You can assign a billing account to one or more projects. + # A billing account in the [Google Cloud Console](https://console.cloud.google. + # com/). You can assign a billing account to one or more projects. class BillingAccount include Google::Apis::Core::Hashable - # The display name given to the billing account, such as `My Billing - # Account`. This name is displayed in the GCP Console. + # The display name given to the billing account, such as `My Billing Account`. + # This name is displayed in the Google Cloud Console. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # If this account is a - # [subaccount](https://cloud.google.com/billing/docs/concepts), then this - # will be the resource name of the master billing account that it is being - # resold through. - # Otherwise this will be empty. + # If this account is a [subaccount](https://cloud.google.com/billing/docs/ + # concepts), then this will be the resource name of the master billing account + # that it is being resold through. Otherwise this will be empty. # Corresponds to the JSON property `masterBillingAccount` # @return [String] attr_accessor :master_billing_account - # The resource name of the billing account. The resource name has the form - # `billingAccounts/`billing_account_id``. For example, - # `billingAccounts/012345-567890-ABCDEF` would be the resource name for - # billing account `012345-567890-ABCDEF`. + # The resource name of the billing account. The resource name has the form ` + # billingAccounts/`billing_account_id``. For example, `billingAccounts/012345- + # 567890-ABCDEF` would be the resource name for billing account `012345-567890- + # ABCDEF`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # Output only. True if the billing account is open, and will therefore be - # charged for any - # usage on associated projects. False if the billing account is closed, and - # therefore projects associated with it will be unable to use paid services. + # charged for any usage on associated projects. False if the billing account is + # closed, and therefore projects associated with it will be unable to use paid + # services. # Corresponds to the JSON property `open` # @return [Boolean] attr_accessor :open @@ -225,69 +177,57 @@ module Google class Binding include Google::Apis::Core::Hashable - # Represents a textual expression in the Common Expression Language (CEL) - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # Example (Comparison): - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # Example (Equality): - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # Example (Logic): - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # Example (Data Manipulation): - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. # Corresponds to the JSON property `condition` # @return [Google::Apis::CloudbillingV1::Expr] attr_accessor :condition - # Specifies the identities requesting access for a Cloud Platform resource. - # `members` can have the following values: - # * `allUsers`: A special identifier that represents anyone who is - # on the internet; with or without a Google account. - # * `allAuthenticatedUsers`: A special identifier that represents anyone - # who is authenticated with a Google account or a service account. - # * `user:`emailid``: An email address that represents a specific Google - # account. For example, `alice@example.com` . - # * `serviceAccount:`emailid``: An email address that represents a service - # account. For example, `my-other-app@appspot.gserviceaccount.com`. - # * `group:`emailid``: An email address that represents a Google group. - # For example, `admins@example.com`. - # * `deleted:user:`emailid`?uid=`uniqueid``: An email address (plus unique - # identifier) representing a user that has been recently deleted. For - # example, `alice@example.com?uid=123456789012345678901`. If the user is - # recovered, this value reverts to `user:`emailid`` and the recovered user - # retains the role in the binding. - # * `deleted:serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus - # unique identifier) representing a service account that has been recently - # deleted. For example, - # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. - # If the service account is undeleted, this value reverts to - # `serviceAccount:`emailid`` and the undeleted service account retains the - # role in the binding. - # * `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique - # identifier) representing a Google group that has been recently - # deleted. For example, `admins@example.com?uid=123456789012345678901`. If - # the group is recovered, this value reverts to `group:`emailid`` and the - # recovered group retains the role in the binding. - # * `domain:`domain``: The G Suite domain (primary) that represents all the - # users of that domain. For example, `google.com` or `example.com`. + # Specifies the identities requesting access for a Cloud Platform resource. ` + # members` can have the following values: * `allUsers`: A special identifier + # that represents anyone who is on the internet; with or without a Google + # account. * `allAuthenticatedUsers`: A special identifier that represents + # anyone who is authenticated with a Google account or a service account. * ` + # user:`emailid``: An email address that represents a specific Google account. + # For example, `alice@example.com` . * `serviceAccount:`emailid``: An email + # address that represents a service account. For example, `my-other-app@appspot. + # gserviceaccount.com`. * `group:`emailid``: An email address that represents a + # Google group. For example, `admins@example.com`. * `deleted:user:`emailid`?uid= + # `uniqueid``: An email address (plus unique identifier) representing a user + # that has been recently deleted. For example, `alice@example.com?uid= + # 123456789012345678901`. If the user is recovered, this value reverts to `user:` + # emailid`` and the recovered user retains the role in the binding. * `deleted: + # serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a service account that has been recently deleted. For + # example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. + # If the service account is undeleted, this value reverts to `serviceAccount:` + # emailid`` and the undeleted service account retains the role in the binding. * + # `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique + # identifier) representing a Google group that has been recently deleted. For + # example, `admins@example.com?uid=123456789012345678901`. If the group is + # recovered, this value reverts to `group:`emailid`` and the recovered group + # retains the role in the binding. * `domain:`domain``: The G Suite domain ( + # primary) that represents all the users of that domain. For example, `google. + # com` or `example.com`. # Corresponds to the JSON property `members` # @return [Array] attr_accessor :members - # Role that is assigned to `members`. - # For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor` + # , or `roles/owner`. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -308,14 +248,14 @@ module Google class Category include Google::Apis::Core::Hashable - # The type of product the SKU refers to. - # Example: "Compute", "Storage", "Network", "ApplicationServices" etc. + # The type of product the SKU refers to. Example: "Compute", "Storage", "Network" + # , "ApplicationServices" etc. # Corresponds to the JSON property `resourceFamily` # @return [String] attr_accessor :resource_family - # A group classification for related SKUs. - # Example: "RAM", "GPU", "Prediction", "Ops", "GoogleEgress" etc. + # A group classification for related SKUs. Example: "RAM", "GPU", "Prediction", " + # Ops", "GoogleEgress" etc. # Corresponds to the JSON property `resourceGroup` # @return [String] attr_accessor :resource_group @@ -325,8 +265,8 @@ module Google # @return [String] attr_accessor :service_display_name - # Represents how the SKU is consumed. - # Example: "OnDemand", "Preemptible", "Commit1Mo", "Commit1Yr" etc. + # Represents how the SKU is consumed. Example: "OnDemand", "Preemptible", " + # Commit1Mo", "Commit1Yr" etc. # Corresponds to the JSON property `usageType` # @return [String] attr_accessor :usage_type @@ -344,52 +284,43 @@ module Google end end - # Represents a textual expression in the Common Expression Language (CEL) - # syntax. CEL is a C-like expression language. The syntax and semantics of CEL - # are documented at https://github.com/google/cel-spec. - # Example (Comparison): - # title: "Summary size limit" - # description: "Determines if a summary is less than 100 chars" - # expression: "document.summary.size() < 100" - # Example (Equality): - # title: "Requestor is owner" - # description: "Determines if requestor is the document owner" - # expression: "document.owner == request.auth.claims.email" - # Example (Logic): - # title: "Public documents" - # description: "Determine whether the document should be publicly visible" - # expression: "document.type != 'private' && document.type != 'internal'" - # Example (Data Manipulation): - # title: "Notification string" - # description: "Create a notification string with a timestamp." - # expression: "'New message received at ' + string(document.create_time)" - # The exact variables and functions that may be referenced within an expression - # are determined by the service that evaluates it. See the service - # documentation for additional information. + # Represents a textual expression in the Common Expression Language (CEL) syntax. + # CEL is a C-like expression language. The syntax and semantics of CEL are + # documented at https://github.com/google/cel-spec. Example (Comparison): title: + # "Summary size limit" description: "Determines if a summary is less than 100 + # chars" expression: "document.summary.size() < 100" Example (Equality): title: " + # Requestor is owner" description: "Determines if requestor is the document + # owner" expression: "document.owner == request.auth.claims.email" Example ( + # Logic): title: "Public documents" description: "Determine whether the document + # should be publicly visible" expression: "document.type != 'private' && + # document.type != 'internal'" Example (Data Manipulation): title: "Notification + # string" description: "Create a notification string with a timestamp." + # expression: "'New message received at ' + string(document.create_time)" The + # exact variables and functions that may be referenced within an expression are + # determined by the service that evaluates it. See the service documentation for + # additional information. class Expr include Google::Apis::Core::Hashable - # Optional. Description of the expression. This is a longer text which - # describes the expression, e.g. when hovered over it in a UI. + # Optional. Description of the expression. This is a longer text which describes + # the expression, e.g. when hovered over it in a UI. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # Textual representation of an expression in Common Expression Language - # syntax. + # Textual representation of an expression in Common Expression Language syntax. # Corresponds to the JSON property `expression` # @return [String] attr_accessor :expression - # Optional. String indicating the location of the expression for error - # reporting, e.g. a file name and a position in the file. + # Optional. String indicating the location of the expression for error reporting, + # e.g. a file name and a position in the file. # Corresponds to the JSON property `location` # @return [String] attr_accessor :location - # Optional. Title for the expression, i.e. a short string describing - # its purpose. This can be used e.g. in UIs which allow to enter the - # expression. + # Optional. Title for the expression, i.e. a short string describing its purpose. + # This can be used e.g. in UIs which allow to enter the expression. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -412,7 +343,7 @@ module Google include Google::Apis::Core::Hashable # The list of regions associated with a sku. Empty for Global skus, which are - # associated with all GCP regions. + # associated with all Google Cloud regions. # Corresponds to the JSON property `regions` # @return [Array] attr_accessor :regions @@ -442,9 +373,9 @@ module Google # @return [Array] attr_accessor :billing_accounts - # A token to retrieve the next page of results. To retrieve the next page, - # call `ListBillingAccounts` again with the `page_token` field set to this - # value. This field is empty if there are no more results to retrieve. + # A token to retrieve the next page of results. To retrieve the next page, call ` + # ListBillingAccounts` again with the `page_token` field set to this value. This + # field is empty if there are no more results to retrieve. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -464,15 +395,15 @@ module Google class ListProjectBillingInfoResponse include Google::Apis::Core::Hashable - # A token to retrieve the next page of results. To retrieve the next page, - # call `ListProjectBillingInfo` again with the `page_token` field set to this - # value. This field is empty if there are no more results to retrieve. + # A token to retrieve the next page of results. To retrieve the next page, call ` + # ListProjectBillingInfo` again with the `page_token` field set to this value. + # This field is empty if there are no more results to retrieve. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # A list of `ProjectBillingInfo` resources representing the projects - # associated with the billing account. + # A list of `ProjectBillingInfo` resources representing the projects associated + # with the billing account. # Corresponds to the JSON property `projectBillingInfo` # @return [Array] attr_accessor :project_billing_info @@ -492,9 +423,9 @@ module Google class ListServicesResponse include Google::Apis::Core::Hashable - # A token to retrieve the next page of results. To retrieve the next page, - # call `ListServices` again with the `page_token` field set to this - # value. This field is empty if there are no more results to retrieve. + # A token to retrieve the next page of results. To retrieve the next page, call ` + # ListServices` again with the `page_token` field set to this value. This field + # is empty if there are no more results to retrieve. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -519,9 +450,9 @@ module Google class ListSkusResponse include Google::Apis::Core::Hashable - # A token to retrieve the next page of results. To retrieve the next page, - # call `ListSkus` again with the `page_token` field set to this - # value. This field is empty if there are no more results to retrieve. + # A token to retrieve the next page of results. To retrieve the next page, call ` + # ListSkus` again with the `page_token` field set to this value. This field is + # empty if there are no more results to retrieve. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token @@ -551,18 +482,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 @@ -580,66 +510,32 @@ module Google end # An Identity and Access Management (IAM) policy, which specifies access - # controls for Google Cloud resources. - # A `Policy` is a collection of `bindings`. A `binding` binds one or more - # `members` to a single `role`. Members can be user accounts, service accounts, - # Google groups, and domains (such as G Suite). A `role` is a named list of - # permissions; each `role` can be an IAM predefined role or a user-created - # custom role. - # For some types of Google Cloud resources, a `binding` can also specify a - # `condition`, which is a logical expression that allows access to a resource - # only if the expression evaluates to `true`. A condition can add constraints - # based on attributes of the request, the resource, or both. To learn which - # resources support conditions in their IAM policies, see the - # [IAM documentation](https://cloud.google.com/iam/help/conditions/resource- - # policies). - # **JSON example:** - # ` - # "bindings": [ - # ` - # "role": "roles/resourcemanager.organizationAdmin", - # "members": [ - # "user:mike@example.com", - # "group:admins@example.com", - # "domain:google.com", - # "serviceAccount:my-project-id@appspot.gserviceaccount.com" - # ] - # `, - # ` - # "role": "roles/resourcemanager.organizationViewer", - # "members": [ - # "user:eve@example.com" - # ], - # "condition": ` - # "title": "expirable access", - # "description": "Does not grant access after Sep 2020", - # "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z') - # ", - # ` - # ` - # ], - # "etag": "BwWWja0YfJA=", - # "version": 3 - # ` - # **YAML example:** - # bindings: - # - members: - # - user:mike@example.com - # - group:admins@example.com - # - domain:google.com - # - serviceAccount:my-project-id@appspot.gserviceaccount.com - # role: roles/resourcemanager.organizationAdmin - # - members: - # - user:eve@example.com - # role: roles/resourcemanager.organizationViewer - # condition: - # title: expirable access - # description: Does not grant access after Sep 2020 - # expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - # - etag: BwWWja0YfJA= - # - version: 3 - # For a description of IAM and its features, see the - # [IAM documentation](https://cloud.google.com/iam/docs/). + # controls for Google Cloud resources. A `Policy` is a collection of `bindings`. + # A `binding` binds one or more `members` to a single `role`. Members can be + # user accounts, service accounts, Google groups, and domains (such as G Suite). + # A `role` is a named list of permissions; each `role` can be an IAM predefined + # role or a user-created custom role. For some types of Google Cloud resources, + # a `binding` can also specify a `condition`, which is a logical expression that + # allows access to a resource only if the expression evaluates to `true`. A + # condition can add constraints based on attributes of the request, the resource, + # or both. To learn which resources support conditions in their IAM policies, + # see the [IAM documentation](https://cloud.google.com/iam/help/conditions/ + # resource-policies). **JSON example:** ` "bindings": [ ` "role": "roles/ + # resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", " + # group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@ + # appspot.gserviceaccount.com" ] `, ` "role": "roles/resourcemanager. + # organizationViewer", "members": [ "user:eve@example.com" ], "condition": ` " + # title": "expirable access", "description": "Does not grant access after Sep + # 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", ` + # ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:** bindings: - + # members: - user:mike@example.com - group:admins@example.com - domain:google. + # com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/ + # resourcemanager.organizationAdmin - members: - user:eve@example.com role: + # roles/resourcemanager.organizationViewer condition: title: expirable access + # description: Does not grant access after Sep 2020 expression: request.time < + # timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a + # description of IAM and its features, see the [IAM documentation](https://cloud. + # google.com/iam/docs/). class Policy include Google::Apis::Core::Hashable @@ -648,48 +544,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 @@ -707,19 +599,16 @@ module Google end end - # Expresses a mathematical pricing formula. For Example:- - # `usage_unit: GBy` - # `tiered_rates:` - # `[start_usage_amount: 20, unit_price: $10]` - # `[start_usage_amount: 100, unit_price: $5]` - # The above expresses a pricing formula where the first 20GB is free, the - # next 80GB is priced at $10 per GB followed by $5 per GB for additional - # usage. + # Expresses a mathematical pricing formula. For Example:- `usage_unit: GBy` ` + # tiered_rates:` `[start_usage_amount: 20, unit_price: $10]` `[ + # start_usage_amount: 100, unit_price: $5]` The above expresses a pricing + # formula where the first 20GB is free, the next 80GB is priced at $10 per GB + # followed by $5 per GB for additional usage. class PricingExpression include Google::Apis::Core::Hashable - # The base unit for the SKU which is the unit used in usage exports. - # Example: "By" + # The base unit for the SKU which is the unit used in usage exports. Example: " + # By" # Corresponds to the JSON property `baseUnit` # @return [String] attr_accessor :base_unit @@ -733,39 +622,35 @@ module Google # @return [Float] attr_accessor :base_unit_conversion_factor - # The base unit in human readable form. - # Example: "byte". + # The base unit in human readable form. Example: "byte". # Corresponds to the JSON property `baseUnitDescription` # @return [String] attr_accessor :base_unit_description - # The recommended quantity of units for displaying pricing info. When - # displaying pricing info it is recommended to display: - # (unit_price * display_quantity) per display_quantity usage_unit. - # This field does not affect the pricing formula and is for display purposes - # only. - # Example: If the unit_price is "0.0001 USD", the usage_unit is "GB" and - # the display_quantity is "1000" then the recommended way of displaying the - # pricing info is "0.10 USD per 1000 GB" + # The recommended quantity of units for displaying pricing info. When displaying + # pricing info it is recommended to display: (unit_price * display_quantity) per + # display_quantity usage_unit. This field does not affect the pricing formula + # and is for display purposes only. Example: If the unit_price is "0.0001 USD", + # the usage_unit is "GB" and the display_quantity is "1000" then the recommended + # way of displaying the pricing info is "0.10 USD per 1000 GB" # Corresponds to the JSON property `displayQuantity` # @return [Float] attr_accessor :display_quantity # The list of tiered rates for this pricing. The total cost is computed by - # applying each of the tiered rates on usage. This repeated list is sorted - # by ascending order of start_usage_amount. + # applying each of the tiered rates on usage. This repeated list is sorted by + # ascending order of start_usage_amount. # Corresponds to the JSON property `tieredRates` # @return [Array] attr_accessor :tiered_rates - # The short hand for unit of usage this pricing is specified in. - # Example: usage_unit of "GiBy" means that usage is specified in "Gibi Byte". + # The short hand for unit of usage this pricing is specified in. Example: + # usage_unit of "GiBy" means that usage is specified in "Gibi Byte". # Corresponds to the JSON property `usageUnit` # @return [String] attr_accessor :usage_unit - # The unit of usage in human readable form. - # Example: "gibi byte". + # The unit of usage in human readable form. Example: "gibi byte". # Corresponds to the JSON property `usageUnitDescription` # @return [String] attr_accessor :usage_unit_description @@ -796,38 +681,33 @@ module Google attr_accessor :aggregation_info # Conversion rate used for currency conversion, from USD to the currency - # specified in the request. This includes any surcharge collected for billing - # in non USD currency. If a currency is not specified in the request this - # defaults to 1.0. - # Example: USD * currency_conversion_rate = JPY + # specified in the request. This includes any surcharge collected for billing in + # non USD currency. If a currency is not specified in the request this defaults + # to 1.0. Example: USD * currency_conversion_rate = JPY # Corresponds to the JSON property `currencyConversionRate` # @return [Float] attr_accessor :currency_conversion_rate - # The timestamp from which this pricing was effective within the requested - # time range. This is guaranteed to be greater than or equal to the - # start_time field in the request and less than the end_time field in the - # request. If a time range was not specified in the request this field will - # be equivalent to a time within the last 12 hours, indicating the latest - # pricing info. + # The timestamp from which this pricing was effective within the requested time + # range. This is guaranteed to be greater than or equal to the start_time field + # in the request and less than the end_time field in the request. If a time + # range was not specified in the request this field will be equivalent to a time + # within the last 12 hours, indicating the latest pricing info. # Corresponds to the JSON property `effectiveTime` # @return [String] attr_accessor :effective_time - # Expresses a mathematical pricing formula. For Example:- - # `usage_unit: GBy` - # `tiered_rates:` - # `[start_usage_amount: 20, unit_price: $10]` - # `[start_usage_amount: 100, unit_price: $5]` - # The above expresses a pricing formula where the first 20GB is free, the - # next 80GB is priced at $10 per GB followed by $5 per GB for additional - # usage. + # Expresses a mathematical pricing formula. For Example:- `usage_unit: GBy` ` + # tiered_rates:` `[start_usage_amount: 20, unit_price: $10]` `[ + # start_usage_amount: 100, unit_price: $5]` The above expresses a pricing + # formula where the first 20GB is free, the next 80GB is priced at $10 per GB + # followed by $5 per GB for additional usage. # Corresponds to the JSON property `pricingExpression` # @return [Google::Apis::CloudbillingV1::PricingExpression] attr_accessor :pricing_expression - # An optional human readable summary of the pricing information, has a - # maximum length of 256 characters. + # An optional human readable summary of the pricing information, has a maximum + # length of 256 characters. # Corresponds to the JSON property `summary` # @return [String] attr_accessor :summary @@ -846,38 +726,38 @@ module Google end end - # Encapsulation of billing information for a GCP Console project. A project - # has at most one associated billing account at a time (but a billing account - # can be assigned to multiple projects). + # Encapsulation of billing information for a Google Cloud Console project. A + # project has at most one associated billing account at a time (but a billing + # account can be assigned to multiple projects). class ProjectBillingInfo include Google::Apis::Core::Hashable - # The resource name of the billing account associated with the project, if - # any. For example, `billingAccounts/012345-567890-ABCDEF`. + # The resource name of the billing account associated with the project, if any. + # For example, `billingAccounts/012345-567890-ABCDEF`. # Corresponds to the JSON property `billingAccountName` # @return [String] attr_accessor :billing_account_name - # True if the project is associated with an open billing account, to which - # usage on the project is charged. False if the project is associated with a - # closed billing account, or no billing account at all, and therefore cannot - # use paid services. This field is read-only. + # True if the project is associated with an open billing account, to which usage + # on the project is charged. False if the project is associated with a closed + # billing account, or no billing account at all, and therefore cannot use paid + # services. This field is read-only. # Corresponds to the JSON property `billingEnabled` # @return [Boolean] attr_accessor :billing_enabled alias_method :billing_enabled?, :billing_enabled - # The resource name for the `ProjectBillingInfo`; has the form - # `projects/`project_id`/billingInfo`. For example, the resource name for the - # billing information for project `tokyo-rain-123` would be - # `projects/tokyo-rain-123/billingInfo`. This field is read-only. + # The resource name for the `ProjectBillingInfo`; has the form `projects/` + # project_id`/billingInfo`. For example, the resource name for the billing + # information for project `tokyo-rain-123` would be `projects/tokyo-rain-123/ + # billingInfo`. This field is read-only. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The ID of the project that this `ProjectBillingInfo` represents, such as - # `tokyo-rain-123`. This is a convenience field so that you don't need to - # parse the `name` field to obtain a project ID. This field is read-only. + # The ID of the project that this `ProjectBillingInfo` represents, such as ` + # tokyo-rain-123`. This is a convenience field so that you don't need to parse + # the `name` field to obtain a project ID. This field is read-only. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id @@ -899,8 +779,8 @@ module Google class Service include Google::Apis::Core::Hashable - # The business under which the service is offered. - # Ex. "businessEntities/GCP", "businessEntities/Maps" + # The business under which the service is offered. Ex. "businessEntities/GCP", " + # businessEntities/Maps" # Corresponds to the JSON property `businessEntityName` # @return [String] attr_accessor :business_entity_name @@ -910,14 +790,12 @@ module Google # @return [String] attr_accessor :display_name - # The resource name for the service. - # Example: "services/DA34-426B-A397" + # The resource name for the service. Example: "services/DA34-426B-A397" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The identifier for the service. - # Example: "DA34-426B-A397" + # The identifier for the service. Example: "DA34-426B-A397" # Corresponds to the JSON property `serviceId` # @return [String] attr_accessor :service_id @@ -940,74 +818,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::CloudbillingV1::Policy] attr_accessor :policy # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only - # the fields in the mask will be modified. If no mask is provided, the - # following default mask is used: - # `paths: "bindings, etag"` + # the fields in the mask will be modified. If no mask is provided, the following + # default mask is used: `paths: "bindings, etag"` # Corresponds to the JSON property `updateMask` # @return [String] attr_accessor :update_mask @@ -1043,8 +886,8 @@ module Google # @return [Google::Apis::CloudbillingV1::GeoTaxonomy] attr_accessor :geo_taxonomy - # The resource name for the SKU. - # Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE" + # The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95- + # CD31-42FE" # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1054,21 +897,19 @@ module Google # @return [Array] attr_accessor :pricing_info - # Identifies the service provider. - # This is 'Google' for first party services in Google Cloud Platform. + # Identifies the service provider. This is 'Google' for first party services in + # Google Cloud Platform. # Corresponds to the JSON property `serviceProviderName` # @return [String] attr_accessor :service_provider_name - # List of service regions this SKU is offered at. - # Example: "asia-east1" - # Service regions can be found at https://cloud.google.com/about/locations/ + # List of service regions this SKU is offered at. Example: "asia-east1" Service + # regions can be found at https://cloud.google.com/about/locations/ # Corresponds to the JSON property `serviceRegions` # @return [Array] attr_accessor :service_regions - # The identifier for the SKU. - # Example: "AA95-CD31-42FE" + # The identifier for the SKU. Example: "AA95-CD31-42FE" # Corresponds to the JSON property `skuId` # @return [String] attr_accessor :sku_id @@ -1094,10 +935,9 @@ module Google class TestIamPermissionsRequest include Google::Apis::Core::Hashable - # The set of permissions to check for the `resource`. Permissions with - # wildcards (such as '*' or 'storage.*') are not allowed. For more - # information see - # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). + # The set of permissions to check for the `resource`. Permissions with wildcards + # (such as '*' or 'storage.*') are not allowed. For more information see [IAM + # Overview](https://cloud.google.com/iam/docs/overview#permissions). # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions @@ -1116,8 +956,7 @@ module Google class TestIamPermissionsResponse include Google::Apis::Core::Hashable - # A subset of `TestPermissionsRequest.permissions` that the caller is - # allowed. + # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. # Corresponds to the JSON property `permissions` # @return [Array] attr_accessor :permissions @@ -1136,9 +975,9 @@ module Google class TierRate include Google::Apis::Core::Hashable - # Usage is priced at this rate only after this amount. - # Example: start_usage_amount of 10 indicates that the usage will be priced - # at the unit_price after the first 10 usage_units. + # Usage is priced at this rate only after this amount. Example: + # start_usage_amount of 10 indicates that the usage will be priced at the + # unit_price after the first 10 usage_units. # Corresponds to the JSON property `startUsageAmount` # @return [Float] attr_accessor :start_usage_amount diff --git a/generated/google/apis/cloudbilling_v1/service.rb b/generated/google/apis/cloudbilling_v1/service.rb index 51a36e081..457ea58f5 100644 --- a/generated/google/apis/cloudbilling_v1/service.rb +++ b/generated/google/apis/cloudbilling_v1/service.rb @@ -48,16 +48,13 @@ module Google @batch_path = 'batch' end - # Creates a billing account. - # This method can only be used to create - # [billing subaccounts](https://cloud.google.com/billing/docs/concepts) - # by GCP resellers. - # When creating a subaccount, the current authenticated user must have the - # `billing.accounts.update` IAM permission on the master account, which is - # typically given to billing account - # [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). - # This method will return an error if the master account has not been - # provisioned as a reseller account. + # Creates a billing account. This method can only be used to create [billing + # subaccounts](https://cloud.google.com/billing/docs/concepts) by Google Cloud + # resellers. When creating a subaccount, the current authenticated user must + # have the `billing.accounts.update` IAM permission on the master account, which + # is typically given to billing account [administrators](https://cloud.google. + # com/billing/docs/how-to/billing-access). This method will return an error if + # the master account has not been provisioned as a reseller account. # @param [Google::Apis::CloudbillingV1::BillingAccount] billing_account_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -87,12 +84,12 @@ module Google execute_or_queue_command(command, &block) end - # Gets information about a billing account. The current authenticated user - # must be a [viewer of the billing - # account](https://cloud.google.com/billing/docs/how-to/billing-access). + # Gets information about a billing account. The current authenticated user must + # be a [viewer of the billing account](https://cloud.google.com/billing/docs/how- + # to/billing-access). # @param [String] name - # Required. The resource name of the billing account to retrieve. For example, - # `billingAccounts/012345-567890-ABCDEF`. + # Required. The resource name of the billing account to retrieve. For example, ` + # billingAccounts/012345-567890-ABCDEF`. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -120,23 +117,21 @@ module Google execute_or_queue_command(command, &block) end - # Gets the access control policy for a billing account. - # The caller must have the `billing.accounts.getIamPolicy` permission on the - # account, which is often given to billing account - # [viewers](https://cloud.google.com/billing/docs/how-to/billing-access). + # Gets the access control policy for a billing account. The caller must have the + # `billing.accounts.getIamPolicy` permission on the account, which is often + # given to billing account [viewers](https://cloud.google.com/billing/docs/how- + # to/billing-access). # @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 @@ -165,23 +160,20 @@ module Google execute_or_queue_command(command, &block) end - # Lists the billing accounts that the current authenticated user has - # permission to - # [view](https://cloud.google.com/billing/docs/how-to/billing-access). + # Lists the billing accounts that the current authenticated user has permission + # to [view](https://cloud.google.com/billing/docs/how-to/billing-access). # @param [String] filter - # Options for how to filter the returned billing accounts. - # Currently this only supports filtering for - # [subaccounts](https://cloud.google.com/billing/docs/concepts) under a - # single provided reseller billing account. - # (e.g. "master_billing_account=billingAccounts/012345-678901-ABCDEF"). - # Boolean algebra and other fields are not currently supported. + # Options for how to filter the returned billing accounts. Currently this only + # supports filtering for [subaccounts](https://cloud.google.com/billing/docs/ + # concepts) under a single provided reseller billing account. (e.g. " + # master_billing_account=billingAccounts/012345-678901-ABCDEF"). Boolean algebra + # and other fields are not currently supported. # @param [Fixnum] page_size - # Requested page size. The maximum page size is 100; this is also the - # default. + # Requested page size. The maximum page size is 100; this is also the default. # @param [String] page_token - # A token identifying a page of results to return. This should be a - # `next_page_token` value returned from a previous `ListBillingAccounts` - # call. If unspecified, the first page of results is returned. + # A token identifying a page of results to return. This should be a ` + # next_page_token` value returned from a previous `ListBillingAccounts` call. If + # unspecified, the first page of results is returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -211,18 +203,17 @@ module Google execute_or_queue_command(command, &block) end - # Updates a billing account's fields. - # Currently the only field that can be edited is `display_name`. - # The current authenticated user must have the `billing.accounts.update` - # IAM permission, which is typically given to the - # [administrator](https://cloud.google.com/billing/docs/how-to/billing-access) - # of the billing account. + # Updates a billing account's fields. Currently the only field that can be + # edited is `display_name`. The current authenticated user must have the ` + # billing.accounts.update` IAM permission, which is typically given to the [ + # administrator](https://cloud.google.com/billing/docs/how-to/billing-access) of + # the billing account. # @param [String] name # Required. The name of the billing account resource to be updated. # @param [Google::Apis::CloudbillingV1::BillingAccount] billing_account_object # @param [String] update_mask - # The update mask applied to the resource. - # Only "display_name" is currently supported. + # The update mask applied to the resource. Only "display_name" is currently + # supported. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -254,13 +245,12 @@ module Google end # Sets the access control policy for a billing account. Replaces any existing - # policy. - # The caller must have the `billing.accounts.setIamPolicy` permission on the - # account, which is often given to billing account - # [administrators](https://cloud.google.com/billing/docs/how-to/billing-access). + # policy. The caller must have the `billing.accounts.setIamPolicy` permission on + # the account, which is often given to billing account [administrators](https:// + # cloud.google.com/billing/docs/how-to/billing-access). # @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::CloudbillingV1::SetIamPolicyRequest] set_iam_policy_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -291,12 +281,12 @@ module Google execute_or_queue_command(command, &block) end - # Tests the access control policy for a billing account. This method takes - # the resource and a set of permissions as input and returns the subset of - # the input permissions that the caller is allowed for that resource. + # Tests the access control policy for a billing account. This method takes the + # resource and a set of permissions as input and returns the subset of the input + # permissions that the caller is allowed for that resource. # @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::CloudbillingV1::TestIamPermissionsRequest] test_iam_permissions_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -329,19 +319,18 @@ module Google # Lists the projects associated with a billing account. The current # authenticated user must have the `billing.resourceAssociations.list` IAM - # permission, which is often given to billing account - # [viewers](https://cloud.google.com/billing/docs/how-to/billing-access). + # permission, which is often given to billing account [viewers](https://cloud. + # google.com/billing/docs/how-to/billing-access). # @param [String] name # Required. The resource name of the billing account associated with the - # projects that - # you want to list. For example, `billingAccounts/012345-567890-ABCDEF`. + # projects that you want to list. For example, `billingAccounts/012345-567890- + # ABCDEF`. # @param [Fixnum] page_size - # Requested page size. The maximum page size is 100; this is also the - # default. + # Requested page size. The maximum page size is 100; this is also the default. # @param [String] page_token - # A token identifying a page of results to be returned. This should be a - # `next_page_token` value returned from a previous `ListProjectBillingInfo` - # call. If unspecified, the first page of results is returned. + # A token identifying a page of results to be returned. This should be a ` + # next_page_token` value returned from a previous `ListProjectBillingInfo` call. + # If unspecified, the first page of results is returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -372,9 +361,8 @@ module Google end # Gets the billing information for a project. The current authenticated user - # must have [permission to view the - # project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo - # ). + # must have [permission to view the project](https://cloud.google.com/docs/ + # permissions-overview#h.bgs0oxofvnoo ). # @param [String] name # Required. The resource name of the project for which billing information is # retrieved. For example, `projects/tokyo-rain-123`. @@ -405,37 +393,32 @@ module Google execute_or_queue_command(command, &block) end - # Sets or updates the billing account associated with a project. You specify - # the new billing account by setting the `billing_account_name` in the - # `ProjectBillingInfo` resource to the resource name of a billing account. + # Sets or updates the billing account associated with a project. You specify the + # new billing account by setting the `billing_account_name` in the ` + # ProjectBillingInfo` resource to the resource name of a billing account. # Associating a project with an open billing account enables billing on the # project and allows charges for resource usage. If the project already had a # billing account, this method changes the billing account used for resource - # usage charges. - # *Note:* Incurred charges that have not yet been reported in the transaction - # history of the GCP Console might be billed to the new billing - # account, even if the charge occurred before the new billing account was - # assigned to the project. - # The current authenticated user must have ownership privileges for both the - # [project](https://cloud.google.com/docs/permissions-overview#h.bgs0oxofvnoo - # ) and the [billing - # account](https://cloud.google.com/billing/docs/how-to/billing-access). - # You can disable billing on the project by setting the - # `billing_account_name` field to empty. This action disassociates the - # current billing account from the project. Any billable activity of your - # in-use services will stop, and your application could stop functioning as - # expected. Any unbilled charges to date will be billed to the previously - # associated account. The current authenticated user must be either an owner - # of the project or an owner of the billing account for the project. - # Note that associating a project with a *closed* billing account will have - # much the same effect as disabling billing on the project: any paid - # resources used by the project will be shut down. Thus, unless you wish to - # disable billing, you should always call this method with the name of an - # *open* billing account. + # usage charges. *Note:* Incurred charges that have not yet been reported in the + # transaction history of the Google Cloud Console might be billed to the new + # billing account, even if the charge occurred before the new billing account + # was assigned to the project. The current authenticated user must have + # ownership privileges for both the [project](https://cloud.google.com/docs/ + # permissions-overview#h.bgs0oxofvnoo ) and the [billing account](https://cloud. + # google.com/billing/docs/how-to/billing-access). You can disable billing on the + # project by setting the `billing_account_name` field to empty. This action + # disassociates the current billing account from the project. Any billable + # activity of your in-use services will stop, and your application could stop + # functioning as expected. Any unbilled charges to date will be billed to the + # previously associated account. The current authenticated user must be either + # an owner of the project or an owner of the billing account for the project. + # Note that associating a project with a *closed* billing account will have much + # the same effect as disabling billing on the project: any paid resources used + # by the project will be shut down. Thus, unless you wish to disable billing, + # you should always call this method with the name of an *open* billing account. # @param [String] name # Required. The resource name of the project associated with the billing - # information - # that you want to update. For example, `projects/tokyo-rain-123`. + # information that you want to update. For example, `projects/tokyo-rain-123`. # @param [Google::Apis::CloudbillingV1::ProjectBillingInfo] project_billing_info_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -470,9 +453,9 @@ module Google # @param [Fixnum] page_size # Requested page size. Defaults to 5000. # @param [String] page_token - # A token identifying a page of results to return. This should be a - # `next_page_token` value returned from a previous `ListServices` - # call. If unspecified, the first page of results is returned. + # A token identifying a page of results to return. This should be a ` + # next_page_token` value returned from a previous `ListServices` call. If + # unspecified, the first page of results is returned. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -503,32 +486,29 @@ module Google # Lists all publicly available SKUs for a given cloud service. # @param [String] parent - # Required. The name of the service. - # Example: "services/DA34-426B-A397" + # Required. The name of the service. Example: "services/DA34-426B-A397" # @param [String] currency_code - # The ISO 4217 currency code for the pricing info in the response proto. - # Will use the conversion rate as of start_time. - # Optional. If not specified USD will be used. + # The ISO 4217 currency code for the pricing info in the response proto. Will + # use the conversion rate as of start_time. Optional. If not specified USD will + # be used. # @param [String] end_time - # Optional exclusive end time of the time range for which the pricing - # versions will be returned. Timestamps in the future are not allowed. - # The time range has to be within a single calendar month in - # America/Los_Angeles timezone. Time range as a whole is optional. If not - # specified, the latest pricing will be returned (up to 12 hours old at - # most). + # Optional exclusive end time of the time range for which the pricing versions + # will be returned. Timestamps in the future are not allowed. The time range has + # to be within a single calendar month in America/Los_Angeles timezone. Time + # range as a whole is optional. If not specified, the latest pricing will be + # returned (up to 12 hours old at most). # @param [Fixnum] page_size # Requested page size. Defaults to 5000. # @param [String] page_token - # A token identifying a page of results to return. This should be a - # `next_page_token` value returned from a previous `ListSkus` - # call. If unspecified, the first page of results is returned. + # A token identifying a page of results to return. This should be a ` + # next_page_token` value returned from a previous `ListSkus` call. If + # unspecified, the first page of results is returned. # @param [String] start_time - # Optional inclusive start time of the time range for which the pricing - # versions will be returned. Timestamps in the future are not allowed. - # The time range has to be within a single calendar month in - # America/Los_Angeles timezone. Time range as a whole is optional. If not - # specified, the latest pricing will be returned (up to 12 hours old at - # most). + # Optional inclusive start time of the time range for which the pricing versions + # will be returned. Timestamps in the future are not allowed. The time range has + # to be within a single calendar month in America/Los_Angeles timezone. Time + # range as a whole is optional. If not specified, the latest pricing will be + # returned (up to 12 hours old at most). # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/datastore_v1.rb b/generated/google/apis/datastore_v1.rb index 2ded7d6be..d3d08246f 100644 --- a/generated/google/apis/datastore_v1.rb +++ b/generated/google/apis/datastore_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/datastore/ module DatastoreV1 VERSION = 'V1' - REVISION = '20200709' + REVISION = '20200802' # 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/datastore_v1/classes.rb b/generated/google/apis/datastore_v1/classes.rb index 5bcea2305..221e8d680 100644 --- a/generated/google/apis/datastore_v1/classes.rb +++ b/generated/google/apis/datastore_v1/classes.rb @@ -46,8 +46,8 @@ module Google class AllocateIdsResponse include Google::Apis::Core::Hashable - # The keys specified in the request (in the same order), each with - # its key path completed with a newly allocated ID. + # The keys specified in the request (in the same order), each with its key path + # completed with a newly allocated ID. # Corresponds to the JSON property `keys` # @return [Array] attr_accessor :keys @@ -66,9 +66,8 @@ module Google class ArrayValue include Google::Apis::Core::Hashable - # Values in the array. - # The order of values in an array is preserved as long as all values have - # identical settings for 'exclude_from_indexes'. + # Values in the array. The order of values in an array is preserved as long as + # all values have identical settings for 'exclude_from_indexes'. # Corresponds to the JSON property `values` # @return [Array] attr_accessor :values @@ -87,9 +86,8 @@ module Google class BeginTransactionRequest include Google::Apis::Core::Hashable - # Options for beginning a new transaction. - # Transactions can be created explicitly with calls to - # Datastore.BeginTransaction or implicitly by setting + # Options for beginning a new transaction. Transactions can be created + # explicitly with calls to Datastore.BeginTransaction or implicitly by setting # ReadOptions.new_transaction in read requests. # Corresponds to the JSON property `transactionOptions` # @return [Google::Apis::DatastoreV1::TransactionOptions] @@ -134,23 +132,18 @@ module Google # @return [String] attr_accessor :mode - # The mutations to perform. - # When mode is `TRANSACTIONAL`, mutations affecting a single entity are - # applied in order. The following sequences of mutations affecting a single - # entity are not permitted in a single `Commit` request: - # - `insert` followed by `insert` - # - `update` followed by `insert` - # - `upsert` followed by `insert` - # - `delete` followed by `update` - # When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single - # entity. + # The mutations to perform. When mode is `TRANSACTIONAL`, mutations affecting a + # single entity are applied in order. The following sequences of mutations + # affecting a single entity are not permitted in a single `Commit` request: - ` + # insert` followed by `insert` - `update` followed by `insert` - `upsert` + # followed by `insert` - `delete` followed by `update` When mode is ` + # NON_TRANSACTIONAL`, no two mutations may affect a single entity. # Corresponds to the JSON property `mutations` # @return [Array] attr_accessor :mutations - # The identifier of the transaction associated with the commit. A - # transaction identifier is returned by a call to - # Datastore.BeginTransaction. + # The identifier of the transaction associated with the commit. A transaction + # identifier is returned by a call to Datastore.BeginTransaction. # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -178,8 +171,8 @@ module Google # @return [Fixnum] attr_accessor :index_updates - # The result of performing the mutations. - # The i-th mutation result corresponds to the i-th mutation in the request. + # The result of performing the mutations. The i-th mutation result corresponds + # to the i-th mutation in the request. # Corresponds to the JSON property `mutationResults` # @return [Array] attr_accessor :mutation_results @@ -199,8 +192,7 @@ module Google class CompositeFilter include Google::Apis::Core::Hashable - # The list of filters to combine. - # Must contain at least one filter. + # The list of filters to combine. Must contain at least one filter. # Corresponds to the JSON property `filters` # @return [Array] attr_accessor :filters @@ -221,13 +213,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 @@ -240,27 +230,23 @@ module Google end end - # A Datastore data object. - # An entity is limited to 1 megabyte when stored. That _roughly_ - # corresponds to a limit of 1 megabyte for the serialized form of this + # A Datastore data object. An entity is limited to 1 megabyte when stored. That + # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. class Entity include Google::Apis::Core::Hashable - # A unique identifier for an entity. - # If a key's partition ID or any of its path kinds or names are - # reserved/read-only, the key is reserved/read-only. - # A reserved/read-only key is forbidden in certain documented contexts. + # A unique identifier for an entity. If a key's partition ID or any of its path + # kinds or names are reserved/read-only, the key is reserved/read-only. A + # reserved/read-only key is forbidden in certain documented contexts. # Corresponds to the JSON property `key` # @return [Google::Apis::DatastoreV1::Key] attr_accessor :key - # The entity's properties. - # The map's keys are property names. - # A property name matching regex `__.*__` is reserved. - # A reserved property name is forbidden in certain documented contexts. - # The name must not contain more than 500 characters. - # The name cannot be `""`. + # The entity's properties. The map's keys are property names. A property name + # matching regex `__.*__` is reserved. A reserved property name is forbidden in + # certain documented contexts. The name must not contain more than 500 + # characters. The name cannot be `""`. # Corresponds to the JSON property `properties` # @return [Hash] attr_accessor :properties @@ -280,28 +266,25 @@ module Google class EntityResult include Google::Apis::Core::Hashable - # A cursor that points to the position after the result entity. - # Set only when the `EntityResult` is part of a `QueryResultBatch` message. + # A cursor that points to the position after the result entity. Set only when + # the `EntityResult` is part of a `QueryResultBatch` message. # Corresponds to the JSON property `cursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :cursor - # A Datastore data object. - # An entity is limited to 1 megabyte when stored. That _roughly_ - # corresponds to a limit of 1 megabyte for the serialized form of this + # A Datastore data object. An entity is limited to 1 megabyte when stored. That + # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `entity` # @return [Google::Apis::DatastoreV1::Entity] attr_accessor :entity # The version of the entity, a strictly positive number that monotonically - # increases with changes to the entity. - # This field is set for `FULL` entity - # results. - # For missing entities in `LookupResponse`, this - # is the version of the snapshot that was used to look up the entity, and it - # is always set except for eventually consistent reads. + # increases with changes to the entity. This field is set for `FULL` entity + # results. For missing entities in `LookupResponse`, this is the version of the + # snapshot that was used to look up the entity, and it is always set except for + # eventually consistent reads. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -352,14 +335,13 @@ module Google # @return [String] attr_accessor :end_time - # The client-assigned labels which were provided when the operation was - # created. May also include additional labels. + # The client-assigned labels which were provided when the operation was created. + # May also include additional labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The type of the operation. Can be used as a filter in - # ListOperationsRequest. + # The type of the operation. Can be used as a filter in ListOperationsRequest. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type @@ -390,18 +372,12 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] class GoogleDatastoreAdminV1EntityFilter include Google::Apis::Core::Hashable @@ -410,12 +386,11 @@ module Google # @return [Array] attr_accessor :kinds - # An empty list represents all namespaces. This is the preferred - # usage for projects that don't use namespaces. - # An empty string element represents the default namespace. This should be - # used if the project has data in non-default namespaces, but doesn't want to - # include them. - # Each namespace in this list must be unique. + # An empty list represents all namespaces. This is the preferred usage for + # projects that don't use namespaces. An empty string element represents the + # default namespace. This should be used if the project has data in non-default + # namespaces, but doesn't want to include them. Each namespace in this list must + # be unique. # Corresponds to the JSON property `namespaceIds` # @return [Array] attr_accessor :namespace_ids @@ -442,27 +417,20 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1EntityFilter] attr_accessor :entity_filter - # Location for the export metadata and data files. This will be the same - # value as the - # google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix - # field. The final output location is provided in - # google.datastore.admin.v1.ExportEntitiesResponse.output_url. + # Location for the export metadata and data files. This will be the same value + # as the google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. + # The final output location is provided in google.datastore.admin.v1. + # ExportEntitiesResponse.output_url. # Corresponds to the JSON property `outputUrlPrefix` # @return [String] attr_accessor :output_url_prefix @@ -491,25 +459,18 @@ module Google end end - # The request for - # google.datastore.admin.v1.DatastoreAdmin.ExportEntities. + # The request for google.datastore.admin.v1.DatastoreAdmin.ExportEntities. class GoogleDatastoreAdminV1ExportEntitiesRequest include Google::Apis::Core::Hashable # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1EntityFilter] attr_accessor :entity_filter @@ -519,22 +480,19 @@ module Google # @return [Hash] attr_accessor :labels - # Required. Location for the export metadata and data files. - # The full resource URL of the external storage location. Currently, only - # Google Cloud Storage is supported. So output_url_prefix should be of the - # form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the - # name of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud - # Storage namespace path (this is not a Cloud Datastore namespace). For more - # information about Cloud Storage namespace paths, see - # [Object name - # considerations](https://cloud.google.com/storage/docs/naming#object- - # considerations). - # The resulting files will be nested deeper than the specified URL prefix. - # The final output URL will be provided in the - # google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That - # value should be used for subsequent ImportEntities operations. - # By nesting the data files deeper, the same Cloud Storage bucket can be used - # in multiple ExportEntities operations without conflict. + # Required. Location for the export metadata and data files. The full resource + # URL of the external storage location. Currently, only Google Cloud Storage is + # supported. So output_url_prefix should be of the form: `gs://BUCKET_NAME[/ + # NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Cloud Storage bucket + # and `NAMESPACE_PATH` is an optional Cloud Storage namespace path (this is not + # a Cloud Datastore namespace). For more information about Cloud Storage + # namespace paths, see [Object name considerations](https://cloud.google.com/ + # storage/docs/naming#object-considerations). The resulting files will be nested + # deeper than the specified URL prefix. The final output URL will be provided in + # the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That + # value should be used for subsequent ImportEntities operations. By nesting the + # data files deeper, the same Cloud Storage bucket can be used in multiple + # ExportEntities operations without conflict. # Corresponds to the JSON property `outputUrlPrefix` # @return [String] attr_accessor :output_url_prefix @@ -551,15 +509,14 @@ module Google end end - # The response for - # google.datastore.admin.v1.DatastoreAdmin.ExportEntities. + # The response for google.datastore.admin.v1.DatastoreAdmin.ExportEntities. class GoogleDatastoreAdminV1ExportEntitiesResponse include Google::Apis::Core::Hashable - # Location of the output metadata file. This can be used to begin an import - # into Cloud Datastore (this project or another project). See - # google.datastore.admin.v1.ImportEntitiesRequest.input_url. - # Only present if the operation completed successfully. + # Location of the output metadata file. This can be used to begin an import into + # Cloud Datastore (this project or another project). See google.datastore.admin. + # v1.ImportEntitiesRequest.input_url. Only present if the operation completed + # successfully. # Corresponds to the JSON property `outputUrl` # @return [String] attr_accessor :output_url @@ -585,24 +542,18 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1EntityFilter] attr_accessor :entity_filter - # The location of the import metadata file. This will be the same value as - # the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. + # The location of the import metadata file. This will be the same value as the + # google.datastore.admin.v1.ExportEntitiesResponse.output_url field. # Corresponds to the JSON property `inputUrl` # @return [String] attr_accessor :input_url @@ -631,43 +582,32 @@ module Google end end - # The request for - # google.datastore.admin.v1.DatastoreAdmin.ImportEntities. + # The request for google.datastore.admin.v1.DatastoreAdmin.ImportEntities. class GoogleDatastoreAdminV1ImportEntitiesRequest include Google::Apis::Core::Hashable # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1EntityFilter] attr_accessor :entity_filter # Required. The full resource URL of the external storage location. Currently, - # only - # Google Cloud Storage is supported. So input_url should be of the form: - # `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where - # `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is - # an optional Cloud Storage namespace path (this is not a Cloud Datastore - # namespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written - # by the ExportEntities operation. For more information about Cloud Storage - # namespace paths, see - # [Object name - # considerations](https://cloud.google.com/storage/docs/naming#object- - # considerations). - # For more information, see - # google.datastore.admin.v1.ExportEntitiesResponse.output_url. + # only Google Cloud Storage is supported. So input_url should be of the form: ` + # gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where ` + # BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is an + # optional Cloud Storage namespace path (this is not a Cloud Datastore namespace) + # , and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written by the + # ExportEntities operation. For more information about Cloud Storage namespace + # paths, see [Object name considerations](https://cloud.google.com/storage/docs/ + # naming#object-considerations). For more information, see google.datastore. + # admin.v1.ExportEntitiesResponse.output_url. # Corresponds to the JSON property `inputUrl` # @return [String] attr_accessor :input_url @@ -693,7 +633,7 @@ module Google class GoogleDatastoreAdminV1Index include Google::Apis::Core::Hashable - # Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. + # Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. # Corresponds to the JSON property `ancestor` # @return [String] attr_accessor :ancestor @@ -773,7 +713,7 @@ module Google class GoogleDatastoreAdminV1IndexedProperty include Google::Apis::Core::Hashable - # Required. The indexed property's direction. Must not be DIRECTION_UNSPECIFIED. + # Required. The indexed property's direction. Must not be DIRECTION_UNSPECIFIED. # Corresponds to the JSON property `direction` # @return [String] attr_accessor :direction @@ -794,8 +734,7 @@ module Google end end - # The response for - # google.datastore.admin.v1.DatastoreAdmin.ListIndexes. + # The response for google.datastore.admin.v1.DatastoreAdmin.ListIndexes. class GoogleDatastoreAdminV1ListIndexesResponse include Google::Apis::Core::Hashable @@ -824,14 +763,14 @@ module Google class GoogleDatastoreAdminV1Progress include Google::Apis::Core::Hashable - # The amount of work that has been completed. Note that this may be greater - # than work_estimated. + # The amount of work that has been completed. Note that this may be greater than + # work_estimated. # Corresponds to the JSON property `workCompleted` # @return [Fixnum] attr_accessor :work_completed - # An estimate of how much work needs to be performed. May be zero if the - # work estimate is unavailable. + # An estimate of how much work needs to be performed. May be zero if the work + # estimate is unavailable. # Corresponds to the JSON property `workEstimated` # @return [Fixnum] attr_accessor :work_estimated @@ -856,14 +795,13 @@ module Google # @return [String] attr_accessor :end_time - # The client-assigned labels which were provided when the operation was - # created. May also include additional labels. + # The client-assigned labels which were provided when the operation was created. + # May also include additional labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The type of the operation. Can be used as a filter in - # ListOperationsRequest. + # The type of the operation. Can be used as a filter in ListOperationsRequest. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type @@ -894,18 +832,12 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] class GoogleDatastoreAdminV1beta1EntityFilter include Google::Apis::Core::Hashable @@ -914,12 +846,11 @@ module Google # @return [Array] attr_accessor :kinds - # An empty list represents all namespaces. This is the preferred - # usage for projects that don't use namespaces. - # An empty string element represents the default namespace. This should be - # used if the project has data in non-default namespaces, but doesn't want to - # include them. - # Each namespace in this list must be unique. + # An empty list represents all namespaces. This is the preferred usage for + # projects that don't use namespaces. An empty string element represents the + # default namespace. This should be used if the project has data in non-default + # namespaces, but doesn't want to include them. Each namespace in this list must + # be unique. # Corresponds to the JSON property `namespaceIds` # @return [Array] attr_accessor :namespace_ids @@ -946,27 +877,20 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1beta1EntityFilter] attr_accessor :entity_filter - # Location for the export metadata and data files. This will be the same - # value as the - # google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix - # field. The final output location is provided in - # google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. + # Location for the export metadata and data files. This will be the same value + # as the google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix + # field. The final output location is provided in google.datastore.admin.v1beta1. + # ExportEntitiesResponse.output_url. # Corresponds to the JSON property `outputUrlPrefix` # @return [String] attr_accessor :output_url_prefix @@ -995,15 +919,14 @@ module Google end end - # The response for - # google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. + # The response for google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. class GoogleDatastoreAdminV1beta1ExportEntitiesResponse include Google::Apis::Core::Hashable - # Location of the output metadata file. This can be used to begin an import - # into Cloud Datastore (this project or another project). See - # google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. - # Only present if the operation completed successfully. + # Location of the output metadata file. This can be used to begin an import into + # Cloud Datastore (this project or another project). See google.datastore.admin. + # v1beta1.ImportEntitiesRequest.input_url. Only present if the operation + # completed successfully. # Corresponds to the JSON property `outputUrl` # @return [String] attr_accessor :output_url @@ -1029,25 +952,18 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1beta1EntityFilter] attr_accessor :entity_filter - # The location of the import metadata file. This will be the same value as - # the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url - # field. + # The location of the import metadata file. This will be the same value as the + # google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url field. # Corresponds to the JSON property `inputUrl` # @return [String] attr_accessor :input_url @@ -1080,14 +996,14 @@ module Google class GoogleDatastoreAdminV1beta1Progress include Google::Apis::Core::Hashable - # The amount of work that has been completed. Note that this may be greater - # than work_estimated. + # The amount of work that has been completed. Note that this may be greater than + # work_estimated. # Corresponds to the JSON property `workCompleted` # @return [Fixnum] attr_accessor :work_completed - # An estimate of how much work needs to be performed. May be zero if the - # work estimate is unavailable. + # An estimate of how much work needs to be performed. May be zero if the work + # estimate is unavailable. # Corresponds to the JSON property `workEstimated` # @return [Fixnum] attr_accessor :work_estimated @@ -1133,47 +1049,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::DatastoreV1::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 @@ -1192,38 +1106,35 @@ module Google end end - # A [GQL - # query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). + # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). class GqlQuery include Google::Apis::Core::Hashable # When false, the query string must not contain any literals and instead must - # bind all values. For example, - # `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while - # `SELECT * FROM Kind WHERE a = @value` is. + # bind all values. For example, `SELECT * FROM Kind WHERE a = 'string literal'` + # is not allowed, while `SELECT * FROM Kind WHERE a = @value` is. # Corresponds to the JSON property `allowLiterals` # @return [Boolean] attr_accessor :allow_literals alias_method :allow_literals?, :allow_literals - # For each non-reserved named binding site in the query string, there must be - # a named parameter with that name, but not necessarily the inverse. - # Key must match regex `A-Za-z_$*`, must not match regex - # `__.*__`, and must not be `""`. + # For each non-reserved named binding site in the query string, there must be a + # named parameter with that name, but not necessarily the inverse. Key must + # match regex `A-Za-z_$*`, must not match regex `__.*__`, and must not be `""`. # Corresponds to the JSON property `namedBindings` # @return [Hash] attr_accessor :named_bindings - # Numbered binding site @1 references the first numbered parameter, - # effectively using 1-based indexing, rather than the usual 0. - # For each binding site numbered i in `query_string`, there must be an i-th - # numbered parameter. The inverse must also be true. + # Numbered binding site @1 references the first numbered parameter, effectively + # using 1-based indexing, rather than the usual 0. For each binding site + # numbered i in `query_string`, there must be an i-th numbered parameter. The + # inverse must also be true. # Corresponds to the JSON property `positionalBindings` # @return [Array] attr_accessor :positional_bindings - # A string of the format described - # [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). + # A string of the format described [here](https://cloud.google.com/datastore/ + # docs/apis/gql/gql_reference). # Corresponds to the JSON property `queryString` # @return [String] attr_accessor :query_string @@ -1245,8 +1156,7 @@ module Google class GqlQueryParameter include Google::Apis::Core::Hashable - # A query cursor. Query cursors are returned in query - # result batches. + # A query cursor. Query cursors are returned in query result batches. # Corresponds to the JSON property `cursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1269,47 +1179,38 @@ module Google end end - # A unique identifier for an entity. - # If a key's partition ID or any of its path kinds or names are - # reserved/read-only, the key is reserved/read-only. - # A reserved/read-only key is forbidden in certain documented contexts. + # A unique identifier for an entity. If a key's partition ID or any of its path + # kinds or names are reserved/read-only, the key is reserved/read-only. A + # reserved/read-only key is forbidden in certain documented contexts. class Key include Google::Apis::Core::Hashable - # A partition ID identifies a grouping of entities. The grouping is always - # by project and namespace, however the namespace ID may be empty. - # A partition ID contains several dimensions: - # project ID and namespace ID. - # Partition dimensions: - # - May be `""`. - # - Must be valid UTF-8 bytes. - # - Must have values that match regex `[A-Za-z\d\.\-_]`1,100`` - # If the value of any dimension matches regex `__.*__`, the partition is - # reserved/read-only. - # A reserved/read-only partition ID is forbidden in certain documented - # contexts. - # Foreign partition IDs (in which the project ID does - # not match the context project ID ) are discouraged. - # Reads and writes of foreign partition IDs may fail if the project is not in an + # A partition ID identifies a grouping of entities. The grouping is always by + # project and namespace, however the namespace ID may be empty. A partition ID + # contains several dimensions: project ID and namespace ID. Partition dimensions: + # - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match + # regex `[A-Za-z\d\.\-_]`1,100`` If the value of any dimension matches regex `__. + # *__`, the partition is reserved/read-only. A reserved/read-only partition ID + # is forbidden in certain documented contexts. Foreign partition IDs (in which + # the project ID does not match the context project ID ) are discouraged. Reads + # and writes of foreign partition IDs may fail if the project is not in an # active state. # Corresponds to the JSON property `partitionId` # @return [Google::Apis::DatastoreV1::PartitionId] attr_accessor :partition_id - # The entity path. - # An entity path consists of one or more elements composed of a kind and a - # string or numerical identifier, which identify entities. The first - # element identifies a _root entity_, the second element identifies - # a _child_ of the root entity, the third element identifies a child of the - # second entity, and so forth. The entities identified by all prefixes of - # the path are called the element's _ancestors_. - # An entity path is always fully complete: *all* of the entity's ancestors - # are required to be in the path along with the entity identifier itself. - # The only exception is that in some documented cases, the identifier in the - # last path element (for the entity) itself may be omitted. For example, - # the last path element of the key of `Mutation.insert` may have no - # identifier. - # A path can never be empty, and a path can have at most 100 elements. + # The entity path. An entity path consists of one or more elements composed of a + # kind and a string or numerical identifier, which identify entities. The first + # element identifies a _root entity_, the second element identifies a _child_ of + # the root entity, the third element identifies a child of the second entity, + # and so forth. The entities identified by all prefixes of the path are called + # the element's _ancestors_. An entity path is always fully complete: *all* of + # the entity's ancestors are required to be in the path along with the entity + # identifier itself. The only exception is that in some documented cases, the + # identifier in the last path element (for the entity) itself may be omitted. + # For example, the last path element of the key of `Mutation.insert` may have no + # identifier. A path can never be empty, and a path can have at most 100 + # elements. # Corresponds to the JSON property `path` # @return [Array] attr_accessor :path @@ -1346,9 +1247,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 @@ -1402,23 +1302,22 @@ module Google class LookupResponse include Google::Apis::Core::Hashable - # A list of keys that were not looked up due to resource constraints. The - # order of results in this field is undefined and has no relation to the - # order of the keys in the input. + # A list of keys that were not looked up due to resource constraints. The order + # of results in this field is undefined and has no relation to the order of the + # keys in the input. # Corresponds to the JSON property `deferred` # @return [Array] attr_accessor :deferred # Entities found as `ResultType.FULL` entities. The order of results in this - # field is undefined and has no relation to the order of the keys in the - # input. + # field is undefined and has no relation to the order of the keys in the input. # Corresponds to the JSON property `found` # @return [Array] attr_accessor :found - # Entities not found as `ResultType.KEY_ONLY` entities. The order of results - # in this field is undefined and has no relation to the order of the keys - # in the input. + # Entities not found as `ResultType.KEY_ONLY` entities. The order of results in + # this field is undefined and has no relation to the order of the keys in the + # input. # Corresponds to the JSON property `missing` # @return [Array] attr_accessor :missing @@ -1439,39 +1338,35 @@ module Google class Mutation include Google::Apis::Core::Hashable - # The version of the entity that this mutation is being applied to. If this - # does not match the current version on the server, the mutation conflicts. + # The version of the entity that this mutation is being applied to. If this does + # not match the current version on the server, the mutation conflicts. # Corresponds to the JSON property `baseVersion` # @return [Fixnum] attr_accessor :base_version - # A unique identifier for an entity. - # If a key's partition ID or any of its path kinds or names are - # reserved/read-only, the key is reserved/read-only. - # A reserved/read-only key is forbidden in certain documented contexts. + # A unique identifier for an entity. If a key's partition ID or any of its path + # kinds or names are reserved/read-only, the key is reserved/read-only. A + # reserved/read-only key is forbidden in certain documented contexts. # Corresponds to the JSON property `delete` # @return [Google::Apis::DatastoreV1::Key] attr_accessor :delete - # A Datastore data object. - # An entity is limited to 1 megabyte when stored. That _roughly_ - # corresponds to a limit of 1 megabyte for the serialized form of this + # A Datastore data object. An entity is limited to 1 megabyte when stored. That + # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `insert` # @return [Google::Apis::DatastoreV1::Entity] attr_accessor :insert - # A Datastore data object. - # An entity is limited to 1 megabyte when stored. That _roughly_ - # corresponds to a limit of 1 megabyte for the serialized form of this + # A Datastore data object. An entity is limited to 1 megabyte when stored. That + # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `update` # @return [Google::Apis::DatastoreV1::Entity] attr_accessor :update - # A Datastore data object. - # An entity is limited to 1 megabyte when stored. That _roughly_ - # corresponds to a limit of 1 megabyte for the serialized form of this + # A Datastore data object. An entity is limited to 1 megabyte when stored. That + # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `upsert` # @return [Google::Apis::DatastoreV1::Entity] @@ -1502,19 +1397,18 @@ module Google attr_accessor :conflict_detected alias_method :conflict_detected?, :conflict_detected - # A unique identifier for an entity. - # If a key's partition ID or any of its path kinds or names are - # reserved/read-only, the key is reserved/read-only. - # A reserved/read-only key is forbidden in certain documented contexts. + # A unique identifier for an entity. If a key's partition ID or any of its path + # kinds or names are reserved/read-only, the key is reserved/read-only. A + # reserved/read-only key is forbidden in certain documented contexts. # Corresponds to the JSON property `key` # @return [Google::Apis::DatastoreV1::Key] attr_accessor :key - # The version of the entity on the server after processing the mutation. If - # the mutation doesn't change anything on the server, then the version will - # be the version of the current entity or, if no entity is present, a version - # that is strictly greater than the version of any previous entity and less - # than the version of any possible future entity. + # The version of the entity on the server after processing the mutation. If the + # mutation doesn't change anything on the server, then the version will be the + # version of the current entity or, if no entity is present, a version that is + # strictly greater than the version of any previous entity and less than the + # version of any possible future entity. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -1531,21 +1425,15 @@ module Google end end - # A partition ID identifies a grouping of entities. The grouping is always - # by project and namespace, however the namespace ID may be empty. - # A partition ID contains several dimensions: - # project ID and namespace ID. - # Partition dimensions: - # - May be `""`. - # - Must be valid UTF-8 bytes. - # - Must have values that match regex `[A-Za-z\d\.\-_]`1,100`` - # If the value of any dimension matches regex `__.*__`, the partition is - # reserved/read-only. - # A reserved/read-only partition ID is forbidden in certain documented - # contexts. - # Foreign partition IDs (in which the project ID does - # not match the context project ID ) are discouraged. - # Reads and writes of foreign partition IDs may fail if the project is not in an + # A partition ID identifies a grouping of entities. The grouping is always by + # project and namespace, however the namespace ID may be empty. A partition ID + # contains several dimensions: project ID and namespace ID. Partition dimensions: + # - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match + # regex `[A-Za-z\d\.\-_]`1,100`` If the value of any dimension matches regex `__. + # *__`, the partition is reserved/read-only. A reserved/read-only partition ID + # is forbidden in certain documented contexts. Foreign partition IDs (in which + # the project ID does not match the context project ID ) are discouraged. Reads + # and writes of foreign partition IDs may fail if the project is not in an # active state. class PartitionId include Google::Apis::Core::Hashable @@ -1571,31 +1459,26 @@ module Google end end - # A (kind, ID/name) pair used to construct a key path. - # If either name or ID is set, the element is complete. - # If neither is set, the element is incomplete. + # A (kind, ID/name) pair used to construct a key path. If either name or ID is + # set, the element is complete. If neither is set, the element is incomplete. class PathElement include Google::Apis::Core::Hashable - # The auto-allocated ID of the entity. - # Never equal to zero. Values less than zero are discouraged and may not - # be supported in the future. + # The auto-allocated ID of the entity. Never equal to zero. Values less than + # zero are discouraged and may not be supported in the future. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id - # The kind of the entity. - # A kind matching regex `__.*__` is reserved/read-only. - # A kind must not contain more than 1500 bytes when UTF-8 encoded. - # Cannot be `""`. + # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. + # A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""` + # . # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The name of the entity. - # A name matching regex `__.*__` is reserved/read-only. - # A name must not be more than 1500 bytes when UTF-8 encoded. - # Cannot be `""`. + # The name of the entity. A name matching regex `__.*__` is reserved/read-only. + # A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1692,8 +1575,8 @@ module Google class PropertyReference include Google::Apis::Core::Hashable - # The name of the property. - # If name includes "."s, it may be interpreted as a property name path. + # The name of the property. If name includes "."s, it may be interpreted as a + # property name path. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1713,17 +1596,15 @@ module Google include Google::Apis::Core::Hashable # The properties to make distinct. The query results will contain the first - # result for each distinct combination of values for the given properties - # (if empty, all results are returned). + # result for each distinct combination of values for the given properties (if + # empty, all results are returned). # Corresponds to the JSON property `distinctOn` # @return [Array] attr_accessor :distinct_on - # An ending point for the query results. Query cursors are - # returned in query result batches and - # [can only be used to limit the same - # query](https://cloud.google.com/datastore/docs/concepts/queries# - # cursors_limits_and_offsets). + # An ending point for the query results. Query cursors are returned in query + # result batches and [can only be used to limit the same query](https://cloud. + # google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets). # Corresponds to the JSON property `endCursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1734,16 +1615,14 @@ module Google # @return [Google::Apis::DatastoreV1::Filter] attr_accessor :filter - # The kinds to query (if empty, returns entities of all kinds). - # Currently at most 1 kind may be specified. + # The kinds to query (if empty, returns entities of all kinds). Currently at + # most 1 kind may be specified. # Corresponds to the JSON property `kind` # @return [Array] attr_accessor :kind - # The maximum number of results to return. Applies after all other - # constraints. Optional. - # Unspecified is interpreted as no limit. - # Must be >= 0 if specified. + # The maximum number of results to return. Applies after all other constraints. + # Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified. # Corresponds to the JSON property `limit` # @return [Fixnum] attr_accessor :limit @@ -1764,11 +1643,9 @@ module Google # @return [Array] attr_accessor :projection - # A starting point for the query results. Query cursors are - # returned in query result batches and - # [can only be used to continue the same - # query](https://cloud.google.com/datastore/docs/concepts/queries# - # cursors_limits_and_offsets). + # A starting point for the query results. Query cursors are returned in query + # result batches and [can only be used to continue the same query](https://cloud. + # google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets). # Corresponds to the JSON property `startCursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1817,8 +1694,8 @@ module Google # @return [String] attr_accessor :more_results - # A cursor that points to the position after the last skipped result. - # Will be set when `skipped_results` != 0. + # A cursor that points to the position after the last skipped result. Will be + # set when `skipped_results` != 0. # Corresponds to the JSON property `skippedCursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1829,14 +1706,13 @@ module Google # @return [Fixnum] attr_accessor :skipped_results - # The version number of the snapshot this batch was returned from. - # This applies to the range of results from the query's `start_cursor` (or - # the beginning of the query if no cursor was given) to this batch's - # `end_cursor` (not the query's `end_cursor`). - # In a single transaction, subsequent query result batches for the same query - # can have a greater snapshot version number. Each batch's snapshot version - # is valid for all preceding batches. - # The value will be zero for eventually consistent queries. + # The version number of the snapshot this batch was returned from. This applies + # to the range of results from the query's `start_cursor` (or the beginning of + # the query if no cursor was given) to this batch's `end_cursor` (not the query' + # s `end_cursor`). In a single transaction, subsequent query result batches for + # the same query can have a greater snapshot version number. Each batch's + # snapshot version is valid for all preceding batches. The value will be zero + # for eventually consistent queries. # Corresponds to the JSON property `snapshotVersion` # @return [Fixnum] attr_accessor :snapshot_version @@ -1874,15 +1750,14 @@ module Google class ReadOptions include Google::Apis::Core::Hashable - # The non-transactional read consistency to use. - # Cannot be set to `STRONG` for global queries. + # The non-transactional read consistency to use. Cannot be set to `STRONG` for + # global queries. # Corresponds to the JSON property `readConsistency` # @return [String] attr_accessor :read_consistency - # The identifier of the transaction in which to read. A - # transaction identifier is returned by a call to - # Datastore.BeginTransaction. + # The identifier of the transaction in which to read. A transaction identifier + # is returned by a call to Datastore.BeginTransaction. # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1929,8 +1804,7 @@ module Google attr_accessor :database_id # Required. A list of keys with complete key paths whose numeric IDs should not - # be - # auto-allocated. + # be auto-allocated. # Corresponds to the JSON property `keys` # @return [Array] attr_accessor :keys @@ -1963,8 +1837,8 @@ module Google class RollbackRequest include Google::Apis::Core::Hashable - # Required. The transaction identifier, returned by a call to - # Datastore.BeginTransaction. + # Required. The transaction identifier, returned by a call to Datastore. + # BeginTransaction. # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1980,8 +1854,7 @@ module Google end end - # The response for Datastore.Rollback. - # (an empty message). + # The response for Datastore.Rollback. (an empty message). class RollbackResponse include Google::Apis::Core::Hashable @@ -1998,27 +1871,20 @@ module Google class RunQueryRequest include Google::Apis::Core::Hashable - # A [GQL - # query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). + # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). # Corresponds to the JSON property `gqlQuery` # @return [Google::Apis::DatastoreV1::GqlQuery] attr_accessor :gql_query - # A partition ID identifies a grouping of entities. The grouping is always - # by project and namespace, however the namespace ID may be empty. - # A partition ID contains several dimensions: - # project ID and namespace ID. - # Partition dimensions: - # - May be `""`. - # - Must be valid UTF-8 bytes. - # - Must have values that match regex `[A-Za-z\d\.\-_]`1,100`` - # If the value of any dimension matches regex `__.*__`, the partition is - # reserved/read-only. - # A reserved/read-only partition ID is forbidden in certain documented - # contexts. - # Foreign partition IDs (in which the project ID does - # not match the context project ID ) are discouraged. - # Reads and writes of foreign partition IDs may fail if the project is not in an + # A partition ID identifies a grouping of entities. The grouping is always by + # project and namespace, however the namespace ID may be empty. A partition ID + # contains several dimensions: project ID and namespace ID. Partition dimensions: + # - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match + # regex `[A-Za-z\d\.\-_]`1,100`` If the value of any dimension matches regex `__. + # *__`, the partition is reserved/read-only. A reserved/read-only partition ID + # is forbidden in certain documented contexts. Foreign partition IDs (in which + # the project ID does not match the context project ID ) are discouraged. Reads + # and writes of foreign partition IDs may fail if the project is not in an # active state. # Corresponds to the JSON property `partitionId` # @return [Google::Apis::DatastoreV1::PartitionId] @@ -2072,12 +1938,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 @@ -2086,15 +1952,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 @@ -2111,9 +1977,8 @@ module Google end end - # Options for beginning a new transaction. - # Transactions can be created explicitly with calls to - # Datastore.BeginTransaction or implicitly by setting + # Options for beginning a new transaction. Transactions can be created + # explicitly with calls to Datastore.BeginTransaction or implicitly by setting # ReadOptions.new_transaction in read requests. class TransactionOptions include Google::Apis::Core::Hashable @@ -2149,10 +2014,8 @@ module Google # @return [Google::Apis::DatastoreV1::ArrayValue] attr_accessor :array_value - # A blob value. - # May have at most 1,000,000 bytes. - # When `exclude_from_indexes` is false, may have at most 1500 bytes. - # In JSON requests, must be base64-encoded. + # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is + # false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. # Corresponds to the JSON property `blobValue` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -2169,9 +2032,8 @@ module Google # @return [Float] attr_accessor :double_value - # A Datastore data object. - # An entity is limited to 1 megabyte when stored. That _roughly_ - # corresponds to a limit of 1 megabyte for the serialized form of this + # A Datastore data object. An entity is limited to 1 megabyte when stored. That + # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `entityValue` # @return [Google::Apis::DatastoreV1::Entity] @@ -2186,9 +2048,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 `geoPointValue` # @return [Google::Apis::DatastoreV1::LatLng] attr_accessor :geo_point_value @@ -2198,10 +2059,9 @@ module Google # @return [Fixnum] attr_accessor :integer_value - # A unique identifier for an entity. - # If a key's partition ID or any of its path kinds or names are - # reserved/read-only, the key is reserved/read-only. - # A reserved/read-only key is forbidden in certain documented contexts. + # A unique identifier for an entity. If a key's partition ID or any of its path + # kinds or names are reserved/read-only, the key is reserved/read-only. A + # reserved/read-only key is forbidden in certain documented contexts. # Corresponds to the JSON property `keyValue` # @return [Google::Apis::DatastoreV1::Key] attr_accessor :key_value @@ -2216,16 +2076,14 @@ module Google # @return [String] attr_accessor :null_value - # A UTF-8 encoded string value. - # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 - # bytes. - # Otherwise, may be set to at most 1,000,000 bytes. + # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is + # indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000, + # 000 bytes. # Corresponds to the JSON property `stringValue` # @return [String] attr_accessor :string_value - # A timestamp value. - # When stored in the Datastore, precise only to microseconds; + # A timestamp value. When stored in the Datastore, precise only to microseconds; # any additional precision is rounded down. # Corresponds to the JSON property `timestampValue` # @return [String] diff --git a/generated/google/apis/datastore_v1/service.rb b/generated/google/apis/datastore_v1/service.rb index 511bf2058..d6f3ad143 100644 --- a/generated/google/apis/datastore_v1/service.rb +++ b/generated/google/apis/datastore_v1/service.rb @@ -149,14 +149,13 @@ module Google execute_or_queue_command(command, &block) end - # Exports a copy of all or a subset of entities from Google Cloud Datastore - # to another storage system, such as Google Cloud Storage. Recent updates to + # Exports a copy of all or a subset of entities from Google Cloud Datastore to + # another storage system, such as Google Cloud Storage. Recent updates to # entities may not be reflected in the export. The export occurs in the - # background and its progress can be monitored and managed via the - # Operation resource that is created. The output of an export may only be - # used once the associated operation is done. If an export operation is - # cancelled before completion it may leave partial data behind in Google - # Cloud Storage. + # background and its progress can be monitored and managed via the Operation + # resource that is created. The output of an export may only be used once the + # associated operation is done. If an export operation is cancelled before + # completion it may leave partial data behind in Google Cloud Storage. # @param [String] project_id # Required. Project ID against which to make the request. # @param [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1ExportEntitiesRequest] google_datastore_admin_v1_export_entities_request_object @@ -189,11 +188,11 @@ module Google execute_or_queue_command(command, &block) end - # Imports entities into Google Cloud Datastore. Existing entities with the - # same key are overwritten. The import occurs in the background and its - # progress can be monitored and managed via the Operation resource that is - # created. If an ImportEntities operation is cancelled, it is possible - # that a subset of the data has already been imported to Cloud Datastore. + # Imports entities into Google Cloud Datastore. Existing entities with the same + # key are overwritten. The import occurs in the background and its progress can + # be monitored and managed via the Operation resource that is created. If an + # ImportEntities operation is cancelled, it is possible that a subset of the + # data has already been imported to Cloud Datastore. # @param [String] project_id # Required. Project ID against which to make the request. # @param [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1ImportEntitiesRequest] google_datastore_admin_v1_import_entities_request_object @@ -259,8 +258,7 @@ module Google execute_or_queue_command(command, &block) end - # Prevents the supplied keys' IDs from being auto-allocated by Cloud - # Datastore. + # Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore. # @param [String] project_id # Required. The ID of the project against which to make the request. # @param [Google::Apis::DatastoreV1::ReserveIdsRequest] reserve_ids_request_object @@ -359,17 +357,14 @@ module Google execute_or_queue_command(command, &block) end - # Creates the specified index. - # A newly created index's initial state is `CREATING`. On completion of the - # returned google.longrunning.Operation, the state will be `READY`. - # If the index already exists, the call will return an `ALREADY_EXISTS` - # status. - # During index creation, the process could result in an error, in which - # case the index will move to the `ERROR` state. The process can be recovered - # by fixing the data that caused the error, removing the index with - # delete, then - # re-creating the index with create. - # Indexes with a single property cannot be created. + # Creates the specified index. A newly created index's initial state is ` + # CREATING`. On completion of the returned google.longrunning.Operation, the + # state will be `READY`. If the index already exists, the call will return an ` + # ALREADY_EXISTS` status. During index creation, the process could result in an + # error, in which case the index will move to the `ERROR` state. The process can + # be recovered by fixing the data that caused the error, removing the index with + # delete, then re-creating the index with create. Indexes with a single property + # cannot be created. # @param [String] project_id # Project ID against which to make the request. # @param [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1Index] google_datastore_admin_v1_index_object @@ -402,15 +397,13 @@ module Google execute_or_queue_command(command, &block) end - # Deletes an existing index. - # An index can only be deleted if it is in a `READY` or `ERROR` state. On - # successful execution of the request, the index will be in a `DELETING` - # state. And on completion of the - # returned google.longrunning.Operation, the index will be removed. - # During index deletion, the process could result in an error, in which - # case the index will move to the `ERROR` state. The process can be recovered - # by fixing the data that caused the error, followed by calling - # delete again. + # Deletes an existing index. An index can only be deleted if it is in a `READY` + # or `ERROR` state. On successful execution of the request, the index will be in + # a `DELETING` state. And on completion of the returned google.longrunning. + # Operation, the index will be removed. During index deletion, the process could + # result in an error, in which case the index will move to the `ERROR` state. + # The process can be recovered by fixing the data that caused the error, + # followed by calling delete again. # @param [String] project_id # Project ID against which to make the request. # @param [String] index_id @@ -476,14 +469,14 @@ module Google execute_or_queue_command(command, &block) end - # Lists the indexes that match the specified filters. Datastore uses an - # eventually consistent query to fetch the list of indexes and may - # occasionally return stale results. + # Lists the indexes that match the specified filters. Datastore uses an + # eventually consistent query to fetch the list of indexes and may occasionally + # return stale results. # @param [String] project_id # Project ID against which to make the request. # @param [String] filter # @param [Fixnum] page_size - # The maximum number of items to return. If zero, then all results will be + # The maximum number of items to return. If zero, then all results will be # returned. # @param [String] page_token # The next_page_token value returned from a previous List request, if any. @@ -517,15 +510,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. @@ -556,10 +547,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 @@ -589,9 +580,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 @@ -621,15 +611,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/datastore_v1beta1.rb b/generated/google/apis/datastore_v1beta1.rb index 323970745..452002d9d 100644 --- a/generated/google/apis/datastore_v1beta1.rb +++ b/generated/google/apis/datastore_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/datastore/ module DatastoreV1beta1 VERSION = 'V1beta1' - REVISION = '20200216' + REVISION = '20200802' # 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/datastore_v1beta1/classes.rb b/generated/google/apis/datastore_v1beta1/classes.rb index 48731861f..99c3acb5f 100644 --- a/generated/google/apis/datastore_v1beta1/classes.rb +++ b/generated/google/apis/datastore_v1beta1/classes.rb @@ -31,14 +31,13 @@ module Google # @return [String] attr_accessor :end_time - # The client-assigned labels which were provided when the operation was - # created. May also include additional labels. + # The client-assigned labels which were provided when the operation was created. + # May also include additional labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The type of the operation. Can be used as a filter in - # ListOperationsRequest. + # The type of the operation. Can be used as a filter in ListOperationsRequest. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type @@ -69,18 +68,12 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] class GoogleDatastoreAdminV1EntityFilter include Google::Apis::Core::Hashable @@ -89,12 +82,11 @@ module Google # @return [Array] attr_accessor :kinds - # An empty list represents all namespaces. This is the preferred - # usage for projects that don't use namespaces. - # An empty string element represents the default namespace. This should be - # used if the project has data in non-default namespaces, but doesn't want to - # include them. - # Each namespace in this list must be unique. + # An empty list represents all namespaces. This is the preferred usage for + # projects that don't use namespaces. An empty string element represents the + # default namespace. This should be used if the project has data in non-default + # namespaces, but doesn't want to include them. Each namespace in this list must + # be unique. # Corresponds to the JSON property `namespaceIds` # @return [Array] attr_accessor :namespace_ids @@ -121,27 +113,20 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1EntityFilter] attr_accessor :entity_filter - # Location for the export metadata and data files. This will be the same - # value as the - # google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix - # field. The final output location is provided in - # google.datastore.admin.v1.ExportEntitiesResponse.output_url. + # Location for the export metadata and data files. This will be the same value + # as the google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. + # The final output location is provided in google.datastore.admin.v1. + # ExportEntitiesResponse.output_url. # Corresponds to the JSON property `outputUrlPrefix` # @return [String] attr_accessor :output_url_prefix @@ -170,15 +155,14 @@ module Google end end - # The response for - # google.datastore.admin.v1.DatastoreAdmin.ExportEntities. + # The response for google.datastore.admin.v1.DatastoreAdmin.ExportEntities. class GoogleDatastoreAdminV1ExportEntitiesResponse include Google::Apis::Core::Hashable - # Location of the output metadata file. This can be used to begin an import - # into Cloud Datastore (this project or another project). See - # google.datastore.admin.v1.ImportEntitiesRequest.input_url. - # Only present if the operation completed successfully. + # Location of the output metadata file. This can be used to begin an import into + # Cloud Datastore (this project or another project). See google.datastore.admin. + # v1.ImportEntitiesRequest.input_url. Only present if the operation completed + # successfully. # Corresponds to the JSON property `outputUrl` # @return [String] attr_accessor :output_url @@ -204,24 +188,18 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1EntityFilter] attr_accessor :entity_filter - # The location of the import metadata file. This will be the same value as - # the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. + # The location of the import metadata file. This will be the same value as the + # google.datastore.admin.v1.ExportEntitiesResponse.output_url field. # Corresponds to the JSON property `inputUrl` # @return [String] attr_accessor :input_url @@ -285,14 +263,14 @@ module Google class GoogleDatastoreAdminV1Progress include Google::Apis::Core::Hashable - # The amount of work that has been completed. Note that this may be greater - # than work_estimated. + # The amount of work that has been completed. Note that this may be greater than + # work_estimated. # Corresponds to the JSON property `workCompleted` # @return [Fixnum] attr_accessor :work_completed - # An estimate of how much work needs to be performed. May be zero if the - # work estimate is unavailable. + # An estimate of how much work needs to be performed. May be zero if the work + # estimate is unavailable. # Corresponds to the JSON property `workEstimated` # @return [Fixnum] attr_accessor :work_estimated @@ -317,14 +295,13 @@ module Google # @return [String] attr_accessor :end_time - # The client-assigned labels which were provided when the operation was - # created. May also include additional labels. + # The client-assigned labels which were provided when the operation was created. + # May also include additional labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The type of the operation. Can be used as a filter in - # ListOperationsRequest. + # The type of the operation. Can be used as a filter in ListOperationsRequest. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type @@ -355,18 +332,12 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] class GoogleDatastoreAdminV1beta1EntityFilter include Google::Apis::Core::Hashable @@ -375,12 +346,11 @@ module Google # @return [Array] attr_accessor :kinds - # An empty list represents all namespaces. This is the preferred - # usage for projects that don't use namespaces. - # An empty string element represents the default namespace. This should be - # used if the project has data in non-default namespaces, but doesn't want to - # include them. - # Each namespace in this list must be unique. + # An empty list represents all namespaces. This is the preferred usage for + # projects that don't use namespaces. An empty string element represents the + # default namespace. This should be used if the project has data in non-default + # namespaces, but doesn't want to include them. Each namespace in this list must + # be unique. # Corresponds to the JSON property `namespaceIds` # @return [Array] attr_accessor :namespace_ids @@ -407,27 +377,20 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1EntityFilter] attr_accessor :entity_filter - # Location for the export metadata and data files. This will be the same - # value as the - # google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix - # field. The final output location is provided in - # google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. + # Location for the export metadata and data files. This will be the same value + # as the google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix + # field. The final output location is provided in google.datastore.admin.v1beta1. + # ExportEntitiesResponse.output_url. # Corresponds to the JSON property `outputUrlPrefix` # @return [String] attr_accessor :output_url_prefix @@ -456,25 +419,18 @@ module Google end end - # The request for - # google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. + # The request for google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. class GoogleDatastoreAdminV1beta1ExportEntitiesRequest include Google::Apis::Core::Hashable # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1EntityFilter] attr_accessor :entity_filter @@ -484,22 +440,19 @@ module Google # @return [Hash] attr_accessor :labels - # Location for the export metadata and data files. - # The full resource URL of the external storage location. Currently, only - # Google Cloud Storage is supported. So output_url_prefix should be of the - # form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the - # name of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud - # Storage namespace path (this is not a Cloud Datastore namespace). For more - # information about Cloud Storage namespace paths, see - # [Object name - # considerations](https://cloud.google.com/storage/docs/naming#object- - # considerations). - # The resulting files will be nested deeper than the specified URL prefix. - # The final output URL will be provided in the - # google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url - # field. That value should be used for subsequent ImportEntities operations. - # By nesting the data files deeper, the same Cloud Storage bucket can be used - # in multiple ExportEntities operations without conflict. + # Location for the export metadata and data files. The full resource URL of the + # external storage location. Currently, only Google Cloud Storage is supported. + # So output_url_prefix should be of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]` + # , where `BUCKET_NAME` is the name of the Cloud Storage bucket and ` + # NAMESPACE_PATH` is an optional Cloud Storage namespace path (this is not a + # Cloud Datastore namespace). For more information about Cloud Storage namespace + # paths, see [Object name considerations](https://cloud.google.com/storage/docs/ + # naming#object-considerations). The resulting files will be nested deeper than + # the specified URL prefix. The final output URL will be provided in the google. + # datastore.admin.v1beta1.ExportEntitiesResponse.output_url field. That value + # should be used for subsequent ImportEntities operations. By nesting the data + # files deeper, the same Cloud Storage bucket can be used in multiple + # ExportEntities operations without conflict. # Corresponds to the JSON property `outputUrlPrefix` # @return [String] attr_accessor :output_url_prefix @@ -516,15 +469,14 @@ module Google end end - # The response for - # google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. + # The response for google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. class GoogleDatastoreAdminV1beta1ExportEntitiesResponse include Google::Apis::Core::Hashable - # Location of the output metadata file. This can be used to begin an import - # into Cloud Datastore (this project or another project). See - # google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. - # Only present if the operation completed successfully. + # Location of the output metadata file. This can be used to begin an import into + # Cloud Datastore (this project or another project). See google.datastore.admin. + # v1beta1.ImportEntitiesRequest.input_url. Only present if the operation + # completed successfully. # Corresponds to the JSON property `outputUrl` # @return [String] attr_accessor :output_url @@ -550,25 +502,18 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1EntityFilter] attr_accessor :entity_filter - # The location of the import metadata file. This will be the same value as - # the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url - # field. + # The location of the import metadata file. This will be the same value as the + # google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url field. # Corresponds to the JSON property `inputUrl` # @return [String] attr_accessor :input_url @@ -597,42 +542,32 @@ module Google end end - # The request for - # google.datastore.admin.v1beta1.DatastoreAdmin.ImportEntities. + # The request for google.datastore.admin.v1beta1.DatastoreAdmin.ImportEntities. class GoogleDatastoreAdminV1beta1ImportEntitiesRequest include Google::Apis::Core::Hashable # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1EntityFilter] attr_accessor :entity_filter - # The full resource URL of the external storage location. Currently, only - # Google Cloud Storage is supported. So input_url should be of the form: - # `gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where - # `BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is - # an optional Cloud Storage namespace path (this is not a Cloud Datastore - # namespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written - # by the ExportEntities operation. For more information about Cloud Storage - # namespace paths, see - # [Object name - # considerations](https://cloud.google.com/storage/docs/naming#object- - # considerations). - # For more information, see - # google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. + # The full resource URL of the external storage location. Currently, only Google + # Cloud Storage is supported. So input_url should be of the form: `gs:// + # BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where `BUCKET_NAME` + # is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is an optional + # Cloud Storage namespace path (this is not a Cloud Datastore namespace), and ` + # OVERALL_EXPORT_METADATA_FILE` is the metadata file written by the + # ExportEntities operation. For more information about Cloud Storage namespace + # paths, see [Object name considerations](https://cloud.google.com/storage/docs/ + # naming#object-considerations). For more information, see google.datastore. + # admin.v1beta1.ExportEntitiesResponse.output_url. # Corresponds to the JSON property `inputUrl` # @return [String] attr_accessor :input_url @@ -658,14 +593,14 @@ module Google class GoogleDatastoreAdminV1beta1Progress include Google::Apis::Core::Hashable - # The amount of work that has been completed. Note that this may be greater - # than work_estimated. + # The amount of work that has been completed. Note that this may be greater than + # work_estimated. # Corresponds to the JSON property `workCompleted` # @return [Fixnum] attr_accessor :work_completed - # An estimate of how much work needs to be performed. May be zero if the - # work estimate is unavailable. + # An estimate of how much work needs to be performed. May be zero if the work + # estimate is unavailable. # Corresponds to the JSON property `workEstimated` # @return [Fixnum] attr_accessor :work_estimated @@ -686,47 +621,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::DatastoreV1beta1::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 @@ -745,12 +678,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 @@ -759,15 +692,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/datastore_v1beta1/service.rb b/generated/google/apis/datastore_v1beta1/service.rb index ad58bd022..f02b455b4 100644 --- a/generated/google/apis/datastore_v1beta1/service.rb +++ b/generated/google/apis/datastore_v1beta1/service.rb @@ -48,14 +48,13 @@ module Google @batch_path = 'batch' end - # Exports a copy of all or a subset of entities from Google Cloud Datastore - # to another storage system, such as Google Cloud Storage. Recent updates to + # Exports a copy of all or a subset of entities from Google Cloud Datastore to + # another storage system, such as Google Cloud Storage. Recent updates to # entities may not be reflected in the export. The export occurs in the - # background and its progress can be monitored and managed via the - # Operation resource that is created. The output of an export may only be - # used once the associated operation is done. If an export operation is - # cancelled before completion it may leave partial data behind in Google - # Cloud Storage. + # background and its progress can be monitored and managed via the Operation + # resource that is created. The output of an export may only be used once the + # associated operation is done. If an export operation is cancelled before + # completion it may leave partial data behind in Google Cloud Storage. # @param [String] project_id # Project ID against which to make the request. # @param [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1ExportEntitiesRequest] google_datastore_admin_v1beta1_export_entities_request_object @@ -88,11 +87,11 @@ module Google execute_or_queue_command(command, &block) end - # Imports entities into Google Cloud Datastore. Existing entities with the - # same key are overwritten. The import occurs in the background and its - # progress can be monitored and managed via the Operation resource that is - # created. If an ImportEntities operation is cancelled, it is possible - # that a subset of the data has already been imported to Cloud Datastore. + # Imports entities into Google Cloud Datastore. Existing entities with the same + # key are overwritten. The import occurs in the background and its progress can + # be monitored and managed via the Operation resource that is created. If an + # ImportEntities operation is cancelled, it is possible that a subset of the + # data has already been imported to Cloud Datastore. # @param [String] project_id # Project ID against which to make the request. # @param [Google::Apis::DatastoreV1beta1::GoogleDatastoreAdminV1beta1ImportEntitiesRequest] google_datastore_admin_v1beta1_import_entities_request_object diff --git a/generated/google/apis/datastore_v1beta3.rb b/generated/google/apis/datastore_v1beta3.rb index 8f27d9021..7625ab457 100644 --- a/generated/google/apis/datastore_v1beta3.rb +++ b/generated/google/apis/datastore_v1beta3.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/datastore/ module DatastoreV1beta3 VERSION = 'V1beta3' - REVISION = '20200510' + REVISION = '20200802' # 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/datastore_v1beta3/classes.rb b/generated/google/apis/datastore_v1beta3/classes.rb index 582798902..fd5414b2b 100644 --- a/generated/google/apis/datastore_v1beta3/classes.rb +++ b/generated/google/apis/datastore_v1beta3/classes.rb @@ -46,8 +46,8 @@ module Google class AllocateIdsResponse include Google::Apis::Core::Hashable - # The keys specified in the request (in the same order), each with - # its key path completed with a newly allocated ID. + # The keys specified in the request (in the same order), each with its key path + # completed with a newly allocated ID. # Corresponds to the JSON property `keys` # @return [Array] attr_accessor :keys @@ -66,9 +66,8 @@ module Google class ArrayValue include Google::Apis::Core::Hashable - # Values in the array. - # The order of values in an array is preserved as long as all values have - # identical settings for 'exclude_from_indexes'. + # Values in the array. The order of values in an array is preserved as long as + # all values have identical settings for 'exclude_from_indexes'. # Corresponds to the JSON property `values` # @return [Array] attr_accessor :values @@ -87,9 +86,8 @@ module Google class BeginTransactionRequest include Google::Apis::Core::Hashable - # Options for beginning a new transaction. - # Transactions can be created explicitly with calls to - # Datastore.BeginTransaction or implicitly by setting + # Options for beginning a new transaction. Transactions can be created + # explicitly with calls to Datastore.BeginTransaction or implicitly by setting # ReadOptions.new_transaction in read requests. # Corresponds to the JSON property `transactionOptions` # @return [Google::Apis::DatastoreV1beta3::TransactionOptions] @@ -134,23 +132,18 @@ module Google # @return [String] attr_accessor :mode - # The mutations to perform. - # When mode is `TRANSACTIONAL`, mutations affecting a single entity are - # applied in order. The following sequences of mutations affecting a single - # entity are not permitted in a single `Commit` request: - # - `insert` followed by `insert` - # - `update` followed by `insert` - # - `upsert` followed by `insert` - # - `delete` followed by `update` - # When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single - # entity. + # The mutations to perform. When mode is `TRANSACTIONAL`, mutations affecting a + # single entity are applied in order. The following sequences of mutations + # affecting a single entity are not permitted in a single `Commit` request: - ` + # insert` followed by `insert` - `update` followed by `insert` - `upsert` + # followed by `insert` - `delete` followed by `update` When mode is ` + # NON_TRANSACTIONAL`, no two mutations may affect a single entity. # Corresponds to the JSON property `mutations` # @return [Array] attr_accessor :mutations - # The identifier of the transaction associated with the commit. A - # transaction identifier is returned by a call to - # Datastore.BeginTransaction. + # The identifier of the transaction associated with the commit. A transaction + # identifier is returned by a call to Datastore.BeginTransaction. # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -178,8 +171,8 @@ module Google # @return [Fixnum] attr_accessor :index_updates - # The result of performing the mutations. - # The i-th mutation result corresponds to the i-th mutation in the request. + # The result of performing the mutations. The i-th mutation result corresponds + # to the i-th mutation in the request. # Corresponds to the JSON property `mutationResults` # @return [Array] attr_accessor :mutation_results @@ -199,8 +192,7 @@ module Google class CompositeFilter include Google::Apis::Core::Hashable - # The list of filters to combine. - # Must contain at least one filter. + # The list of filters to combine. Must contain at least one filter. # Corresponds to the JSON property `filters` # @return [Array] attr_accessor :filters @@ -221,27 +213,23 @@ module Google end end - # A Datastore data object. - # An entity is limited to 1 megabyte when stored. That _roughly_ - # corresponds to a limit of 1 megabyte for the serialized form of this + # A Datastore data object. An entity is limited to 1 megabyte when stored. That + # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. class Entity include Google::Apis::Core::Hashable - # A unique identifier for an entity. - # If a key's partition ID or any of its path kinds or names are - # reserved/read-only, the key is reserved/read-only. - # A reserved/read-only key is forbidden in certain documented contexts. + # A unique identifier for an entity. If a key's partition ID or any of its path + # kinds or names are reserved/read-only, the key is reserved/read-only. A + # reserved/read-only key is forbidden in certain documented contexts. # Corresponds to the JSON property `key` # @return [Google::Apis::DatastoreV1beta3::Key] attr_accessor :key - # The entity's properties. - # The map's keys are property names. - # A property name matching regex `__.*__` is reserved. - # A reserved property name is forbidden in certain documented contexts. - # The name must not contain more than 500 characters. - # The name cannot be `""`. + # The entity's properties. The map's keys are property names. A property name + # matching regex `__.*__` is reserved. A reserved property name is forbidden in + # certain documented contexts. The name must not contain more than 500 + # characters. The name cannot be `""`. # Corresponds to the JSON property `properties` # @return [Hash] attr_accessor :properties @@ -261,28 +249,25 @@ module Google class EntityResult include Google::Apis::Core::Hashable - # A cursor that points to the position after the result entity. - # Set only when the `EntityResult` is part of a `QueryResultBatch` message. + # A cursor that points to the position after the result entity. Set only when + # the `EntityResult` is part of a `QueryResultBatch` message. # Corresponds to the JSON property `cursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :cursor - # A Datastore data object. - # An entity is limited to 1 megabyte when stored. That _roughly_ - # corresponds to a limit of 1 megabyte for the serialized form of this + # A Datastore data object. An entity is limited to 1 megabyte when stored. That + # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `entity` # @return [Google::Apis::DatastoreV1beta3::Entity] attr_accessor :entity # The version of the entity, a strictly positive number that monotonically - # increases with changes to the entity. - # This field is set for `FULL` entity - # results. - # For missing entities in `LookupResponse`, this - # is the version of the snapshot that was used to look up the entity, and it - # is always set except for eventually consistent reads. + # increases with changes to the entity. This field is set for `FULL` entity + # results. For missing entities in `LookupResponse`, this is the version of the + # snapshot that was used to look up the entity, and it is always set except for + # eventually consistent reads. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -333,14 +318,13 @@ module Google # @return [String] attr_accessor :end_time - # The client-assigned labels which were provided when the operation was - # created. May also include additional labels. + # The client-assigned labels which were provided when the operation was created. + # May also include additional labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The type of the operation. Can be used as a filter in - # ListOperationsRequest. + # The type of the operation. Can be used as a filter in ListOperationsRequest. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type @@ -371,18 +355,12 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] class GoogleDatastoreAdminV1EntityFilter include Google::Apis::Core::Hashable @@ -391,12 +369,11 @@ module Google # @return [Array] attr_accessor :kinds - # An empty list represents all namespaces. This is the preferred - # usage for projects that don't use namespaces. - # An empty string element represents the default namespace. This should be - # used if the project has data in non-default namespaces, but doesn't want to - # include them. - # Each namespace in this list must be unique. + # An empty list represents all namespaces. This is the preferred usage for + # projects that don't use namespaces. An empty string element represents the + # default namespace. This should be used if the project has data in non-default + # namespaces, but doesn't want to include them. Each namespace in this list must + # be unique. # Corresponds to the JSON property `namespaceIds` # @return [Array] attr_accessor :namespace_ids @@ -423,27 +400,20 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1EntityFilter] attr_accessor :entity_filter - # Location for the export metadata and data files. This will be the same - # value as the - # google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix - # field. The final output location is provided in - # google.datastore.admin.v1.ExportEntitiesResponse.output_url. + # Location for the export metadata and data files. This will be the same value + # as the google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. + # The final output location is provided in google.datastore.admin.v1. + # ExportEntitiesResponse.output_url. # Corresponds to the JSON property `outputUrlPrefix` # @return [String] attr_accessor :output_url_prefix @@ -472,15 +442,14 @@ module Google end end - # The response for - # google.datastore.admin.v1.DatastoreAdmin.ExportEntities. + # The response for google.datastore.admin.v1.DatastoreAdmin.ExportEntities. class GoogleDatastoreAdminV1ExportEntitiesResponse include Google::Apis::Core::Hashable - # Location of the output metadata file. This can be used to begin an import - # into Cloud Datastore (this project or another project). See - # google.datastore.admin.v1.ImportEntitiesRequest.input_url. - # Only present if the operation completed successfully. + # Location of the output metadata file. This can be used to begin an import into + # Cloud Datastore (this project or another project). See google.datastore.admin. + # v1.ImportEntitiesRequest.input_url. Only present if the operation completed + # successfully. # Corresponds to the JSON property `outputUrl` # @return [String] attr_accessor :output_url @@ -506,24 +475,18 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1EntityFilter] attr_accessor :entity_filter - # The location of the import metadata file. This will be the same value as - # the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. + # The location of the import metadata file. This will be the same value as the + # google.datastore.admin.v1.ExportEntitiesResponse.output_url field. # Corresponds to the JSON property `inputUrl` # @return [String] attr_accessor :input_url @@ -587,14 +550,14 @@ module Google class GoogleDatastoreAdminV1Progress include Google::Apis::Core::Hashable - # The amount of work that has been completed. Note that this may be greater - # than work_estimated. + # The amount of work that has been completed. Note that this may be greater than + # work_estimated. # Corresponds to the JSON property `workCompleted` # @return [Fixnum] attr_accessor :work_completed - # An estimate of how much work needs to be performed. May be zero if the - # work estimate is unavailable. + # An estimate of how much work needs to be performed. May be zero if the work + # estimate is unavailable. # Corresponds to the JSON property `workEstimated` # @return [Fixnum] attr_accessor :work_estimated @@ -619,14 +582,13 @@ module Google # @return [String] attr_accessor :end_time - # The client-assigned labels which were provided when the operation was - # created. May also include additional labels. + # The client-assigned labels which were provided when the operation was created. + # May also include additional labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # The type of the operation. Can be used as a filter in - # ListOperationsRequest. + # The type of the operation. Can be used as a filter in ListOperationsRequest. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type @@ -657,18 +619,12 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] class GoogleDatastoreAdminV1beta1EntityFilter include Google::Apis::Core::Hashable @@ -677,12 +633,11 @@ module Google # @return [Array] attr_accessor :kinds - # An empty list represents all namespaces. This is the preferred - # usage for projects that don't use namespaces. - # An empty string element represents the default namespace. This should be - # used if the project has data in non-default namespaces, but doesn't want to - # include them. - # Each namespace in this list must be unique. + # An empty list represents all namespaces. This is the preferred usage for + # projects that don't use namespaces. An empty string element represents the + # default namespace. This should be used if the project has data in non-default + # namespaces, but doesn't want to include them. Each namespace in this list must + # be unique. # Corresponds to the JSON property `namespaceIds` # @return [Array] attr_accessor :namespace_ids @@ -709,27 +664,20 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1EntityFilter] attr_accessor :entity_filter - # Location for the export metadata and data files. This will be the same - # value as the - # google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix - # field. The final output location is provided in - # google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url. + # Location for the export metadata and data files. This will be the same value + # as the google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix + # field. The final output location is provided in google.datastore.admin.v1beta1. + # ExportEntitiesResponse.output_url. # Corresponds to the JSON property `outputUrlPrefix` # @return [String] attr_accessor :output_url_prefix @@ -758,15 +706,14 @@ module Google end end - # The response for - # google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. + # The response for google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. class GoogleDatastoreAdminV1beta1ExportEntitiesResponse include Google::Apis::Core::Hashable - # Location of the output metadata file. This can be used to begin an import - # into Cloud Datastore (this project or another project). See - # google.datastore.admin.v1beta1.ImportEntitiesRequest.input_url. - # Only present if the operation completed successfully. + # Location of the output metadata file. This can be used to begin an import into + # Cloud Datastore (this project or another project). See google.datastore.admin. + # v1beta1.ImportEntitiesRequest.input_url. Only present if the operation + # completed successfully. # Corresponds to the JSON property `outputUrl` # @return [String] attr_accessor :output_url @@ -792,25 +739,18 @@ module Google # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as - # described in the following examples). - # Example usage: - # Entire project: - # kinds=[], namespace_ids=[] - # Kinds Foo and Bar in all namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=[] - # Kinds Foo and Bar only in the default namespace: - # kinds=['Foo', 'Bar'], namespace_ids=[''] - # Kinds Foo and Bar in both the default and Baz namespaces: - # kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] - # The entire Baz namespace: - # kinds=[], namespace_ids=['Baz'] + # described in the following examples). Example usage: Entire project: kinds=[], + # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], + # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', + # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz + # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz + # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1beta3::GoogleDatastoreAdminV1beta1EntityFilter] attr_accessor :entity_filter - # The location of the import metadata file. This will be the same value as - # the google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url - # field. + # The location of the import metadata file. This will be the same value as the + # google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url field. # Corresponds to the JSON property `inputUrl` # @return [String] attr_accessor :input_url @@ -843,14 +783,14 @@ module Google class GoogleDatastoreAdminV1beta1Progress include Google::Apis::Core::Hashable - # The amount of work that has been completed. Note that this may be greater - # than work_estimated. + # The amount of work that has been completed. Note that this may be greater than + # work_estimated. # Corresponds to the JSON property `workCompleted` # @return [Fixnum] attr_accessor :work_completed - # An estimate of how much work needs to be performed. May be zero if the - # work estimate is unavailable. + # An estimate of how much work needs to be performed. May be zero if the work + # estimate is unavailable. # Corresponds to the JSON property `workEstimated` # @return [Fixnum] attr_accessor :work_estimated @@ -866,38 +806,35 @@ module Google end end - # A [GQL - # query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). + # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). class GqlQuery include Google::Apis::Core::Hashable # When false, the query string must not contain any literals and instead must - # bind all values. For example, - # `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while - # `SELECT * FROM Kind WHERE a = @value` is. + # bind all values. For example, `SELECT * FROM Kind WHERE a = 'string literal'` + # is not allowed, while `SELECT * FROM Kind WHERE a = @value` is. # Corresponds to the JSON property `allowLiterals` # @return [Boolean] attr_accessor :allow_literals alias_method :allow_literals?, :allow_literals - # For each non-reserved named binding site in the query string, there must be - # a named parameter with that name, but not necessarily the inverse. - # Key must match regex `A-Za-z_$*`, must not match regex - # `__.*__`, and must not be `""`. + # For each non-reserved named binding site in the query string, there must be a + # named parameter with that name, but not necessarily the inverse. Key must + # match regex `A-Za-z_$*`, must not match regex `__.*__`, and must not be `""`. # Corresponds to the JSON property `namedBindings` # @return [Hash] attr_accessor :named_bindings - # Numbered binding site @1 references the first numbered parameter, - # effectively using 1-based indexing, rather than the usual 0. - # For each binding site numbered i in `query_string`, there must be an i-th - # numbered parameter. The inverse must also be true. + # Numbered binding site @1 references the first numbered parameter, effectively + # using 1-based indexing, rather than the usual 0. For each binding site + # numbered i in `query_string`, there must be an i-th numbered parameter. The + # inverse must also be true. # Corresponds to the JSON property `positionalBindings` # @return [Array] attr_accessor :positional_bindings - # A string of the format described - # [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). + # A string of the format described [here](https://cloud.google.com/datastore/ + # docs/apis/gql/gql_reference). # Corresponds to the JSON property `queryString` # @return [String] attr_accessor :query_string @@ -919,8 +856,7 @@ module Google class GqlQueryParameter include Google::Apis::Core::Hashable - # A query cursor. Query cursors are returned in query - # result batches. + # A query cursor. Query cursors are returned in query result batches. # Corresponds to the JSON property `cursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -943,47 +879,38 @@ module Google end end - # A unique identifier for an entity. - # If a key's partition ID or any of its path kinds or names are - # reserved/read-only, the key is reserved/read-only. - # A reserved/read-only key is forbidden in certain documented contexts. + # A unique identifier for an entity. If a key's partition ID or any of its path + # kinds or names are reserved/read-only, the key is reserved/read-only. A + # reserved/read-only key is forbidden in certain documented contexts. class Key include Google::Apis::Core::Hashable - # A partition ID identifies a grouping of entities. The grouping is always - # by project and namespace, however the namespace ID may be empty. - # A partition ID contains several dimensions: - # project ID and namespace ID. - # Partition dimensions: - # - May be `""`. - # - Must be valid UTF-8 bytes. - # - Must have values that match regex `[A-Za-z\d\.\-_]`1,100`` - # If the value of any dimension matches regex `__.*__`, the partition is - # reserved/read-only. - # A reserved/read-only partition ID is forbidden in certain documented - # contexts. - # Foreign partition IDs (in which the project ID does - # not match the context project ID ) are discouraged. - # Reads and writes of foreign partition IDs may fail if the project is not in an + # A partition ID identifies a grouping of entities. The grouping is always by + # project and namespace, however the namespace ID may be empty. A partition ID + # contains several dimensions: project ID and namespace ID. Partition dimensions: + # - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match + # regex `[A-Za-z\d\.\-_]`1,100`` If the value of any dimension matches regex `__. + # *__`, the partition is reserved/read-only. A reserved/read-only partition ID + # is forbidden in certain documented contexts. Foreign partition IDs (in which + # the project ID does not match the context project ID ) are discouraged. Reads + # and writes of foreign partition IDs may fail if the project is not in an # active state. # Corresponds to the JSON property `partitionId` # @return [Google::Apis::DatastoreV1beta3::PartitionId] attr_accessor :partition_id - # The entity path. - # An entity path consists of one or more elements composed of a kind and a - # string or numerical identifier, which identify entities. The first - # element identifies a _root entity_, the second element identifies - # a _child_ of the root entity, the third element identifies a child of the - # second entity, and so forth. The entities identified by all prefixes of - # the path are called the element's _ancestors_. - # An entity path is always fully complete: *all* of the entity's ancestors - # are required to be in the path along with the entity identifier itself. - # The only exception is that in some documented cases, the identifier in the - # last path element (for the entity) itself may be omitted. For example, - # the last path element of the key of `Mutation.insert` may have no - # identifier. - # A path can never be empty, and a path can have at most 100 elements. + # The entity path. An entity path consists of one or more elements composed of a + # kind and a string or numerical identifier, which identify entities. The first + # element identifies a _root entity_, the second element identifies a _child_ of + # the root entity, the third element identifies a child of the second entity, + # and so forth. The entities identified by all prefixes of the path are called + # the element's _ancestors_. An entity path is always fully complete: *all* of + # the entity's ancestors are required to be in the path along with the entity + # identifier itself. The only exception is that in some documented cases, the + # identifier in the last path element (for the entity) itself may be omitted. + # For example, the last path element of the key of `Mutation.insert` may have no + # identifier. A path can never be empty, and a path can have at most 100 + # elements. # Corresponds to the JSON property `path` # @return [Array] attr_accessor :path @@ -1020,9 +947,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 @@ -1076,23 +1002,22 @@ module Google class LookupResponse include Google::Apis::Core::Hashable - # A list of keys that were not looked up due to resource constraints. The - # order of results in this field is undefined and has no relation to the - # order of the keys in the input. + # A list of keys that were not looked up due to resource constraints. The order + # of results in this field is undefined and has no relation to the order of the + # keys in the input. # Corresponds to the JSON property `deferred` # @return [Array] attr_accessor :deferred # Entities found as `ResultType.FULL` entities. The order of results in this - # field is undefined and has no relation to the order of the keys in the - # input. + # field is undefined and has no relation to the order of the keys in the input. # Corresponds to the JSON property `found` # @return [Array] attr_accessor :found - # Entities not found as `ResultType.KEY_ONLY` entities. The order of results - # in this field is undefined and has no relation to the order of the keys - # in the input. + # Entities not found as `ResultType.KEY_ONLY` entities. The order of results in + # this field is undefined and has no relation to the order of the keys in the + # input. # Corresponds to the JSON property `missing` # @return [Array] attr_accessor :missing @@ -1113,39 +1038,35 @@ module Google class Mutation include Google::Apis::Core::Hashable - # The version of the entity that this mutation is being applied to. If this - # does not match the current version on the server, the mutation conflicts. + # The version of the entity that this mutation is being applied to. If this does + # not match the current version on the server, the mutation conflicts. # Corresponds to the JSON property `baseVersion` # @return [Fixnum] attr_accessor :base_version - # A unique identifier for an entity. - # If a key's partition ID or any of its path kinds or names are - # reserved/read-only, the key is reserved/read-only. - # A reserved/read-only key is forbidden in certain documented contexts. + # A unique identifier for an entity. If a key's partition ID or any of its path + # kinds or names are reserved/read-only, the key is reserved/read-only. A + # reserved/read-only key is forbidden in certain documented contexts. # Corresponds to the JSON property `delete` # @return [Google::Apis::DatastoreV1beta3::Key] attr_accessor :delete - # A Datastore data object. - # An entity is limited to 1 megabyte when stored. That _roughly_ - # corresponds to a limit of 1 megabyte for the serialized form of this + # A Datastore data object. An entity is limited to 1 megabyte when stored. That + # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `insert` # @return [Google::Apis::DatastoreV1beta3::Entity] attr_accessor :insert - # A Datastore data object. - # An entity is limited to 1 megabyte when stored. That _roughly_ - # corresponds to a limit of 1 megabyte for the serialized form of this + # A Datastore data object. An entity is limited to 1 megabyte when stored. That + # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `update` # @return [Google::Apis::DatastoreV1beta3::Entity] attr_accessor :update - # A Datastore data object. - # An entity is limited to 1 megabyte when stored. That _roughly_ - # corresponds to a limit of 1 megabyte for the serialized form of this + # A Datastore data object. An entity is limited to 1 megabyte when stored. That + # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `upsert` # @return [Google::Apis::DatastoreV1beta3::Entity] @@ -1176,19 +1097,18 @@ module Google attr_accessor :conflict_detected alias_method :conflict_detected?, :conflict_detected - # A unique identifier for an entity. - # If a key's partition ID or any of its path kinds or names are - # reserved/read-only, the key is reserved/read-only. - # A reserved/read-only key is forbidden in certain documented contexts. + # A unique identifier for an entity. If a key's partition ID or any of its path + # kinds or names are reserved/read-only, the key is reserved/read-only. A + # reserved/read-only key is forbidden in certain documented contexts. # Corresponds to the JSON property `key` # @return [Google::Apis::DatastoreV1beta3::Key] attr_accessor :key - # The version of the entity on the server after processing the mutation. If - # the mutation doesn't change anything on the server, then the version will - # be the version of the current entity or, if no entity is present, a version - # that is strictly greater than the version of any previous entity and less - # than the version of any possible future entity. + # The version of the entity on the server after processing the mutation. If the + # mutation doesn't change anything on the server, then the version will be the + # version of the current entity or, if no entity is present, a version that is + # strictly greater than the version of any previous entity and less than the + # version of any possible future entity. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version @@ -1205,21 +1125,15 @@ module Google end end - # A partition ID identifies a grouping of entities. The grouping is always - # by project and namespace, however the namespace ID may be empty. - # A partition ID contains several dimensions: - # project ID and namespace ID. - # Partition dimensions: - # - May be `""`. - # - Must be valid UTF-8 bytes. - # - Must have values that match regex `[A-Za-z\d\.\-_]`1,100`` - # If the value of any dimension matches regex `__.*__`, the partition is - # reserved/read-only. - # A reserved/read-only partition ID is forbidden in certain documented - # contexts. - # Foreign partition IDs (in which the project ID does - # not match the context project ID ) are discouraged. - # Reads and writes of foreign partition IDs may fail if the project is not in an + # A partition ID identifies a grouping of entities. The grouping is always by + # project and namespace, however the namespace ID may be empty. A partition ID + # contains several dimensions: project ID and namespace ID. Partition dimensions: + # - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match + # regex `[A-Za-z\d\.\-_]`1,100`` If the value of any dimension matches regex `__. + # *__`, the partition is reserved/read-only. A reserved/read-only partition ID + # is forbidden in certain documented contexts. Foreign partition IDs (in which + # the project ID does not match the context project ID ) are discouraged. Reads + # and writes of foreign partition IDs may fail if the project is not in an # active state. class PartitionId include Google::Apis::Core::Hashable @@ -1245,31 +1159,26 @@ module Google end end - # A (kind, ID/name) pair used to construct a key path. - # If either name or ID is set, the element is complete. - # If neither is set, the element is incomplete. + # A (kind, ID/name) pair used to construct a key path. If either name or ID is + # set, the element is complete. If neither is set, the element is incomplete. class PathElement include Google::Apis::Core::Hashable - # The auto-allocated ID of the entity. - # Never equal to zero. Values less than zero are discouraged and may not - # be supported in the future. + # The auto-allocated ID of the entity. Never equal to zero. Values less than + # zero are discouraged and may not be supported in the future. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id - # The kind of the entity. - # A kind matching regex `__.*__` is reserved/read-only. - # A kind must not contain more than 1500 bytes when UTF-8 encoded. - # Cannot be `""`. + # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. + # A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""` + # . # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind - # The name of the entity. - # A name matching regex `__.*__` is reserved/read-only. - # A name must not be more than 1500 bytes when UTF-8 encoded. - # Cannot be `""`. + # The name of the entity. A name matching regex `__.*__` is reserved/read-only. + # A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1366,8 +1275,8 @@ module Google class PropertyReference include Google::Apis::Core::Hashable - # The name of the property. - # If name includes "."s, it may be interpreted as a property name path. + # The name of the property. If name includes "."s, it may be interpreted as a + # property name path. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1387,17 +1296,15 @@ module Google include Google::Apis::Core::Hashable # The properties to make distinct. The query results will contain the first - # result for each distinct combination of values for the given properties - # (if empty, all results are returned). + # result for each distinct combination of values for the given properties (if + # empty, all results are returned). # Corresponds to the JSON property `distinctOn` # @return [Array] attr_accessor :distinct_on - # An ending point for the query results. Query cursors are - # returned in query result batches and - # [can only be used to limit the same - # query](https://cloud.google.com/datastore/docs/concepts/queries# - # cursors_limits_and_offsets). + # An ending point for the query results. Query cursors are returned in query + # result batches and [can only be used to limit the same query](https://cloud. + # google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets). # Corresponds to the JSON property `endCursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1408,16 +1315,14 @@ module Google # @return [Google::Apis::DatastoreV1beta3::Filter] attr_accessor :filter - # The kinds to query (if empty, returns entities of all kinds). - # Currently at most 1 kind may be specified. + # The kinds to query (if empty, returns entities of all kinds). Currently at + # most 1 kind may be specified. # Corresponds to the JSON property `kind` # @return [Array] attr_accessor :kind - # The maximum number of results to return. Applies after all other - # constraints. Optional. - # Unspecified is interpreted as no limit. - # Must be >= 0 if specified. + # The maximum number of results to return. Applies after all other constraints. + # Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified. # Corresponds to the JSON property `limit` # @return [Fixnum] attr_accessor :limit @@ -1438,11 +1343,9 @@ module Google # @return [Array] attr_accessor :projection - # A starting point for the query results. Query cursors are - # returned in query result batches and - # [can only be used to continue the same - # query](https://cloud.google.com/datastore/docs/concepts/queries# - # cursors_limits_and_offsets). + # A starting point for the query results. Query cursors are returned in query + # result batches and [can only be used to continue the same query](https://cloud. + # google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets). # Corresponds to the JSON property `startCursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1491,8 +1394,8 @@ module Google # @return [String] attr_accessor :more_results - # A cursor that points to the position after the last skipped result. - # Will be set when `skipped_results` != 0. + # A cursor that points to the position after the last skipped result. Will be + # set when `skipped_results` != 0. # Corresponds to the JSON property `skippedCursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1503,14 +1406,13 @@ module Google # @return [Fixnum] attr_accessor :skipped_results - # The version number of the snapshot this batch was returned from. - # This applies to the range of results from the query's `start_cursor` (or - # the beginning of the query if no cursor was given) to this batch's - # `end_cursor` (not the query's `end_cursor`). - # In a single transaction, subsequent query result batches for the same query - # can have a greater snapshot version number. Each batch's snapshot version - # is valid for all preceding batches. - # The value will be zero for eventually consistent queries. + # The version number of the snapshot this batch was returned from. This applies + # to the range of results from the query's `start_cursor` (or the beginning of + # the query if no cursor was given) to this batch's `end_cursor` (not the query' + # s `end_cursor`). In a single transaction, subsequent query result batches for + # the same query can have a greater snapshot version number. Each batch's + # snapshot version is valid for all preceding batches. The value will be zero + # for eventually consistent queries. # Corresponds to the JSON property `snapshotVersion` # @return [Fixnum] attr_accessor :snapshot_version @@ -1548,15 +1450,14 @@ module Google class ReadOptions include Google::Apis::Core::Hashable - # The non-transactional read consistency to use. - # Cannot be set to `STRONG` for global queries. + # The non-transactional read consistency to use. Cannot be set to `STRONG` for + # global queries. # Corresponds to the JSON property `readConsistency` # @return [String] attr_accessor :read_consistency - # The identifier of the transaction in which to read. A - # transaction identifier is returned by a call to - # Datastore.BeginTransaction. + # The identifier of the transaction in which to read. A transaction identifier + # is returned by a call to Datastore.BeginTransaction. # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1603,8 +1504,7 @@ module Google attr_accessor :database_id # Required. A list of keys with complete key paths whose numeric IDs should not - # be - # auto-allocated. + # be auto-allocated. # Corresponds to the JSON property `keys` # @return [Array] attr_accessor :keys @@ -1637,8 +1537,8 @@ module Google class RollbackRequest include Google::Apis::Core::Hashable - # Required. The transaction identifier, returned by a call to - # Datastore.BeginTransaction. + # Required. The transaction identifier, returned by a call to Datastore. + # BeginTransaction. # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1654,8 +1554,7 @@ module Google end end - # The response for Datastore.Rollback. - # (an empty message). + # The response for Datastore.Rollback. (an empty message). class RollbackResponse include Google::Apis::Core::Hashable @@ -1672,27 +1571,20 @@ module Google class RunQueryRequest include Google::Apis::Core::Hashable - # A [GQL - # query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). + # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). # Corresponds to the JSON property `gqlQuery` # @return [Google::Apis::DatastoreV1beta3::GqlQuery] attr_accessor :gql_query - # A partition ID identifies a grouping of entities. The grouping is always - # by project and namespace, however the namespace ID may be empty. - # A partition ID contains several dimensions: - # project ID and namespace ID. - # Partition dimensions: - # - May be `""`. - # - Must be valid UTF-8 bytes. - # - Must have values that match regex `[A-Za-z\d\.\-_]`1,100`` - # If the value of any dimension matches regex `__.*__`, the partition is - # reserved/read-only. - # A reserved/read-only partition ID is forbidden in certain documented - # contexts. - # Foreign partition IDs (in which the project ID does - # not match the context project ID ) are discouraged. - # Reads and writes of foreign partition IDs may fail if the project is not in an + # A partition ID identifies a grouping of entities. The grouping is always by + # project and namespace, however the namespace ID may be empty. A partition ID + # contains several dimensions: project ID and namespace ID. Partition dimensions: + # - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match + # regex `[A-Za-z\d\.\-_]`1,100`` If the value of any dimension matches regex `__. + # *__`, the partition is reserved/read-only. A reserved/read-only partition ID + # is forbidden in certain documented contexts. Foreign partition IDs (in which + # the project ID does not match the context project ID ) are discouraged. Reads + # and writes of foreign partition IDs may fail if the project is not in an # active state. # Corresponds to the JSON property `partitionId` # @return [Google::Apis::DatastoreV1beta3::PartitionId] @@ -1746,9 +1638,8 @@ module Google end end - # Options for beginning a new transaction. - # Transactions can be created explicitly with calls to - # Datastore.BeginTransaction or implicitly by setting + # Options for beginning a new transaction. Transactions can be created + # explicitly with calls to Datastore.BeginTransaction or implicitly by setting # ReadOptions.new_transaction in read requests. class TransactionOptions include Google::Apis::Core::Hashable @@ -1784,10 +1675,8 @@ module Google # @return [Google::Apis::DatastoreV1beta3::ArrayValue] attr_accessor :array_value - # A blob value. - # May have at most 1,000,000 bytes. - # When `exclude_from_indexes` is false, may have at most 1500 bytes. - # In JSON requests, must be base64-encoded. + # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is + # false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. # Corresponds to the JSON property `blobValue` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1804,9 +1693,8 @@ module Google # @return [Float] attr_accessor :double_value - # A Datastore data object. - # An entity is limited to 1 megabyte when stored. That _roughly_ - # corresponds to a limit of 1 megabyte for the serialized form of this + # A Datastore data object. An entity is limited to 1 megabyte when stored. That + # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `entityValue` # @return [Google::Apis::DatastoreV1beta3::Entity] @@ -1821,9 +1709,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 `geoPointValue` # @return [Google::Apis::DatastoreV1beta3::LatLng] attr_accessor :geo_point_value @@ -1833,10 +1720,9 @@ module Google # @return [Fixnum] attr_accessor :integer_value - # A unique identifier for an entity. - # If a key's partition ID or any of its path kinds or names are - # reserved/read-only, the key is reserved/read-only. - # A reserved/read-only key is forbidden in certain documented contexts. + # A unique identifier for an entity. If a key's partition ID or any of its path + # kinds or names are reserved/read-only, the key is reserved/read-only. A + # reserved/read-only key is forbidden in certain documented contexts. # Corresponds to the JSON property `keyValue` # @return [Google::Apis::DatastoreV1beta3::Key] attr_accessor :key_value @@ -1851,16 +1737,14 @@ module Google # @return [String] attr_accessor :null_value - # A UTF-8 encoded string value. - # When `exclude_from_indexes` is false (it is indexed) , may have at most 1500 - # bytes. - # Otherwise, may be set to at most 1,000,000 bytes. + # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is + # indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000, + # 000 bytes. # Corresponds to the JSON property `stringValue` # @return [String] attr_accessor :string_value - # A timestamp value. - # When stored in the Datastore, precise only to microseconds; + # A timestamp value. When stored in the Datastore, precise only to microseconds; # any additional precision is rounded down. # Corresponds to the JSON property `timestampValue` # @return [String] diff --git a/generated/google/apis/datastore_v1beta3/service.rb b/generated/google/apis/datastore_v1beta3/service.rb index fd79a57d2..53e694c3b 100644 --- a/generated/google/apis/datastore_v1beta3/service.rb +++ b/generated/google/apis/datastore_v1beta3/service.rb @@ -182,8 +182,7 @@ module Google execute_or_queue_command(command, &block) end - # Prevents the supplied keys' IDs from being auto-allocated by Cloud - # Datastore. + # Prevents the supplied keys' IDs from being auto-allocated by Cloud Datastore. # @param [String] project_id # Required. The ID of the project against which to make the request. # @param [Google::Apis::DatastoreV1beta3::ReserveIdsRequest] reserve_ids_request_object diff --git a/generated/google/apis/dialogflow_v3beta1.rb b/generated/google/apis/dialogflow_v3beta1.rb new file mode 100644 index 000000000..e973b59d7 --- /dev/null +++ b/generated/google/apis/dialogflow_v3beta1.rb @@ -0,0 +1,38 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/dialogflow_v3beta1/service.rb' +require 'google/apis/dialogflow_v3beta1/classes.rb' +require 'google/apis/dialogflow_v3beta1/representations.rb' + +module Google + module Apis + # Dialogflow API + # + # Builds conversational interfaces (for example, chatbots, and voice-powered + # apps and devices). + # + # @see https://cloud.google.com/dialogflow/ + module DialogflowV3beta1 + VERSION = 'V3beta1' + REVISION = '20200810' + + # View and manage your data across Google Cloud Platform services + AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' + + # View, manage and query your Dialogflow agents + AUTH_DIALOGFLOW = 'https://www.googleapis.com/auth/dialogflow' + end + end +end diff --git a/generated/google/apis/dialogflow_v3beta1/classes.rb b/generated/google/apis/dialogflow_v3beta1/classes.rb new file mode 100644 index 000000000..7a9ab80fc --- /dev/null +++ b/generated/google/apis/dialogflow_v3beta1/classes.rb @@ -0,0 +1,5638 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DialogflowV3beta1 + + # Metadata associated with the long running operation for Versions.CreateVersion. + class GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata + include Google::Apis::Core::Hashable + + # Name of the created version. Format: `projects//locations//agents//flows// + # versions/`. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @version = args[:version] if args.key?(:version) + end + end + + # The response message for Agents.ExportAgent. + class GoogleCloudDialogflowCxV3beta1ExportAgentResponse + include Google::Apis::Core::Hashable + + # Uncompressed raw byte content for agent. + # Corresponds to the JSON property `agentContent` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @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. + # Corresponds to the JSON property `agentUri` + # @return [String] + attr_accessor :agent_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @agent_content = args[:agent_content] if args.key?(:agent_content) + @agent_uri = args[:agent_uri] if args.key?(:agent_uri) + end + end + + # Represents page information communicated to and from the webhook. + 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/`. + # Corresponds to the JSON property `currentPage` + # @return [String] + attr_accessor :current_page + + # Represents form information. + # Corresponds to the JSON property `formInfo` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo] + attr_accessor :form_info + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @current_page = args[:current_page] if args.key?(:current_page) + @form_info = args[:form_info] if args.key?(:form_info) + end + end + + # Represents form information. + 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. + # Corresponds to the JSON property `parameterInfo` + # @return [Array] + attr_accessor :parameter_info + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @parameter_info = args[:parameter_info] if args.key?(:parameter_info) + end + end + + # Represents parameter information. + 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. + # 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. + # 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. + # 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. + # 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. + # Corresponds to the JSON property `value` + # @return [Object] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_name = args[:display_name] if args.key?(:display_name) + @just_collected = args[:just_collected] if args.key?(:just_collected) + @required = args[:required] if args.key?(:required) + @state = args[:state] if args.key?(:state) + @value = args[:value] if args.key?(:value) + end + 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 + # 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. + 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. + # Corresponds to the JSON property `conversationSuccess` + # @return [Google::Apis::DialogflowV3beta1::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. + # Corresponds to the JSON property `endInteraction` + # @return [Google::Apis::DialogflowV3beta1::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. + # Corresponds to the JSON property `humanAgentHandoff` + # @return [Google::Apis::DialogflowV3beta1::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. + # Corresponds to the JSON property `liveAgentHandoff` + # @return [Google::Apis::DialogflowV3beta1::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. + # Corresponds to the JSON property `mixedAudio` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio] + attr_accessor :mixed_audio + + # A text or ssml response that is preferentially used for TTS output audio + # synthesis, as described in the comment on the ResponseMessage message. + # Corresponds to the JSON property `outputAudioText` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText] + attr_accessor :output_audio_text + + # Returns a response containing a custom, platform-specific payload. + # Corresponds to the JSON property `payload` + # @return [Hash] + attr_accessor :payload + + # Specifies an audio clip to be played by the client as part of the response. + # Corresponds to the JSON property `playAudio` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio] + attr_accessor :play_audio + + # The text response message. + # Corresponds to the JSON property `text` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageText] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @conversation_success = args[:conversation_success] if args.key?(:conversation_success) + @end_interaction = args[:end_interaction] if args.key?(:end_interaction) + @human_agent_handoff = args[:human_agent_handoff] if args.key?(:human_agent_handoff) + @live_agent_handoff = args[:live_agent_handoff] if args.key?(:live_agent_handoff) + @mixed_audio = args[:mixed_audio] if args.key?(:mixed_audio) + @output_audio_text = args[:output_audio_text] if args.key?(:output_audio_text) + @payload = args[:payload] if args.key?(:payload) + @play_audio = args[:play_audio] if args.key?(:play_audio) + @text = args[:text] if args.key?(:text) + end + 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. + class GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess + include Google::Apis::Core::Hashable + + # Custom metadata. Dialogflow doesn't impose any structure on this. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @metadata = args[:metadata] if args.key?(:metadata) + 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. + class GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction + include Google::Apis::Core::Hashable + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + 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. + class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff + include Google::Apis::Core::Hashable + + # 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 + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @metadata = args[:metadata] if args.key?(:metadata) + end + 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. + class GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff + include Google::Apis::Core::Hashable + + # 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 + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @metadata = args[:metadata] if args.key?(:metadata) + 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. + class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio + include Google::Apis::Core::Hashable + + # Segments this audio response is composed of. + # Corresponds to the JSON property `segments` + # @return [Array] + attr_accessor :segments + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @segments = args[:segments] if args.key?(:segments) + end + end + + # Represents one segment of audio. + class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment + include Google::Apis::Core::Hashable + + # Output only. 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. + # 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. + # 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) + @allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption) + @audio = args[:audio] if args.key?(:audio) + @uri = args[:uri] if args.key?(:uri) + end + end + + # A text or ssml response that is preferentially used for TTS output audio + # synthesis, as described in the comment on the ResponseMessage message. + class GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText + include Google::Apis::Core::Hashable + + # 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 + + # The raw text to be synthesized. + # Corresponds to the JSON property `text` + # @return [String] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ssml = args[:ssml] if args.key?(:ssml) + @text = args[:text] if args.key?(:text) + end + end + + # Specifies an audio clip to be played by the client as part of the response. + class GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio + include Google::Apis::Core::Hashable + + # Output only. Whether the playback of this message can be interrupted by the + # end user's speech and the client can then starts the next Dialogflow request. + # Corresponds to the JSON property `allowPlaybackInterruption` + # @return [Boolean] + attr_accessor :allow_playback_interruption + alias_method :allow_playback_interruption?, :allow_playback_interruption + + # Required. URI of the audio clip. Dialogflow does not impose any validation on + # this value. It is specific to the client that reads it. + # Corresponds to the JSON property `audioUri` + # @return [String] + attr_accessor :audio_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption) + @audio_uri = args[:audio_uri] if args.key?(:audio_uri) + end + end + + # The text response message. + class GoogleCloudDialogflowCxV3beta1ResponseMessageText + include Google::Apis::Core::Hashable + + # Output only. Whether the playback of this message can be interrupted by the + # end user's speech and the client can then starts the next Dialogflow request. + # Corresponds to the JSON property `allowPlaybackInterruption` + # @return [Boolean] + attr_accessor :allow_playback_interruption + alias_method :allow_playback_interruption?, :allow_playback_interruption + + # Required. A collection of text responses. + # Corresponds to the JSON property `text` + # @return [Array] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @allow_playback_interruption = args[:allow_playback_interruption] if args.key?(:allow_playback_interruption) + @text = args[:text] if args.key?(:text) + end + end + + # Represents session information communicated to and from the webhook. + 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. + # 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/`. + # Corresponds to the JSON property `session` + # @return [String] + attr_accessor :session + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @parameters = args[:parameters] if args.key?(:parameters) + @session = args[:session] if args.key?(:session) + end + end + + # The request message for a webhook call. + class GoogleCloudDialogflowCxV3beta1WebhookRequest + include Google::Apis::Core::Hashable + + # 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 + + # Represents fulfillment information communicated to the webhook. + # Corresponds to the JSON property `fulfillmentInfo` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo] + attr_accessor :fulfillment_info + + # Represents intent information communicated to the webhook. + # Corresponds to the JSON property `intentInfo` + # @return [Google::Apis::DialogflowV3beta1::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; + # Corresponds to the JSON property `messages` + # @return [Array] + attr_accessor :messages + + # Represents page information communicated to and from the webhook. + # Corresponds to the JSON property `pageInfo` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PageInfo] + attr_accessor :page_info + + # Custom data set in QueryParameters.payload. + # Corresponds to the JSON property `payload` + # @return [Hash] + attr_accessor :payload + + # Represents session information communicated to and from the webhook. + # Corresponds to the JSON property `sessionInfo` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionInfo] + attr_accessor :session_info + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @detect_intent_response_id = args[:detect_intent_response_id] if args.key?(:detect_intent_response_id) + @fulfillment_info = args[:fulfillment_info] if args.key?(:fulfillment_info) + @intent_info = args[:intent_info] if args.key?(:intent_info) + @messages = args[:messages] if args.key?(:messages) + @page_info = args[:page_info] if args.key?(:page_info) + @payload = args[:payload] if args.key?(:payload) + @session_info = args[:session_info] if args.key?(:session_info) + end + end + + # Represents fulfillment information communicated to the webhook. + class GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo + include Google::Apis::Core::Hashable + + # Always present. The tag used to identify which fulfillment is being called. + # Corresponds to the JSON property `tag` + # @return [String] + attr_accessor :tag + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @tag = args[:tag] if args.key?(:tag) + end + end + + # Represents intent information communicated to the webhook. + class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo + include Google::Apis::Core::Hashable + + # 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. + # Corresponds to the JSON property `parameters` + # @return [Hash] + attr_accessor :parameters + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @last_matched_intent = args[:last_matched_intent] if args.key?(:last_matched_intent) + @parameters = args[:parameters] if args.key?(:parameters) + end + end + + # Represents a value for an intent parameter. + class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue + include Google::Apis::Core::Hashable + + # Always present. Original text value extracted from user utterance. + # Corresponds to the JSON property `originalValue` + # @return [String] + attr_accessor :original_value + + # Always present. Structured value for the parameter extracted from user + # utterance. + # Corresponds to the JSON property `resolvedValue` + # @return [Object] + attr_accessor :resolved_value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @original_value = args[:original_value] if args.key?(:original_value) + @resolved_value = args[:resolved_value] if args.key?(:resolved_value) + end + end + + # The response message for a webhook call. + class GoogleCloudDialogflowCxV3beta1WebhookResponse + include Google::Apis::Core::Hashable + + # Represents a fulfillment response to the user. + # Corresponds to the JSON property `fulfillmentResponse` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse] + attr_accessor :fulfillment_response + + # Represents page information communicated to and from the webhook. + # Corresponds to the JSON property `pageInfo` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PageInfo] + attr_accessor :page_info + + # Value to append directly to QueryResult.webhook_payloads. + # Corresponds to the JSON property `payload` + # @return [Hash] + attr_accessor :payload + + # Represents session information communicated to and from the webhook. + # Corresponds to the JSON property `sessionInfo` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionInfo] + attr_accessor :session_info + + # 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/`. + # Corresponds to the JSON property `targetPage` + # @return [String] + attr_accessor :target_page + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @fulfillment_response = args[:fulfillment_response] if args.key?(:fulfillment_response) + @page_info = args[:page_info] if args.key?(:page_info) + @payload = args[:payload] if args.key?(:payload) + @session_info = args[:session_info] if args.key?(:session_info) + @target_flow = args[:target_flow] if args.key?(:target_flow) + @target_page = args[:target_page] if args.key?(:target_page) + end + end + + # Represents a fulfillment response to the user. + class GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse + include Google::Apis::Core::Hashable + + # Merge behavior for `messages`. + # Corresponds to the JSON property `mergeBehavior` + # @return [String] + attr_accessor :merge_behavior + + # The list of rich message responses to present to the user. + # Corresponds to the JSON property `messages` + # @return [Array] + attr_accessor :messages + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @merge_behavior = args[:merge_behavior] if args.key?(:merge_behavior) + @messages = args[:messages] if args.key?(:messages) + 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. + 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. + # 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" ` + # Corresponds to the JSON property `formattedValue` + # @return [Object] + attr_accessor :formatted_value + + # A part of a message possibly annotated with an entity. + # Corresponds to the JSON property `text` + # @return [String] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entity_type = args[:entity_type] if args.key?(:entity_type) + @formatted_value = args[:formatted_value] if args.key?(:formatted_value) + @text = args[:text] if args.key?(:text) + end + end + + # The response message for EntityTypes.BatchUpdateEntityTypes. + class GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse + include Google::Apis::Core::Hashable + + # The collection of updated or created entity types. + # Corresponds to the JSON property `entityTypes` + # @return [Array] + attr_accessor :entity_types + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entity_types = args[:entity_types] if args.key?(:entity_types) + end + end + + # The response message for Intents.BatchUpdateIntents. + class GoogleCloudDialogflowV2BatchUpdateIntentsResponse + include Google::Apis::Core::Hashable + + # The collection of updated or created intents. + # Corresponds to the JSON property `intents` + # @return [Array] + attr_accessor :intents + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @intents = args[:intents] if args.key?(:intents) + end + end + + # 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, + # 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). + 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. + # 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` + # 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 + # Corresponds to the JSON property `parameters` + # @return [Hash] + attr_accessor :parameters + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @lifespan_count = args[:lifespan_count] if args.key?(:lifespan_count) + @name = args[:name] if args.key?(:name) + @parameters = args[:parameters] if args.key?(:parameters) + end + end + + # Represents a notification sent to Pub/Sub subscribers for conversation + # lifecycle events. + class GoogleCloudDialogflowV2ConversationEvent + include Google::Apis::Core::Hashable + + # 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). + # Corresponds to the JSON property `errorStatus` + # @return [Google::Apis::DialogflowV3beta1::GoogleRpcStatus] + attr_accessor :error_status + + # Represents a message posted into a conversation. + # Corresponds to the JSON property `newMessagePayload` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2Message] + attr_accessor :new_message_payload + + # The type of the event that this notification refers to. + # 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) + @conversation = args[:conversation] if args.key?(:conversation) + @error_status = args[:error_status] if args.key?(:error_status) + @new_message_payload = args[:new_message_payload] if args.key?(:new_message_payload) + @type = args[:type] if args.key?(:type) + end + 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). + class GoogleCloudDialogflowV2EntityType + include Google::Apis::Core::Hashable + + # Optional. Indicates whether the entity type can be automatically expanded. + # Corresponds to the JSON property `autoExpansionMode` + # @return [String] + attr_accessor :auto_expansion_mode + + # Required. The name of the entity type. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Optional. Enables fuzzy entity extraction during classification. + # Corresponds to the JSON property `enableFuzzyExtraction` + # @return [Boolean] + attr_accessor :enable_fuzzy_extraction + alias_method :enable_fuzzy_extraction?, :enable_fuzzy_extraction + + # Optional. The collection of entity entries associated with the entity type. + # Corresponds to the JSON property `entities` + # @return [Array] + attr_accessor :entities + + # Required. Indicates the kind of entity type. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # 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 + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @auto_expansion_mode = args[:auto_expansion_mode] if args.key?(:auto_expansion_mode) + @display_name = args[:display_name] if args.key?(:display_name) + @enable_fuzzy_extraction = args[:enable_fuzzy_extraction] if args.key?(:enable_fuzzy_extraction) + @entities = args[:entities] if args.key?(:entities) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # An **entity entry** for an associated entity type. + 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`. + # 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). + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @synonyms = args[:synonyms] if args.key?(:synonyms) + @value = args[:value] if args.key?(:value) + end + 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?"`. + 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. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # Required. The unique identifier of the event. + # Corresponds to the JSON property `name` + # @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 + # Corresponds to the JSON property `parameters` + # @return [Hash] + attr_accessor :parameters + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @language_code = args[:language_code] if args.key?(:language_code) + @name = args[:name] if args.key?(:name) + @parameters = args[:parameters] if args.key?(:parameters) + end + end + + # The response message for Agents.ExportAgent. + class GoogleCloudDialogflowV2ExportAgentResponse + include Google::Apis::Core::Hashable + + # Zip compressed raw byte content for agent. + # Corresponds to the JSON property `agentContent` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @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`. + # Corresponds to the JSON property `agentUri` + # @return [String] + attr_accessor :agent_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @agent_content = args[:agent_content] if args.key?(:agent_content) + @agent_uri = args[:agent_uri] if args.key?(:agent_uri) + end + end + + # An intent categorizes an end-user's intention for one conversation turn. For + # each agent, you define many intents, where your combined intents can handle a + # 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). + 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. + # 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). + # Corresponds to the JSON property `defaultResponsePlatforms` + # @return [Array] + attr_accessor :default_response_platforms + + # Required. The name of this intent. + # Corresponds to the JSON property `displayName` + # @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. + # 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. + # 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/`. + # Corresponds to the JSON property `inputContextNames` + # @return [Array] + attr_accessor :input_context_names + + # Optional. Indicates whether this is a fallback intent. + # Corresponds to the JSON property `isFallback` + # @return [Boolean] + 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. + # 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. + # 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/`. + # 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/`. + # Corresponds to the JSON property `outputContexts` + # @return [Array] + attr_accessor :output_contexts + + # Optional. The collection of parameters associated with the intent. + # Corresponds to the JSON property `parameters` + # @return [Array] + 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/`. + # 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. + # 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. + # 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/`. + # 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. + # Corresponds to the JSON property `trainingPhrases` + # @return [Array] + attr_accessor :training_phrases + + # Optional. Indicates whether webhooks are enabled for the intent. + # Corresponds to the JSON property `webhookState` + # @return [String] + attr_accessor :webhook_state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action = args[:action] if args.key?(:action) + @default_response_platforms = args[:default_response_platforms] if args.key?(:default_response_platforms) + @display_name = args[:display_name] if args.key?(:display_name) + @events = args[:events] if args.key?(:events) + @followup_intent_info = args[:followup_intent_info] if args.key?(:followup_intent_info) + @input_context_names = args[:input_context_names] if args.key?(:input_context_names) + @is_fallback = args[:is_fallback] if args.key?(:is_fallback) + @messages = args[:messages] if args.key?(:messages) + @ml_disabled = args[:ml_disabled] if args.key?(:ml_disabled) + @name = args[:name] if args.key?(:name) + @output_contexts = args[:output_contexts] if args.key?(:output_contexts) + @parameters = args[:parameters] if args.key?(:parameters) + @parent_followup_intent_name = args[:parent_followup_intent_name] if args.key?(:parent_followup_intent_name) + @priority = args[:priority] if args.key?(:priority) + @reset_contexts = args[:reset_contexts] if args.key?(:reset_contexts) + @root_followup_intent_name = args[:root_followup_intent_name] if args.key?(:root_followup_intent_name) + @training_phrases = args[:training_phrases] if args.key?(:training_phrases) + @webhook_state = args[:webhook_state] if args.key?(:webhook_state) + end + end + + # Represents a single followup intent in the chain. + class GoogleCloudDialogflowV2IntentFollowupIntentInfo + include Google::Apis::Core::Hashable + + # 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/`. + # Corresponds to the JSON property `parentFollowupIntentName` + # @return [String] + attr_accessor :parent_followup_intent_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @followup_intent_name = args[:followup_intent_name] if args.key?(:followup_intent_name) + @parent_followup_intent_name = args[:parent_followup_intent_name] if args.key?(:parent_followup_intent_name) + 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). + class GoogleCloudDialogflowV2IntentMessage + include Google::Apis::Core::Hashable + + # The basic card message. Useful for displaying information. + # Corresponds to the JSON property `basicCard` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBasicCard] + attr_accessor :basic_card + + # 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::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard] + attr_accessor :browse_carousel_card + + # The card response message. + # Corresponds to the JSON property `card` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageCard] + attr_accessor :card + + # The card for presenting a carousel of options to select from. + # Corresponds to the JSON property `carouselSelect` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageCarouselSelect] + attr_accessor :carousel_select + + # The image response message. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage] + attr_accessor :image + + # 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::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion] + attr_accessor :link_out_suggestion + + # The card for presenting a list of options to select from. + # Corresponds to the JSON property `listSelect` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageListSelect] + attr_accessor :list_select + + # The media content card for Actions on Google. + # Corresponds to the JSON property `mediaContent` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageMediaContent] + attr_accessor :media_content + + # A custom platform-specific response. + # Corresponds to the JSON property `payload` + # @return [Hash] + attr_accessor :payload + + # Optional. The platform that this message is intended for. + # Corresponds to the JSON property `platform` + # @return [String] + attr_accessor :platform + + # The quick replies response message. + # Corresponds to the JSON property `quickReplies` + # @return [Google::Apis::DialogflowV3beta1::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`. + # Corresponds to the JSON property `simpleResponses` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageSimpleResponses] + attr_accessor :simple_responses + + # The collection of suggestions. + # Corresponds to the JSON property `suggestions` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageSuggestions] + attr_accessor :suggestions + + # Table card for Actions on Google. + # Corresponds to the JSON property `tableCard` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageTableCard] + attr_accessor :table_card + + # The text response message. + # Corresponds to the JSON property `text` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageText] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @basic_card = args[:basic_card] if args.key?(:basic_card) + @browse_carousel_card = args[:browse_carousel_card] if args.key?(:browse_carousel_card) + @card = args[:card] if args.key?(:card) + @carousel_select = args[:carousel_select] if args.key?(:carousel_select) + @image = args[:image] if args.key?(:image) + @link_out_suggestion = args[:link_out_suggestion] if args.key?(:link_out_suggestion) + @list_select = args[:list_select] if args.key?(:list_select) + @media_content = args[:media_content] if args.key?(:media_content) + @payload = args[:payload] if args.key?(:payload) + @platform = args[:platform] if args.key?(:platform) + @quick_replies = args[:quick_replies] if args.key?(:quick_replies) + @simple_responses = args[:simple_responses] if args.key?(:simple_responses) + @suggestions = args[:suggestions] if args.key?(:suggestions) + @table_card = args[:table_card] if args.key?(:table_card) + @text = args[:text] if args.key?(:text) + end + end + + # The basic card message. Useful for displaying information. + class GoogleCloudDialogflowV2IntentMessageBasicCard + include Google::Apis::Core::Hashable + + # Optional. The collection of card buttons. + # Corresponds to the JSON property `buttons` + # @return [Array] + attr_accessor :buttons + + # Required, unless image is present. The body text of the card. + # Corresponds to the JSON property `formattedText` + # @return [String] + attr_accessor :formatted_text + + # The image response message. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage] + attr_accessor :image + + # Optional. The subtitle of the card. + # Corresponds to the JSON property `subtitle` + # @return [String] + attr_accessor :subtitle + + # Optional. The title of the card. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @buttons = args[:buttons] if args.key?(:buttons) + @formatted_text = args[:formatted_text] if args.key?(:formatted_text) + @image = args[:image] if args.key?(:image) + @subtitle = args[:subtitle] if args.key?(:subtitle) + @title = args[:title] if args.key?(:title) + end + end + + # The button object that appears at the bottom of a card. + class GoogleCloudDialogflowV2IntentMessageBasicCardButton + include Google::Apis::Core::Hashable + + # Opens the given URI. + # Corresponds to the JSON property `openUriAction` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction] + attr_accessor :open_uri_action + + # Required. The title of the button. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @open_uri_action = args[:open_uri_action] if args.key?(:open_uri_action) + @title = args[:title] if args.key?(:title) + end + end + + # Opens the given URI. + class GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction + include Google::Apis::Core::Hashable + + # Required. The HTTP or HTTPS scheme URI. + # 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) + @uri = args[:uri] if args.key?(:uri) + end + end + + # 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. + # 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. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @image_display_options = args[:image_display_options] if args.key?(:image_display_options) + @items = args[:items] if args.key?(:items) + end + end + + # Browsing carousel tile + class GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem + include Google::Apis::Core::Hashable + + # 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. + # Corresponds to the JSON property `footer` + # @return [String] + attr_accessor :footer + + # The image response message. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage] + attr_accessor :image + + # Actions on Google action to open a given url. + # Corresponds to the JSON property `openUriAction` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction] + attr_accessor :open_uri_action + + # Required. Title of the carousel item. Maximum of two lines of text. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @footer = args[:footer] if args.key?(:footer) + @image = args[:image] if args.key?(:image) + @open_uri_action = args[:open_uri_action] if args.key?(:open_uri_action) + @title = args[:title] if args.key?(:title) + end + end + + # Actions on Google action to open a given url. + class GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction + include Google::Apis::Core::Hashable + + # Required. URL + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + # 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 + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @url = args[:url] if args.key?(:url) + @url_type_hint = args[:url_type_hint] if args.key?(:url_type_hint) + end + end + + # The card response message. + class GoogleCloudDialogflowV2IntentMessageCard + include Google::Apis::Core::Hashable + + # Optional. The collection of card buttons. + # Corresponds to the JSON property `buttons` + # @return [Array] + attr_accessor :buttons + + # Optional. The public URI to an image file for the card. + # Corresponds to the JSON property `imageUri` + # @return [String] + attr_accessor :image_uri + + # Optional. The subtitle of the card. + # Corresponds to the JSON property `subtitle` + # @return [String] + attr_accessor :subtitle + + # Optional. The title of the card. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @buttons = args[:buttons] if args.key?(:buttons) + @image_uri = args[:image_uri] if args.key?(:image_uri) + @subtitle = args[:subtitle] if args.key?(:subtitle) + @title = args[:title] if args.key?(:title) + end + end + + # Contains information about a button. + class GoogleCloudDialogflowV2IntentMessageCardButton + include Google::Apis::Core::Hashable + + # 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 + + # Optional. The text to show on the button. + # Corresponds to the JSON property `text` + # @return [String] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @postback = args[:postback] if args.key?(:postback) + @text = args[:text] if args.key?(:text) + end + end + + # The card for presenting a carousel of options to select from. + class GoogleCloudDialogflowV2IntentMessageCarouselSelect + include Google::Apis::Core::Hashable + + # Required. Carousel items. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @items = args[:items] if args.key?(:items) + end + end + + # An item in the carousel. + class GoogleCloudDialogflowV2IntentMessageCarouselSelectItem + include Google::Apis::Core::Hashable + + # Optional. The body text of the card. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The image response message. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage] + attr_accessor :image + + # Additional info about the select item for when it is triggered in a dialog. + # Corresponds to the JSON property `info` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageSelectItemInfo] + attr_accessor :info + + # Required. Title of the carousel item. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @image = args[:image] if args.key?(:image) + @info = args[:info] if args.key?(:info) + @title = args[:title] if args.key?(:title) + end + end + + # Column properties for TableCard. + class GoogleCloudDialogflowV2IntentMessageColumnProperties + include Google::Apis::Core::Hashable + + # Required. Column heading. + # Corresponds to the JSON property `header` + # @return [String] + attr_accessor :header + + # Optional. Defines text alignment for all cells in this column. + # Corresponds to the JSON property `horizontalAlignment` + # @return [String] + attr_accessor :horizontal_alignment + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @header = args[:header] if args.key?(:header) + @horizontal_alignment = args[:horizontal_alignment] if args.key?(:horizontal_alignment) + end + end + + # The image response message. + class GoogleCloudDialogflowV2IntentMessageImage + include Google::Apis::Core::Hashable + + # 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 + + # Optional. The public URI to an image file. + # Corresponds to the JSON property `imageUri` + # @return [String] + attr_accessor :image_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @accessibility_text = args[:accessibility_text] if args.key?(:accessibility_text) + @image_uri = args[:image_uri] if args.key?(:image_uri) + end + end + + # 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 + + # Required. The name of the app or site this chip is linking to. + # Corresponds to the JSON property `destinationName` + # @return [String] + attr_accessor :destination_name + + # 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 + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @destination_name = args[:destination_name] if args.key?(:destination_name) + @uri = args[:uri] if args.key?(:uri) + end + end + + # The card for presenting a list of options to select from. + class GoogleCloudDialogflowV2IntentMessageListSelect + include Google::Apis::Core::Hashable + + # Required. List items. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # Optional. Subtitle of the list. + # Corresponds to the JSON property `subtitle` + # @return [String] + attr_accessor :subtitle + + # Optional. The overall title of the list. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @items = args[:items] if args.key?(:items) + @subtitle = args[:subtitle] if args.key?(:subtitle) + @title = args[:title] if args.key?(:title) + end + end + + # An item in the list. + class GoogleCloudDialogflowV2IntentMessageListSelectItem + include Google::Apis::Core::Hashable + + # Optional. The main text describing the item. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The image response message. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage] + attr_accessor :image + + # Additional info about the select item for when it is triggered in a dialog. + # Corresponds to the JSON property `info` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageSelectItemInfo] + attr_accessor :info + + # Required. The title of the list item. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @image = args[:image] if args.key?(:image) + @info = args[:info] if args.key?(:info) + @title = args[:title] if args.key?(:title) + end + end + + # The media content card for Actions on Google. + class GoogleCloudDialogflowV2IntentMessageMediaContent + include Google::Apis::Core::Hashable + + # Required. List of media objects. + # Corresponds to the JSON property `mediaObjects` + # @return [Array] + attr_accessor :media_objects + + # Optional. What type of media is the content (ie "audio"). + # Corresponds to the JSON property `mediaType` + # @return [String] + attr_accessor :media_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @media_objects = args[:media_objects] if args.key?(:media_objects) + @media_type = args[:media_type] if args.key?(:media_type) + end + end + + # Response media object for media content card. + class GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject + include Google::Apis::Core::Hashable + + # Required. Url where the media is stored. + # Corresponds to the JSON property `contentUrl` + # @return [String] + attr_accessor :content_url + + # Optional. Description of media card. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The image response message. + # Corresponds to the JSON property `icon` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage] + attr_accessor :icon + + # The image response message. + # Corresponds to the JSON property `largeImage` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage] + attr_accessor :large_image + + # Required. Name of media card. + # 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) + @content_url = args[:content_url] if args.key?(:content_url) + @description = args[:description] if args.key?(:description) + @icon = args[:icon] if args.key?(:icon) + @large_image = args[:large_image] if args.key?(:large_image) + @name = args[:name] if args.key?(:name) + end + end + + # The quick replies response message. + class GoogleCloudDialogflowV2IntentMessageQuickReplies + include Google::Apis::Core::Hashable + + # Optional. The collection of quick replies. + # Corresponds to the JSON property `quickReplies` + # @return [Array] + attr_accessor :quick_replies + + # Optional. The title of the collection of quick replies. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @quick_replies = args[:quick_replies] if args.key?(:quick_replies) + @title = args[:title] if args.key?(:title) + end + end + + # 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. + # 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. + # Corresponds to the JSON property `synonyms` + # @return [Array] + attr_accessor :synonyms + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @key = args[:key] if args.key?(:key) + @synonyms = args[:synonyms] if args.key?(:synonyms) + end + end + + # The simple response message containing speech or text. + class GoogleCloudDialogflowV2IntentMessageSimpleResponse + include Google::Apis::Core::Hashable + + # Optional. The text to display. + # Corresponds to the JSON property `displayText` + # @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. + # 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. + # Corresponds to the JSON property `textToSpeech` + # @return [String] + attr_accessor :text_to_speech + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_text = args[:display_text] if args.key?(:display_text) + @ssml = args[:ssml] if args.key?(:ssml) + @text_to_speech = args[:text_to_speech] if args.key?(:text_to_speech) + end + end + + # 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 + + # Required. The list of simple responses. + # Corresponds to the JSON property `simpleResponses` + # @return [Array] + attr_accessor :simple_responses + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @simple_responses = args[:simple_responses] if args.key?(:simple_responses) + end + end + + # The suggestion chip message that the user can tap to quickly post a reply to + # the conversation. + class GoogleCloudDialogflowV2IntentMessageSuggestion + include Google::Apis::Core::Hashable + + # Required. The text shown the in the suggestion chip. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @title = args[:title] if args.key?(:title) + end + end + + # The collection of suggestions. + class GoogleCloudDialogflowV2IntentMessageSuggestions + include Google::Apis::Core::Hashable + + # Required. The list of suggested replies. + # Corresponds to the JSON property `suggestions` + # @return [Array] + attr_accessor :suggestions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @suggestions = args[:suggestions] if args.key?(:suggestions) + end + end + + # Table card for Actions on Google. + class GoogleCloudDialogflowV2IntentMessageTableCard + include Google::Apis::Core::Hashable + + # Optional. List of buttons for the card. + # Corresponds to the JSON property `buttons` + # @return [Array] + attr_accessor :buttons + + # Optional. Display properties for the columns in this table. + # Corresponds to the JSON property `columnProperties` + # @return [Array] + attr_accessor :column_properties + + # The image response message. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage] + attr_accessor :image + + # Optional. Rows in this table of data. + # Corresponds to the JSON property `rows` + # @return [Array] + attr_accessor :rows + + # Optional. Subtitle to the title. + # Corresponds to the JSON property `subtitle` + # @return [String] + attr_accessor :subtitle + + # Required. Title of the card. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @buttons = args[:buttons] if args.key?(:buttons) + @column_properties = args[:column_properties] if args.key?(:column_properties) + @image = args[:image] if args.key?(:image) + @rows = args[:rows] if args.key?(:rows) + @subtitle = args[:subtitle] if args.key?(:subtitle) + @title = args[:title] if args.key?(:title) + end + end + + # Cell of TableCardRow. + class GoogleCloudDialogflowV2IntentMessageTableCardCell + include Google::Apis::Core::Hashable + + # Required. Text in this cell. + # Corresponds to the JSON property `text` + # @return [String] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @text = args[:text] if args.key?(:text) + end + end + + # Row of TableCard. + class GoogleCloudDialogflowV2IntentMessageTableCardRow + include Google::Apis::Core::Hashable + + # Optional. List of cells that make up this row. + # Corresponds to the JSON property `cells` + # @return [Array] + attr_accessor :cells + + # Optional. Whether to add a visual divider after this row. + # Corresponds to the JSON property `dividerAfter` + # @return [Boolean] + attr_accessor :divider_after + alias_method :divider_after?, :divider_after + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cells = args[:cells] if args.key?(:cells) + @divider_after = args[:divider_after] if args.key?(:divider_after) + end + end + + # The text response message. + class GoogleCloudDialogflowV2IntentMessageText + include Google::Apis::Core::Hashable + + # Optional. The collection of the agent's responses. + # Corresponds to the JSON property `text` + # @return [Array] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @text = args[:text] if args.key?(:text) + end + end + + # Represents intent parameters. + 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`. + # Corresponds to the JSON property `defaultValue` + # @return [String] + attr_accessor :default_value + + # Required. The name of the parameter. + # Corresponds to the JSON property `displayName` + # @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. + # Corresponds to the JSON property `entityTypeDisplayName` + # @return [String] + attr_accessor :entity_type_display_name + + # Optional. Indicates whether the parameter represents a list of values. + # Corresponds to the JSON property `isList` + # @return [Boolean] + 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. + # Corresponds to the JSON property `mandatory` + # @return [Boolean] + attr_accessor :mandatory + alias_method :mandatory?, :mandatory + + # The unique identifier of this parameter. + # Corresponds to the JSON property `name` + # @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. + # 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`. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @default_value = args[:default_value] if args.key?(:default_value) + @display_name = args[:display_name] if args.key?(:display_name) + @entity_type_display_name = args[:entity_type_display_name] if args.key?(:entity_type_display_name) + @is_list = args[:is_list] if args.key?(:is_list) + @mandatory = args[:mandatory] if args.key?(:mandatory) + @name = args[:name] if args.key?(:name) + @prompts = args[:prompts] if args.key?(:prompts) + @value = args[:value] if args.key?(:value) + end + end + + # Represents an example that the agent is trained on. + class GoogleCloudDialogflowV2IntentTrainingPhrase + include Google::Apis::Core::Hashable + + # Output only. The unique identifier of this training phrase. + # Corresponds to the JSON property `name` + # @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. + # 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. + # Corresponds to the JSON property `timesAddedCount` + # @return [Fixnum] + attr_accessor :times_added_count + + # Required. The type of the training phrase. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @parts = args[:parts] if args.key?(:parts) + @times_added_count = args[:times_added_count] if args.key?(:times_added_count) + @type = args[:type] if args.key?(:type) + end + end + + # Represents a part of a training phrase. + 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. + # 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. + # Corresponds to the JSON property `entityType` + # @return [String] + attr_accessor :entity_type + + # Required. The text for this part. + # Corresponds to the JSON property `text` + # @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. + # Corresponds to the JSON property `userDefined` + # @return [Boolean] + attr_accessor :user_defined + alias_method :user_defined?, :user_defined + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @alias = args[:alias] if args.key?(:alias) + @entity_type = args[:entity_type] if args.key?(:entity_type) + @text = args[:text] if args.key?(:text) + @user_defined = args[:user_defined] if args.key?(:user_defined) + end + end + + # Represents a message posted into a conversation. + class GoogleCloudDialogflowV2Message + include Google::Apis::Core::Hashable + + # Required. The message content. + # Corresponds to the JSON property `content` + # @return [String] + attr_accessor :content + + # Output only. The time when the message was created. + # Corresponds to the JSON property `createTime` + # @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". + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # Represents the result of annotation for the message. + # Corresponds to the JSON property `messageAnnotation` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2MessageAnnotation] + attr_accessor :message_annotation + + # The unique identifier of the message. Format: `projects//conversations// + # messages/`. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # Output only. The participant that sends this message. + # Corresponds to the JSON property `participant` + # @return [String] + attr_accessor :participant + + # Output only. The role of the participant. + # Corresponds to the JSON property `participantRole` + # @return [String] + attr_accessor :participant_role + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @content = args[:content] if args.key?(:content) + @create_time = args[:create_time] if args.key?(:create_time) + @language_code = args[:language_code] if args.key?(:language_code) + @message_annotation = args[:message_annotation] if args.key?(:message_annotation) + @name = args[:name] if args.key?(:name) + @participant = args[:participant] if args.key?(:participant) + @participant_role = args[:participant_role] if args.key?(:participant_role) + end + end + + # Represents the result of annotation for the message. + class GoogleCloudDialogflowV2MessageAnnotation + include Google::Apis::Core::Hashable + + # Indicates whether the text message contains entities. + # Corresponds to the JSON property `containEntities` + # @return [Boolean] + 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]. + # Corresponds to the JSON property `parts` + # @return [Array] + attr_accessor :parts + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @contain_entities = args[:contain_entities] if args.key?(:contain_entities) + @parts = args[:parts] if args.key?(:parts) + end + end + + # 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. + # 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. + # 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. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @payload = args[:payload] if args.key?(:payload) + @source = args[:source] if args.key?(:source) + @version = args[:version] if args.key?(:version) + end + end + + # Represents the result of conversational query or event processing. + class GoogleCloudDialogflowV2QueryResult + include Google::Apis::Core::Hashable + + # The action name from the matched intent. + # Corresponds to the JSON property `action` + # @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. + # 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 + # Corresponds to the JSON property `diagnosticInfo` + # @return [Hash] + attr_accessor :diagnostic_info + + # The collection of rich messages to present to the user. + # Corresponds to the JSON property `fulfillmentMessages` + # @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. + # Corresponds to the JSON property `fulfillmentText` + # @return [String] + attr_accessor :fulfillment_text + + # An intent categorizes an end-user's intention for one conversation turn. For + # each agent, you define many intents, where your combined intents can handle a + # 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). + # Corresponds to the JSON property `intent` + # @return [Google::Apis::DialogflowV3beta1::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. + # 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. + # 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. + # 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. + # 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 + # 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. + # 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 Participants.StreamingAnalyzeContent, it needs to be configured in + # ConversationProfile.human_agent_assistant_config + # Corresponds to the JSON property `sentimentAnalysisResult` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2SentimentAnalysisResult] + attr_accessor :sentiment_analysis_result + + # 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 + # 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. + # 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. + # Corresponds to the JSON property `webhookSource` + # @return [String] + attr_accessor :webhook_source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action = args[:action] if args.key?(:action) + @all_required_params_present = args[:all_required_params_present] if args.key?(:all_required_params_present) + @diagnostic_info = args[:diagnostic_info] if args.key?(:diagnostic_info) + @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages) + @fulfillment_text = args[:fulfillment_text] if args.key?(:fulfillment_text) + @intent = args[:intent] if args.key?(:intent) + @intent_detection_confidence = args[:intent_detection_confidence] if args.key?(:intent_detection_confidence) + @language_code = args[:language_code] if args.key?(:language_code) + @output_contexts = args[:output_contexts] if args.key?(:output_contexts) + @parameters = args[:parameters] if args.key?(:parameters) + @query_text = args[:query_text] if args.key?(:query_text) + @sentiment_analysis_result = args[:sentiment_analysis_result] if args.key?(:sentiment_analysis_result) + @speech_recognition_confidence = args[:speech_recognition_confidence] if args.key?(:speech_recognition_confidence) + @webhook_payload = args[:webhook_payload] if args.key?(:webhook_payload) + @webhook_source = args[:webhook_source] if args.key?(:webhook_source) + end + end + + # 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 + + # A non-negative number in the [0, +inf) range, which represents the absolute + # magnitude of sentiment, regardless of score (positive or negative). + # Corresponds to the JSON property `magnitude` + # @return [Float] + attr_accessor :magnitude + + # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). + # Corresponds to the JSON property `score` + # @return [Float] + attr_accessor :score + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @magnitude = args[:magnitude] if args.key?(:magnitude) + @score = args[:score] if args.key?(:score) + 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 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. + # Corresponds to the JSON property `queryTextSentiment` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2Sentiment] + attr_accessor :query_text_sentiment + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @query_text_sentiment = args[:query_text_sentiment] if args.key?(:query_text_sentiment) + 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). + class GoogleCloudDialogflowV2SessionEntityType + include Google::Apis::Core::Hashable + + # 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. + # 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. + # 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) + @entities = args[:entities] if args.key?(:entities) + @entity_override_mode = args[:entity_override_mode] if args.key?(:entity_override_mode) + @name = args[:name] if args.key?(:name) + end + end + + # The request message for a webhook call. + class GoogleCloudDialogflowV2WebhookRequest + include Google::Apis::Core::Hashable + + # Represents the contents of the original request that was passed to the `[ + # Streaming]DetectIntent` call. + # Corresponds to the JSON property `originalDetectIntentRequest` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2OriginalDetectIntentRequest] + attr_accessor :original_detect_intent_request + + # Represents the result of conversational query or event processing. + # Corresponds to the JSON property `queryResult` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2QueryResult] + attr_accessor :query_result + + # 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/`. + # Corresponds to the JSON property `session` + # @return [String] + attr_accessor :session + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @original_detect_intent_request = args[:original_detect_intent_request] if args.key?(:original_detect_intent_request) + @query_result = args[:query_result] if args.key?(:query_result) + @response_id = args[:response_id] if args.key?(:response_id) + @session = args[:session] if args.key?(:session) + 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). + 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?"`. + # Corresponds to the JSON property `followupEventInput` + # @return [Google::Apis::DialogflowV3beta1::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. + # 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. + # 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. + # 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) + # 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. + # 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 + # QueryResult.webhook_source sent to the integration or API caller. + # Corresponds to the JSON property `source` + # @return [String] + attr_accessor :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @followup_event_input = args[:followup_event_input] if args.key?(:followup_event_input) + @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages) + @fulfillment_text = args[:fulfillment_text] if args.key?(:fulfillment_text) + @output_contexts = args[:output_contexts] if args.key?(:output_contexts) + @payload = args[:payload] if args.key?(:payload) + @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types) + @source = args[:source] if args.key?(:source) + 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. + class GoogleCloudDialogflowV2beta1AnnotatedConversationDataset + include Google::Apis::Core::Hashable + + # Output only. Number of examples that have annotations in the annotated + # conversation dataset. + # Corresponds to the JSON property `completedExampleCount` + # @return [Fixnum] + attr_accessor :completed_example_count + + # Output only. Creation time of this annotated conversation dataset. + # Corresponds to the JSON property `createTime` + # @return [String] + attr_accessor :create_time + + # 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. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Output only. Number of examples in the annotated conversation dataset. + # Corresponds to the JSON property `exampleCount` + # @return [Fixnum] + attr_accessor :example_count + + # 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. + # Corresponds to the JSON property `questionTypeName` + # @return [String] + attr_accessor :question_type_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @completed_example_count = args[:completed_example_count] if args.key?(:completed_example_count) + @create_time = args[:create_time] if args.key?(:create_time) + @description = args[:description] if args.key?(:description) + @display_name = args[:display_name] if args.key?(:display_name) + @example_count = args[:example_count] if args.key?(:example_count) + @name = args[:name] if args.key?(:name) + @question_type_name = args[:question_type_name] if args.key?(:question_type_name) + end + end + + # Response message for [Documents.AutoApproveSmartMessagingEntries]. + class GoogleCloudDialogflowV2beta1AutoApproveSmartMessagingEntriesResponse + include Google::Apis::Core::Hashable + + # Number of smart messaging entries disabled. + # Corresponds to the JSON property `disabledCount` + # @return [Fixnum] + attr_accessor :disabled_count + + # Number of smart messaging entries enabled. + # Corresponds to the JSON property `enabledCount` + # @return [Fixnum] + attr_accessor :enabled_count + + # Number of smart messaging entries unreviewed. + # Corresponds to the JSON property `unreviewedCount` + # @return [Fixnum] + attr_accessor :unreviewed_count + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @disabled_count = args[:disabled_count] if args.key?(:disabled_count) + @enabled_count = args[:enabled_count] if args.key?(:enabled_count) + @unreviewed_count = args[:unreviewed_count] if args.key?(:unreviewed_count) + end + end + + # The response message for EntityTypes.BatchUpdateEntityTypes. + class GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse + include Google::Apis::Core::Hashable + + # The collection of updated or created entity types. + # Corresponds to the JSON property `entityTypes` + # @return [Array] + attr_accessor :entity_types + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @entity_types = args[:entity_types] if args.key?(:entity_types) + end + end + + # The response message for Intents.BatchUpdateIntents. + class GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse + include Google::Apis::Core::Hashable + + # The collection of updated or created intents. + # Corresponds to the JSON property `intents` + # @return [Array] + attr_accessor :intents + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @intents = args[:intents] if args.key?(:intents) + end + end + + # 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, + # 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). + 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. + # 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` + # 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 + # Corresponds to the JSON property `parameters` + # @return [Hash] + attr_accessor :parameters + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @lifespan_count = args[:lifespan_count] if args.key?(:lifespan_count) + @name = args[:name] if args.key?(:name) + @parameters = args[:parameters] if args.key?(:parameters) + end + 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). + class GoogleCloudDialogflowV2beta1EntityType + include Google::Apis::Core::Hashable + + # Optional. Indicates whether the entity type can be automatically expanded. + # Corresponds to the JSON property `autoExpansionMode` + # @return [String] + attr_accessor :auto_expansion_mode + + # Required. The name of the entity type. + # Corresponds to the JSON property `displayName` + # @return [String] + attr_accessor :display_name + + # Optional. Enables fuzzy entity extraction during classification. + # Corresponds to the JSON property `enableFuzzyExtraction` + # @return [Boolean] + attr_accessor :enable_fuzzy_extraction + alias_method :enable_fuzzy_extraction?, :enable_fuzzy_extraction + + # Optional. The collection of entity entries associated with the entity type. + # Corresponds to the JSON property `entities` + # @return [Array] + attr_accessor :entities + + # Required. Indicates the kind of entity type. + # Corresponds to the JSON property `kind` + # @return [String] + attr_accessor :kind + + # 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 + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @auto_expansion_mode = args[:auto_expansion_mode] if args.key?(:auto_expansion_mode) + @display_name = args[:display_name] if args.key?(:display_name) + @enable_fuzzy_extraction = args[:enable_fuzzy_extraction] if args.key?(:enable_fuzzy_extraction) + @entities = args[:entities] if args.key?(:entities) + @kind = args[:kind] if args.key?(:kind) + @name = args[:name] if args.key?(:name) + end + end + + # An **entity entry** for an associated entity type. + 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`. + # 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). + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @synonyms = args[:synonyms] if args.key?(:synonyms) + @value = args[:value] if args.key?(:value) + end + 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?"`. + 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. + # Corresponds to the JSON property `languageCode` + # @return [String] + attr_accessor :language_code + + # Required. The unique identifier of the event. + # Corresponds to the JSON property `name` + # @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 + # Corresponds to the JSON property `parameters` + # @return [Hash] + attr_accessor :parameters + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @language_code = args[:language_code] if args.key?(:language_code) + @name = args[:name] if args.key?(:name) + @parameters = args[:parameters] if args.key?(:parameters) + end + end + + # The response message for Agents.ExportAgent. + class GoogleCloudDialogflowV2beta1ExportAgentResponse + include Google::Apis::Core::Hashable + + # Zip compressed raw byte content for agent. + # Corresponds to the JSON property `agentContent` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @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`. + # Corresponds to the JSON property `agentUri` + # @return [String] + attr_accessor :agent_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @agent_content = args[:agent_content] if args.key?(:agent_content) + @agent_uri = args[:agent_uri] if args.key?(:agent_uri) + end + end + + # An intent categorizes an end-user's intention for one conversation turn. For + # each agent, you define many intents, where your combined intents can handle a + # 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). + 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. + # 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). + # Corresponds to the JSON property `defaultResponsePlatforms` + # @return [Array] + attr_accessor :default_response_platforms + + # Required. The name of this intent. + # Corresponds to the JSON property `displayName` + # @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. + # 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. + # 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. + # 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/`. + # Corresponds to the JSON property `inputContextNames` + # @return [Array] + attr_accessor :input_context_names + + # Optional. Indicates whether this is a fallback intent. + # Corresponds to the JSON property `isFallback` + # @return [Boolean] + 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. + # 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. + # 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. + # 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/`. + # 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/`. + # Corresponds to the JSON property `outputContexts` + # @return [Array] + attr_accessor :output_contexts + + # Optional. The collection of parameters associated with the intent. + # Corresponds to the JSON property `parameters` + # @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/`. + # 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. + # 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. + # 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/`. + # 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. + # Corresponds to the JSON property `trainingPhrases` + # @return [Array] + attr_accessor :training_phrases + + # Optional. Indicates whether webhooks are enabled for the intent. + # Corresponds to the JSON property `webhookState` + # @return [String] + attr_accessor :webhook_state + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action = args[:action] if args.key?(:action) + @default_response_platforms = args[:default_response_platforms] if args.key?(:default_response_platforms) + @display_name = args[:display_name] if args.key?(:display_name) + @end_interaction = args[:end_interaction] if args.key?(:end_interaction) + @events = args[:events] if args.key?(:events) + @followup_intent_info = args[:followup_intent_info] if args.key?(:followup_intent_info) + @input_context_names = args[:input_context_names] if args.key?(:input_context_names) + @is_fallback = args[:is_fallback] if args.key?(:is_fallback) + @messages = args[:messages] if args.key?(:messages) + @ml_disabled = args[:ml_disabled] if args.key?(:ml_disabled) + @ml_enabled = args[:ml_enabled] if args.key?(:ml_enabled) + @name = args[:name] if args.key?(:name) + @output_contexts = args[:output_contexts] if args.key?(:output_contexts) + @parameters = args[:parameters] if args.key?(:parameters) + @parent_followup_intent_name = args[:parent_followup_intent_name] if args.key?(:parent_followup_intent_name) + @priority = args[:priority] if args.key?(:priority) + @reset_contexts = args[:reset_contexts] if args.key?(:reset_contexts) + @root_followup_intent_name = args[:root_followup_intent_name] if args.key?(:root_followup_intent_name) + @training_phrases = args[:training_phrases] if args.key?(:training_phrases) + @webhook_state = args[:webhook_state] if args.key?(:webhook_state) + end + end + + # Represents a single followup intent in the chain. + class GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo + include Google::Apis::Core::Hashable + + # 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/`. + # Corresponds to the JSON property `parentFollowupIntentName` + # @return [String] + attr_accessor :parent_followup_intent_name + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @followup_intent_name = args[:followup_intent_name] if args.key?(:followup_intent_name) + @parent_followup_intent_name = args[:parent_followup_intent_name] if args.key?(:parent_followup_intent_name) + end + end + + # Corresponds to the `Response` field in the Dialogflow console. + class GoogleCloudDialogflowV2beta1IntentMessage + include Google::Apis::Core::Hashable + + # The basic card message. Useful for displaying information. + # Corresponds to the JSON property `basicCard` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBasicCard] + attr_accessor :basic_card + + # 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::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard] + attr_accessor :browse_carousel_card + + # The card response message. + # Corresponds to the JSON property `card` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageCard] + attr_accessor :card + + # The card for presenting a carousel of options to select from. + # Corresponds to the JSON property `carouselSelect` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect] + attr_accessor :carousel_select + + # The image response message. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage] + attr_accessor :image + + # 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::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion] + attr_accessor :link_out_suggestion + + # The card for presenting a list of options to select from. + # Corresponds to the JSON property `listSelect` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageListSelect] + attr_accessor :list_select + + # The media content card for Actions on Google. + # Corresponds to the JSON property `mediaContent` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageMediaContent] + attr_accessor :media_content + + # A custom platform-specific response. + # Corresponds to the JSON property `payload` + # @return [Hash] + attr_accessor :payload + + # Optional. The platform that this message is intended for. + # Corresponds to the JSON property `platform` + # @return [String] + attr_accessor :platform + + # The quick replies response message. + # Corresponds to the JSON property `quickReplies` + # @return [Google::Apis::DialogflowV3beta1::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. + # Corresponds to the JSON property `rbmCarouselRichCard` + # @return [Google::Apis::DialogflowV3beta1::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. + # Corresponds to the JSON property `rbmStandaloneRichCard` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard] + attr_accessor :rbm_standalone_rich_card + + # Rich Business Messaging (RBM) text response with suggestions. + # Corresponds to the JSON property `rbmText` + # @return [Google::Apis::DialogflowV3beta1::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`. + # Corresponds to the JSON property `simpleResponses` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses] + attr_accessor :simple_responses + + # The collection of suggestions. + # Corresponds to the JSON property `suggestions` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageSuggestions] + attr_accessor :suggestions + + # Table card for Actions on Google. + # Corresponds to the JSON property `tableCard` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTableCard] + attr_accessor :table_card + + # Plays audio from a file in Telephony Gateway. + # Corresponds to the JSON property `telephonyPlayAudio` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio] + 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. + # Corresponds to the JSON property `telephonySynthesizeSpeech` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech] + attr_accessor :telephony_synthesize_speech + + # Transfers the call in Telephony Gateway. + # Corresponds to the JSON property `telephonyTransferCall` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall] + attr_accessor :telephony_transfer_call + + # The text response message. + # Corresponds to the JSON property `text` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageText] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @basic_card = args[:basic_card] if args.key?(:basic_card) + @browse_carousel_card = args[:browse_carousel_card] if args.key?(:browse_carousel_card) + @card = args[:card] if args.key?(:card) + @carousel_select = args[:carousel_select] if args.key?(:carousel_select) + @image = args[:image] if args.key?(:image) + @link_out_suggestion = args[:link_out_suggestion] if args.key?(:link_out_suggestion) + @list_select = args[:list_select] if args.key?(:list_select) + @media_content = args[:media_content] if args.key?(:media_content) + @payload = args[:payload] if args.key?(:payload) + @platform = args[:platform] if args.key?(:platform) + @quick_replies = args[:quick_replies] if args.key?(:quick_replies) + @rbm_carousel_rich_card = args[:rbm_carousel_rich_card] if args.key?(:rbm_carousel_rich_card) + @rbm_standalone_rich_card = args[:rbm_standalone_rich_card] if args.key?(:rbm_standalone_rich_card) + @rbm_text = args[:rbm_text] if args.key?(:rbm_text) + @simple_responses = args[:simple_responses] if args.key?(:simple_responses) + @suggestions = args[:suggestions] if args.key?(:suggestions) + @table_card = args[:table_card] if args.key?(:table_card) + @telephony_play_audio = args[:telephony_play_audio] if args.key?(:telephony_play_audio) + @telephony_synthesize_speech = args[:telephony_synthesize_speech] if args.key?(:telephony_synthesize_speech) + @telephony_transfer_call = args[:telephony_transfer_call] if args.key?(:telephony_transfer_call) + @text = args[:text] if args.key?(:text) + end + end + + # The basic card message. Useful for displaying information. + class GoogleCloudDialogflowV2beta1IntentMessageBasicCard + include Google::Apis::Core::Hashable + + # Optional. The collection of card buttons. + # Corresponds to the JSON property `buttons` + # @return [Array] + attr_accessor :buttons + + # Required, unless image is present. The body text of the card. + # Corresponds to the JSON property `formattedText` + # @return [String] + attr_accessor :formatted_text + + # The image response message. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage] + attr_accessor :image + + # Optional. The subtitle of the card. + # Corresponds to the JSON property `subtitle` + # @return [String] + attr_accessor :subtitle + + # Optional. The title of the card. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @buttons = args[:buttons] if args.key?(:buttons) + @formatted_text = args[:formatted_text] if args.key?(:formatted_text) + @image = args[:image] if args.key?(:image) + @subtitle = args[:subtitle] if args.key?(:subtitle) + @title = args[:title] if args.key?(:title) + end + end + + # The button object that appears at the bottom of a card. + class GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton + include Google::Apis::Core::Hashable + + # Opens the given URI. + # Corresponds to the JSON property `openUriAction` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction] + attr_accessor :open_uri_action + + # Required. The title of the button. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @open_uri_action = args[:open_uri_action] if args.key?(:open_uri_action) + @title = args[:title] if args.key?(:title) + end + end + + # Opens the given URI. + class GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction + include Google::Apis::Core::Hashable + + # Required. The HTTP or HTTPS scheme URI. + # 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) + @uri = args[:uri] if args.key?(:uri) + end + end + + # 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. + # 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. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @image_display_options = args[:image_display_options] if args.key?(:image_display_options) + @items = args[:items] if args.key?(:items) + end + end + + # Browsing carousel tile + class GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem + include Google::Apis::Core::Hashable + + # 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. + # Corresponds to the JSON property `footer` + # @return [String] + attr_accessor :footer + + # The image response message. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage] + attr_accessor :image + + # Actions on Google action to open a given url. + # Corresponds to the JSON property `openUriAction` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction] + attr_accessor :open_uri_action + + # Required. Title of the carousel item. Maximum of two lines of text. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @footer = args[:footer] if args.key?(:footer) + @image = args[:image] if args.key?(:image) + @open_uri_action = args[:open_uri_action] if args.key?(:open_uri_action) + @title = args[:title] if args.key?(:title) + end + end + + # Actions on Google action to open a given url. + class GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction + include Google::Apis::Core::Hashable + + # Required. URL + # Corresponds to the JSON property `url` + # @return [String] + attr_accessor :url + + # 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 + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @url = args[:url] if args.key?(:url) + @url_type_hint = args[:url_type_hint] if args.key?(:url_type_hint) + end + end + + # The card response message. + class GoogleCloudDialogflowV2beta1IntentMessageCard + include Google::Apis::Core::Hashable + + # Optional. The collection of card buttons. + # Corresponds to the JSON property `buttons` + # @return [Array] + attr_accessor :buttons + + # Optional. The public URI to an image file for the card. + # Corresponds to the JSON property `imageUri` + # @return [String] + attr_accessor :image_uri + + # Optional. The subtitle of the card. + # Corresponds to the JSON property `subtitle` + # @return [String] + attr_accessor :subtitle + + # Optional. The title of the card. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @buttons = args[:buttons] if args.key?(:buttons) + @image_uri = args[:image_uri] if args.key?(:image_uri) + @subtitle = args[:subtitle] if args.key?(:subtitle) + @title = args[:title] if args.key?(:title) + end + end + + # Optional. Contains information about a button. + class GoogleCloudDialogflowV2beta1IntentMessageCardButton + include Google::Apis::Core::Hashable + + # 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 + + # Optional. The text to show on the button. + # Corresponds to the JSON property `text` + # @return [String] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @postback = args[:postback] if args.key?(:postback) + @text = args[:text] if args.key?(:text) + end + end + + # The card for presenting a carousel of options to select from. + class GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect + include Google::Apis::Core::Hashable + + # Required. Carousel items. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @items = args[:items] if args.key?(:items) + end + end + + # An item in the carousel. + class GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem + include Google::Apis::Core::Hashable + + # Optional. The body text of the card. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The image response message. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage] + attr_accessor :image + + # Additional info about the select item for when it is triggered in a dialog. + # Corresponds to the JSON property `info` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo] + attr_accessor :info + + # Required. Title of the carousel item. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @image = args[:image] if args.key?(:image) + @info = args[:info] if args.key?(:info) + @title = args[:title] if args.key?(:title) + end + end + + # Column properties for TableCard. + class GoogleCloudDialogflowV2beta1IntentMessageColumnProperties + include Google::Apis::Core::Hashable + + # Required. Column heading. + # Corresponds to the JSON property `header` + # @return [String] + attr_accessor :header + + # Optional. Defines text alignment for all cells in this column. + # Corresponds to the JSON property `horizontalAlignment` + # @return [String] + attr_accessor :horizontal_alignment + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @header = args[:header] if args.key?(:header) + @horizontal_alignment = args[:horizontal_alignment] if args.key?(:horizontal_alignment) + end + end + + # The image response message. + 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. + # Corresponds to the JSON property `accessibilityText` + # @return [String] + attr_accessor :accessibility_text + + # Optional. The public URI to an image file. + # Corresponds to the JSON property `imageUri` + # @return [String] + attr_accessor :image_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @accessibility_text = args[:accessibility_text] if args.key?(:accessibility_text) + @image_uri = args[:image_uri] if args.key?(:image_uri) + end + end + + # 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 + + # Required. The name of the app or site this chip is linking to. + # Corresponds to the JSON property `destinationName` + # @return [String] + attr_accessor :destination_name + + # 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 + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @destination_name = args[:destination_name] if args.key?(:destination_name) + @uri = args[:uri] if args.key?(:uri) + end + end + + # The card for presenting a list of options to select from. + class GoogleCloudDialogflowV2beta1IntentMessageListSelect + include Google::Apis::Core::Hashable + + # Required. List items. + # Corresponds to the JSON property `items` + # @return [Array] + attr_accessor :items + + # Optional. Subtitle of the list. + # Corresponds to the JSON property `subtitle` + # @return [String] + attr_accessor :subtitle + + # Optional. The overall title of the list. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @items = args[:items] if args.key?(:items) + @subtitle = args[:subtitle] if args.key?(:subtitle) + @title = args[:title] if args.key?(:title) + end + end + + # An item in the list. + class GoogleCloudDialogflowV2beta1IntentMessageListSelectItem + include Google::Apis::Core::Hashable + + # Optional. The main text describing the item. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The image response message. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage] + attr_accessor :image + + # Additional info about the select item for when it is triggered in a dialog. + # Corresponds to the JSON property `info` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo] + attr_accessor :info + + # Required. The title of the list item. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @image = args[:image] if args.key?(:image) + @info = args[:info] if args.key?(:info) + @title = args[:title] if args.key?(:title) + end + end + + # The media content card for Actions on Google. + class GoogleCloudDialogflowV2beta1IntentMessageMediaContent + include Google::Apis::Core::Hashable + + # Required. List of media objects. + # Corresponds to the JSON property `mediaObjects` + # @return [Array] + attr_accessor :media_objects + + # Optional. What type of media is the content (ie "audio"). + # Corresponds to the JSON property `mediaType` + # @return [String] + attr_accessor :media_type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @media_objects = args[:media_objects] if args.key?(:media_objects) + @media_type = args[:media_type] if args.key?(:media_type) + end + end + + # Response media object for media content card. + class GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject + include Google::Apis::Core::Hashable + + # Required. Url where the media is stored. + # Corresponds to the JSON property `contentUrl` + # @return [String] + attr_accessor :content_url + + # Optional. Description of media card. + # Corresponds to the JSON property `description` + # @return [String] + attr_accessor :description + + # The image response message. + # Corresponds to the JSON property `icon` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage] + attr_accessor :icon + + # The image response message. + # Corresponds to the JSON property `largeImage` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage] + attr_accessor :large_image + + # Required. Name of media card. + # 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) + @content_url = args[:content_url] if args.key?(:content_url) + @description = args[:description] if args.key?(:description) + @icon = args[:icon] if args.key?(:icon) + @large_image = args[:large_image] if args.key?(:large_image) + @name = args[:name] if args.key?(:name) + end + end + + # The quick replies response message. + class GoogleCloudDialogflowV2beta1IntentMessageQuickReplies + include Google::Apis::Core::Hashable + + # Optional. The collection of quick replies. + # Corresponds to the JSON property `quickReplies` + # @return [Array] + attr_accessor :quick_replies + + # Optional. The title of the collection of quick replies. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @quick_replies = args[:quick_replies] if args.key?(:quick_replies) + @title = args[:title] if args.key?(:title) + end + end + + # Rich Business Messaging (RBM) Card content + 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. + # 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 + # Corresponds to the JSON property `media` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia] + attr_accessor :media + + # Optional. List of suggestions to include in the card. + # Corresponds to the JSON property `suggestions` + # @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. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @description = args[:description] if args.key?(:description) + @media = args[:media] if args.key?(:media) + @suggestions = args[:suggestions] if args.key?(:suggestions) + @title = args[:title] if args.key?(:title) + 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 + 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. + # 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. + # 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. + # Corresponds to the JSON property `thumbnailUri` + # @return [String] + attr_accessor :thumbnail_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @file_uri = args[:file_uri] if args.key?(:file_uri) + @height = args[:height] if args.key?(:height) + @thumbnail_uri = args[:thumbnail_uri] if args.key?(:thumbnail_uri) + 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. + 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. + # Corresponds to the JSON property `cardContents` + # @return [Array] + attr_accessor :card_contents + + # Required. The width of the cards in the carousel. + # Corresponds to the JSON property `cardWidth` + # @return [String] + attr_accessor :card_width + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @card_contents = args[:card_contents] if args.key?(:card_contents) + @card_width = args[:card_width] if args.key?(:card_width) + 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. + class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard + include Google::Apis::Core::Hashable + + # Rich Business Messaging (RBM) Card content + # Corresponds to the JSON property `cardContent` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent] + attr_accessor :card_content + + # Required. Orientation of the card. + # Corresponds to the JSON property `cardOrientation` + # @return [String] + attr_accessor :card_orientation + + # 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 + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @card_content = args[:card_content] if args.key?(:card_content) + @card_orientation = args[:card_orientation] if args.key?(:card_orientation) + @thumbnail_image_alignment = args[:thumbnail_image_alignment] if args.key?(:thumbnail_image_alignment) + end + end + + # 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. + # Corresponds to the JSON property `dial` + # @return [Google::Apis::DialogflowV3beta1::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. + # Corresponds to the JSON property `openUrl` + # @return [Google::Apis::DialogflowV3beta1::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. + # 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. + # Corresponds to the JSON property `shareLocation` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation] + attr_accessor :share_location + + # Text to display alongside the action. + # Corresponds to the JSON property `text` + # @return [String] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @dial = args[:dial] if args.key?(:dial) + @open_url = args[:open_url] if args.key?(:open_url) + @postback_data = args[:postback_data] if args.key?(:postback_data) + @share_location = args[:share_location] if args.key?(:share_location) + @text = args[:text] if args.key?(:text) + end + end + + # 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. + # Corresponds to the JSON property `phoneNumber` + # @return [String] + attr_accessor :phone_number + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @phone_number = args[:phone_number] if args.key?(:phone_number) + 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. + class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri + include Google::Apis::Core::Hashable + + # Required. The uri to open on the user device + # 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) + @uri = args[:uri] if args.key?(:uri) + end + end + + # 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 + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # 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. + # Corresponds to the JSON property `postbackData` + # @return [String] + attr_accessor :postback_data + + # Suggested reply text. + # Corresponds to the JSON property `text` + # @return [String] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @postback_data = args[:postback_data] if args.key?(:postback_data) + @text = args[:text] if args.key?(:text) + 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). + class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion + include Google::Apis::Core::Hashable + + # 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::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction] + attr_accessor :action + + # 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::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply] + attr_accessor :reply + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action = args[:action] if args.key?(:action) + @reply = args[:reply] if args.key?(:reply) + end + end + + # Rich Business Messaging (RBM) text response with suggestions. + class GoogleCloudDialogflowV2beta1IntentMessageRbmText + include Google::Apis::Core::Hashable + + # Optional. One or more suggestions to show to the user. + # Corresponds to the JSON property `rbmSuggestion` + # @return [Array] + attr_accessor :rbm_suggestion + + # Required. Text sent and displayed to the user. + # Corresponds to the JSON property `text` + # @return [String] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @rbm_suggestion = args[:rbm_suggestion] if args.key?(:rbm_suggestion) + @text = args[:text] if args.key?(:text) + end + end + + # 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. + # 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. + # Corresponds to the JSON property `synonyms` + # @return [Array] + attr_accessor :synonyms + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @key = args[:key] if args.key?(:key) + @synonyms = args[:synonyms] if args.key?(:synonyms) + end + end + + # The simple response message containing speech or text. + class GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse + include Google::Apis::Core::Hashable + + # Optional. The text to display. + # Corresponds to the JSON property `displayText` + # @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. + # 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. + # Corresponds to the JSON property `textToSpeech` + # @return [String] + attr_accessor :text_to_speech + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @display_text = args[:display_text] if args.key?(:display_text) + @ssml = args[:ssml] if args.key?(:ssml) + @text_to_speech = args[:text_to_speech] if args.key?(:text_to_speech) + end + end + + # 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 + + # Required. The list of simple responses. + # Corresponds to the JSON property `simpleResponses` + # @return [Array] + attr_accessor :simple_responses + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @simple_responses = args[:simple_responses] if args.key?(:simple_responses) + end + end + + # The suggestion chip message that the user can tap to quickly post a reply to + # the conversation. + class GoogleCloudDialogflowV2beta1IntentMessageSuggestion + include Google::Apis::Core::Hashable + + # Required. The text shown the in the suggestion chip. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @title = args[:title] if args.key?(:title) + end + end + + # The collection of suggestions. + class GoogleCloudDialogflowV2beta1IntentMessageSuggestions + include Google::Apis::Core::Hashable + + # Required. The list of suggested replies. + # Corresponds to the JSON property `suggestions` + # @return [Array] + attr_accessor :suggestions + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @suggestions = args[:suggestions] if args.key?(:suggestions) + end + end + + # Table card for Actions on Google. + class GoogleCloudDialogflowV2beta1IntentMessageTableCard + include Google::Apis::Core::Hashable + + # Optional. List of buttons for the card. + # Corresponds to the JSON property `buttons` + # @return [Array] + attr_accessor :buttons + + # Optional. Display properties for the columns in this table. + # Corresponds to the JSON property `columnProperties` + # @return [Array] + attr_accessor :column_properties + + # The image response message. + # Corresponds to the JSON property `image` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage] + attr_accessor :image + + # Optional. Rows in this table of data. + # Corresponds to the JSON property `rows` + # @return [Array] + attr_accessor :rows + + # Optional. Subtitle to the title. + # Corresponds to the JSON property `subtitle` + # @return [String] + attr_accessor :subtitle + + # Required. Title of the card. + # Corresponds to the JSON property `title` + # @return [String] + attr_accessor :title + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @buttons = args[:buttons] if args.key?(:buttons) + @column_properties = args[:column_properties] if args.key?(:column_properties) + @image = args[:image] if args.key?(:image) + @rows = args[:rows] if args.key?(:rows) + @subtitle = args[:subtitle] if args.key?(:subtitle) + @title = args[:title] if args.key?(:title) + end + end + + # Cell of TableCardRow. + class GoogleCloudDialogflowV2beta1IntentMessageTableCardCell + include Google::Apis::Core::Hashable + + # Required. Text in this cell. + # Corresponds to the JSON property `text` + # @return [String] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @text = args[:text] if args.key?(:text) + end + end + + # Row of TableCard. + class GoogleCloudDialogflowV2beta1IntentMessageTableCardRow + include Google::Apis::Core::Hashable + + # Optional. List of cells that make up this row. + # Corresponds to the JSON property `cells` + # @return [Array] + attr_accessor :cells + + # Optional. Whether to add a visual divider after this row. + # Corresponds to the JSON property `dividerAfter` + # @return [Boolean] + attr_accessor :divider_after + alias_method :divider_after?, :divider_after + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @cells = args[:cells] if args.key?(:cells) + @divider_after = args[:divider_after] if args.key?(:divider_after) + end + end + + # Plays audio from a file in Telephony Gateway. + 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. + # Corresponds to the JSON property `audioUri` + # @return [String] + attr_accessor :audio_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @audio_uri = args[:audio_uri] if args.key?(:audio_uri) + end + 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. + class GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech + include Google::Apis::Core::Hashable + + # 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 + + # The raw text to be synthesized. + # Corresponds to the JSON property `text` + # @return [String] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @ssml = args[:ssml] if args.key?(:ssml) + @text = args[:text] if args.key?(:text) + end + end + + # Transfers the call in Telephony Gateway. + 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). + # Corresponds to the JSON property `phoneNumber` + # @return [String] + attr_accessor :phone_number + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @phone_number = args[:phone_number] if args.key?(:phone_number) + end + end + + # The text response message. + class GoogleCloudDialogflowV2beta1IntentMessageText + include Google::Apis::Core::Hashable + + # Optional. The collection of the agent's responses. + # Corresponds to the JSON property `text` + # @return [Array] + attr_accessor :text + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @text = args[:text] if args.key?(:text) + end + end + + # Represents intent parameters. + 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`. + # Corresponds to the JSON property `defaultValue` + # @return [String] + attr_accessor :default_value + + # Required. The name of the parameter. + # Corresponds to the JSON property `displayName` + # @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. + # Corresponds to the JSON property `entityTypeDisplayName` + # @return [String] + attr_accessor :entity_type_display_name + + # Optional. Indicates whether the parameter represents a list of values. + # Corresponds to the JSON property `isList` + # @return [Boolean] + 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. + # Corresponds to the JSON property `mandatory` + # @return [Boolean] + attr_accessor :mandatory + alias_method :mandatory?, :mandatory + + # The unique identifier of this parameter. + # Corresponds to the JSON property `name` + # @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. + # 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`. + # Corresponds to the JSON property `value` + # @return [String] + attr_accessor :value + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @default_value = args[:default_value] if args.key?(:default_value) + @display_name = args[:display_name] if args.key?(:display_name) + @entity_type_display_name = args[:entity_type_display_name] if args.key?(:entity_type_display_name) + @is_list = args[:is_list] if args.key?(:is_list) + @mandatory = args[:mandatory] if args.key?(:mandatory) + @name = args[:name] if args.key?(:name) + @prompts = args[:prompts] if args.key?(:prompts) + @value = args[:value] if args.key?(:value) + end + end + + # Represents an example that the agent is trained on. + class GoogleCloudDialogflowV2beta1IntentTrainingPhrase + include Google::Apis::Core::Hashable + + # Output only. The unique identifier of this training phrase. + # Corresponds to the JSON property `name` + # @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. + # 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. + # Corresponds to the JSON property `timesAddedCount` + # @return [Fixnum] + attr_accessor :times_added_count + + # Required. The type of the training phrase. + # Corresponds to the JSON property `type` + # @return [String] + attr_accessor :type + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @name = args[:name] if args.key?(:name) + @parts = args[:parts] if args.key?(:parts) + @times_added_count = args[:times_added_count] if args.key?(:times_added_count) + @type = args[:type] if args.key?(:type) + end + end + + # Represents a part of a training phrase. + 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. + # 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. + # Corresponds to the JSON property `entityType` + # @return [String] + attr_accessor :entity_type + + # Required. The text for this part. + # Corresponds to the JSON property `text` + # @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. + # Corresponds to the JSON property `userDefined` + # @return [Boolean] + attr_accessor :user_defined + alias_method :user_defined?, :user_defined + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @alias = args[:alias] if args.key?(:alias) + @entity_type = args[:entity_type] if args.key?(:entity_type) + @text = args[:text] if args.key?(:text) + @user_defined = args[:user_defined] if args.key?(:user_defined) + end + end + + # Represents the result of querying a Knowledge base. + class GoogleCloudDialogflowV2beta1KnowledgeAnswers + include Google::Apis::Core::Hashable + + # A list of answers from Knowledge Connector. + # Corresponds to the JSON property `answers` + # @return [Array] + attr_accessor :answers + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @answers = args[:answers] if args.key?(:answers) + end + end + + # An answer from Knowledge Connector. + class GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer + include Google::Apis::Core::Hashable + + # 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. + # 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. + # 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. + # 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/`. + # Corresponds to the JSON property `source` + # @return [String] + attr_accessor :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @answer = args[:answer] if args.key?(:answer) + @faq_question = args[:faq_question] if args.key?(:faq_question) + @match_confidence = args[:match_confidence] if args.key?(:match_confidence) + @match_confidence_level = args[:match_confidence_level] if args.key?(:match_confidence_level) + @source = args[:source] if args.key?(:source) + end + end + + # Metadata in google::longrunning::Operation for Knowledge operations. + class GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata + include Google::Apis::Core::Hashable + + # Required. Output only. The current state of this operation. + # 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) + @state = args[:state] if args.key?(:state) + end + end + + # 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. + # Corresponds to the JSON property `annotatedConversationDataset` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1AnnotatedConversationDataset] + attr_accessor :annotated_conversation_dataset + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @annotated_conversation_dataset = args[:annotated_conversation_dataset] if args.key?(:annotated_conversation_dataset) + end + end + + # 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. + # 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. + # 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. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @payload = args[:payload] if args.key?(:payload) + @source = args[:source] if args.key?(:source) + @version = args[:version] if args.key?(:version) + end + end + + # Represents the result of conversational query or event processing. + class GoogleCloudDialogflowV2beta1QueryResult + include Google::Apis::Core::Hashable + + # The action name from the matched intent. + # Corresponds to the JSON property `action` + # @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. + # 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 + # Corresponds to the JSON property `diagnosticInfo` + # @return [Hash] + attr_accessor :diagnostic_info + + # The collection of rich messages to present to the user. + # Corresponds to the JSON property `fulfillmentMessages` + # @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. + # Corresponds to the JSON property `fulfillmentText` + # @return [String] + attr_accessor :fulfillment_text + + # An intent categorizes an end-user's intention for one conversation turn. For + # each agent, you define many intents, where your combined intents can handle a + # 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). + # Corresponds to the JSON property `intent` + # @return [Google::Apis::DialogflowV3beta1::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. + # 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. + # Corresponds to the JSON property `intentDetectionConfidence` + # @return [Float] + attr_accessor :intent_detection_confidence + + # Represents the result of querying a Knowledge base. + # Corresponds to the JSON property `knowledgeAnswers` + # @return [Google::Apis::DialogflowV3beta1::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. + # 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. + # 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 + # 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. + # 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 Participants.StreamingAnalyzeContent, it needs to be configured in + # ConversationProfile.human_agent_assistant_config + # Corresponds to the JSON property `sentimentAnalysisResult` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1SentimentAnalysisResult] + attr_accessor :sentiment_analysis_result + + # 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 + # 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. + # 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. + # Corresponds to the JSON property `webhookSource` + # @return [String] + attr_accessor :webhook_source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @action = args[:action] if args.key?(:action) + @all_required_params_present = args[:all_required_params_present] if args.key?(:all_required_params_present) + @diagnostic_info = args[:diagnostic_info] if args.key?(:diagnostic_info) + @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages) + @fulfillment_text = args[:fulfillment_text] if args.key?(:fulfillment_text) + @intent = args[:intent] if args.key?(:intent) + @intent_detection_confidence = args[:intent_detection_confidence] if args.key?(:intent_detection_confidence) + @knowledge_answers = args[:knowledge_answers] if args.key?(:knowledge_answers) + @language_code = args[:language_code] if args.key?(:language_code) + @output_contexts = args[:output_contexts] if args.key?(:output_contexts) + @parameters = args[:parameters] if args.key?(:parameters) + @query_text = args[:query_text] if args.key?(:query_text) + @sentiment_analysis_result = args[:sentiment_analysis_result] if args.key?(:sentiment_analysis_result) + @speech_recognition_confidence = args[:speech_recognition_confidence] if args.key?(:speech_recognition_confidence) + @webhook_payload = args[:webhook_payload] if args.key?(:webhook_payload) + @webhook_source = args[:webhook_source] if args.key?(:webhook_source) + end + end + + # 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 + + # A non-negative number in the [0, +inf) range, which represents the absolute + # magnitude of sentiment, regardless of score (positive or negative). + # Corresponds to the JSON property `magnitude` + # @return [Float] + attr_accessor :magnitude + + # Sentiment score between -1.0 (negative sentiment) and 1.0 (positive sentiment). + # Corresponds to the JSON property `score` + # @return [Float] + attr_accessor :score + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @magnitude = args[:magnitude] if args.key?(:magnitude) + @score = args[:score] if args.key?(:score) + 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 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. + # Corresponds to the JSON property `queryTextSentiment` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1Sentiment] + attr_accessor :query_text_sentiment + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @query_text_sentiment = args[:query_text_sentiment] if args.key?(:query_text_sentiment) + 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). + class GoogleCloudDialogflowV2beta1SessionEntityType + include Google::Apis::Core::Hashable + + # 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. + # 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. + # 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) + @entities = args[:entities] if args.key?(:entities) + @entity_override_mode = args[:entity_override_mode] if args.key?(:entity_override_mode) + @name = args[:name] if args.key?(:name) + end + end + + # The request message for a webhook call. + class GoogleCloudDialogflowV2beta1WebhookRequest + include Google::Apis::Core::Hashable + + # Alternative query results from KnowledgeService. + # Corresponds to the JSON property `alternativeQueryResults` + # @return [Array] + attr_accessor :alternative_query_results + + # Represents the contents of the original request that was passed to the `[ + # Streaming]DetectIntent` call. + # Corresponds to the JSON property `originalDetectIntentRequest` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest] + attr_accessor :original_detect_intent_request + + # Represents the result of conversational query or event processing. + # Corresponds to the JSON property `queryResult` + # @return [Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1QueryResult] + attr_accessor :query_result + + # 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/`. + # Corresponds to the JSON property `session` + # @return [String] + attr_accessor :session + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @alternative_query_results = args[:alternative_query_results] if args.key?(:alternative_query_results) + @original_detect_intent_request = args[:original_detect_intent_request] if args.key?(:original_detect_intent_request) + @query_result = args[:query_result] if args.key?(:query_result) + @response_id = args[:response_id] if args.key?(:response_id) + @session = args[:session] if args.key?(:session) + 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). + 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. + # 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?"`. + # Corresponds to the JSON property `followupEventInput` + # @return [Google::Apis::DialogflowV3beta1::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. + # 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. + # 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. + # 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) + # 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. + # 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 + # QueryResult.webhook_source sent to the integration or API caller. + # Corresponds to the JSON property `source` + # @return [String] + attr_accessor :source + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @end_interaction = args[:end_interaction] if args.key?(:end_interaction) + @followup_event_input = args[:followup_event_input] if args.key?(:followup_event_input) + @fulfillment_messages = args[:fulfillment_messages] if args.key?(:fulfillment_messages) + @fulfillment_text = args[:fulfillment_text] if args.key?(:fulfillment_text) + @output_contexts = args[:output_contexts] if args.key?(:output_contexts) + @payload = args[:payload] if args.key?(:payload) + @session_entity_types = args[:session_entity_types] if args.key?(:session_entity_types) + @source = args[:source] if args.key?(:source) + end + end + + # Metadata associated with the long running operation for Versions.CreateVersion. + class GoogleCloudDialogflowV3alpha1CreateVersionOperationMetadata + include Google::Apis::Core::Hashable + + # Name of the created version. Format: `projects//locations//agents//flows// + # versions/`. + # Corresponds to the JSON property `version` + # @return [String] + attr_accessor :version + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @version = args[:version] if args.key?(:version) + end + end + + # The response message for Agents.ExportAgent. + class GoogleCloudDialogflowV3alpha1ExportAgentResponse + include Google::Apis::Core::Hashable + + # Uncompressed raw byte content for agent. + # Corresponds to the JSON property `agentContent` + # NOTE: Values are automatically base64 encoded/decoded in the client library. + # @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. + # Corresponds to the JSON property `agentUri` + # @return [String] + attr_accessor :agent_uri + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @agent_content = args[:agent_content] if args.key?(:agent_content) + @agent_uri = args[:agent_uri] if args.key?(:agent_uri) + end + end + + # The response message for Operations.ListOperations. + class GoogleLongrunningListOperationsResponse + include Google::Apis::Core::Hashable + + # The standard List next-page token. + # Corresponds to the JSON property `nextPageToken` + # @return [String] + attr_accessor :next_page_token + + # A list of operations that matches the specified filter in the request. + # Corresponds to the JSON property `operations` + # @return [Array] + attr_accessor :operations + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @next_page_token = args[:next_page_token] if args.key?(:next_page_token) + @operations = args[:operations] if args.key?(:operations) + end + end + + # This resource represents a long-running operation that is the result of a + # network API call. + 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. + # Corresponds to the JSON property `done` + # @return [Boolean] + attr_accessor :done + alias_method :done?, :done + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). + # Corresponds to the JSON property `error` + # @return [Google::Apis::DialogflowV3beta1::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. + # Corresponds to the JSON property `metadata` + # @return [Hash] + attr_accessor :metadata + + # The server-assigned name, which is only unique within the same service that + # originally returns it. If you use the default HTTP mapping, the `name` should + # be a resource name ending with `operations/`unique_id``. + # Corresponds to the JSON property `name` + # @return [String] + attr_accessor :name + + # The normal response of the operation in case of success. If the original + # method returns no data on success, such as `Delete`, the response is `google. + # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, + # the response should be the resource. For other methods, the response should + # have the type `XxxResponse`, where `Xxx` is the original method name. For + # example, if the original method name is `TakeSnapshot()`, the inferred + # response type is `TakeSnapshotResponse`. + # Corresponds to the JSON property `response` + # @return [Hash] + attr_accessor :response + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @done = args[:done] if args.key?(:done) + @error = args[:error] if args.key?(:error) + @metadata = args[:metadata] if args.key?(:metadata) + @name = args[:name] if args.key?(:name) + @response = args[:response] if args.key?(:response) + end + end + + # 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 + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + end + end + + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). + class GoogleRpcStatus + include Google::Apis::Core::Hashable + + # The status code, which should be an enum value of google.rpc.Code. + # Corresponds to the JSON property `code` + # @return [Fixnum] + attr_accessor :code + + # A list of messages that carry the error details. There is a common set of + # message types for APIs to use. + # Corresponds to the JSON property `details` + # @return [Array>] + attr_accessor :details + + # A developer-facing error message, which should be in English. Any user-facing + # error message should be localized and sent in the google.rpc.Status.details + # field, or localized by the client. + # Corresponds to the JSON property `message` + # @return [String] + attr_accessor :message + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @code = args[:code] if args.key?(:code) + @details = args[:details] if args.key?(:details) + @message = args[:message] if args.key?(:message) + end + end + end + end +end diff --git a/generated/google/apis/dialogflow_v3beta1/representations.rb b/generated/google/apis/dialogflow_v3beta1/representations.rb new file mode 100644 index 000000000..00ee13bee --- /dev/null +++ b/generated/google/apis/dialogflow_v3beta1/representations.rb @@ -0,0 +1,2425 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'date' +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DialogflowV3beta1 + + class GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1ExportAgentResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1PageInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1PageInfoFormInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessageText + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1SessionInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1WebhookRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1WebhookResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2AnnotatedMessagePart + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2BatchUpdateIntentsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2Context + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2ConversationEvent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2EntityType + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2EntityTypeEntity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2EventInput + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2ExportAgentResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2Intent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentFollowupIntentInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageBasicCard + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageBasicCardButton + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageCard + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageCardButton + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageCarouselSelect + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageCarouselSelectItem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageColumnProperties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageImage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageListSelect + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageListSelectItem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageMediaContent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageQuickReplies + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageSelectItemInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageSimpleResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageSimpleResponses + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageSuggestion + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageSuggestions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageTableCard + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageTableCardCell + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageTableCardRow + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentMessageText + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentParameter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentTrainingPhrase + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2IntentTrainingPhrasePart + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2Message + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2MessageAnnotation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2OriginalDetectIntentRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2QueryResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2Sentiment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2SentimentAnalysisResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2SessionEntityType + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2WebhookRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2WebhookResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1AnnotatedConversationDataset + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1AutoApproveSmartMessagingEntriesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1Context + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1EntityType + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1EntityTypeEntity + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1EventInput + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1ExportAgentResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1Intent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageBasicCard + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageCard + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageCardButton + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageColumnProperties + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageImage + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageListSelect + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageListSelectItem + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageMediaContent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageQuickReplies + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmText + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageSuggestion + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageSuggestions + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageTableCard + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageTableCardCell + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageTableCardRow + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentMessageText + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentParameter + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentTrainingPhrase + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1KnowledgeAnswers + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1LabelConversationResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1QueryResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1Sentiment + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1SentimentAnalysisResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1SessionEntityType + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1WebhookRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV2beta1WebhookResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV3alpha1CreateVersionOperationMetadata + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowV3alpha1ExportAgentResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleLongrunningListOperationsResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleLongrunningOperation + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleProtobufEmpty + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleRpcStatus + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudDialogflowCxV3beta1CreateVersionOperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :version, as: 'version' + end + end + + class GoogleCloudDialogflowCxV3beta1ExportAgentResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :agent_content, :base64 => true, as: 'agentContent' + property :agent_uri, as: 'agentUri' + end + end + + class GoogleCloudDialogflowCxV3beta1PageInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :current_page, as: 'currentPage' + property :form_info, as: 'formInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfo::Representation + + end + end + + class GoogleCloudDialogflowCxV3beta1PageInfoFormInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :parameter_info, as: 'parameterInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo::Representation + + end + end + + class GoogleCloudDialogflowCxV3beta1PageInfoFormInfoParameterInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_name, as: 'displayName' + property :just_collected, as: 'justCollected' + property :required, as: 'required' + property :state, as: 'state' + property :value, as: 'value' + end + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :conversation_success, as: 'conversationSuccess', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess::Representation + + property :end_interaction, as: 'endInteraction', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction::Representation + + property :human_agent_handoff, as: 'humanAgentHandoff', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff::Representation + + property :live_agent_handoff, as: 'liveAgentHandoff', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff::Representation + + property :mixed_audio, as: 'mixedAudio', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio::Representation + + property :output_audio_text, as: 'outputAudioText', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText::Representation + + hash :payload, as: 'payload' + property :play_audio, as: 'playAudio', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio::Representation + + property :text, as: 'text', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageText, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageText::Representation + + end + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessageConversationSuccess + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :metadata, as: 'metadata' + end + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessageEndInteraction + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessageHumanAgentHandoff + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :metadata, as: 'metadata' + end + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessageLiveAgentHandoff + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :metadata, as: 'metadata' + end + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudio + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :segments, as: 'segments', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment::Representation + + end + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessageMixedAudioSegment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :allow_playback_interruption, as: 'allowPlaybackInterruption' + property :audio, :base64 => true, as: 'audio' + property :uri, as: 'uri' + end + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessageOutputAudioText + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ssml, as: 'ssml' + property :text, as: 'text' + end + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessagePlayAudio + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :allow_playback_interruption, as: 'allowPlaybackInterruption' + property :audio_uri, as: 'audioUri' + end + end + + class GoogleCloudDialogflowCxV3beta1ResponseMessageText + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :allow_playback_interruption, as: 'allowPlaybackInterruption' + collection :text, as: 'text' + end + end + + class GoogleCloudDialogflowCxV3beta1SessionInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :parameters, as: 'parameters' + property :session, as: 'session' + end + end + + class GoogleCloudDialogflowCxV3beta1WebhookRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :detect_intent_response_id, as: 'detectIntentResponseId' + property :fulfillment_info, as: 'fulfillmentInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo::Representation + + property :intent_info, as: 'intentInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo::Representation + + collection :messages, as: 'messages', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessage::Representation + + property :page_info, as: 'pageInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PageInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PageInfo::Representation + + hash :payload, as: 'payload' + property :session_info, as: 'sessionInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionInfo::Representation + + end + end + + class GoogleCloudDialogflowCxV3beta1WebhookRequestFulfillmentInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :tag, as: 'tag' + end + end + + class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :last_matched_intent, as: 'lastMatchedIntent' + hash :parameters, as: 'parameters', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue::Representation + + end + end + + class GoogleCloudDialogflowCxV3beta1WebhookRequestIntentInfoIntentParameterValue + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :original_value, as: 'originalValue' + property :resolved_value, as: 'resolvedValue' + end + end + + class GoogleCloudDialogflowCxV3beta1WebhookResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :fulfillment_response, as: 'fulfillmentResponse', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse::Representation + + property :page_info, as: 'pageInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PageInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1PageInfo::Representation + + hash :payload, as: 'payload' + property :session_info, as: 'sessionInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1SessionInfo::Representation + + property :target_flow, as: 'targetFlow' + property :target_page, as: 'targetPage' + end + end + + class GoogleCloudDialogflowCxV3beta1WebhookResponseFulfillmentResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :merge_behavior, as: 'mergeBehavior' + collection :messages, as: 'messages', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ResponseMessage::Representation + + end + end + + class GoogleCloudDialogflowV2AnnotatedMessagePart + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :entity_type, as: 'entityType' + property :formatted_value, as: 'formattedValue' + property :text, as: 'text' + end + end + + class GoogleCloudDialogflowV2BatchUpdateEntityTypesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :entity_types, as: 'entityTypes', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2EntityType, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2EntityType::Representation + + end + end + + class GoogleCloudDialogflowV2BatchUpdateIntentsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :intents, as: 'intents', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2Intent, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2Intent::Representation + + end + end + + class GoogleCloudDialogflowV2Context + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :lifespan_count, as: 'lifespanCount' + property :name, as: 'name' + hash :parameters, as: 'parameters' + end + end + + class GoogleCloudDialogflowV2ConversationEvent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :conversation, as: 'conversation' + property :error_status, as: 'errorStatus', class: Google::Apis::DialogflowV3beta1::GoogleRpcStatus, decorator: Google::Apis::DialogflowV3beta1::GoogleRpcStatus::Representation + + property :new_message_payload, as: 'newMessagePayload', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2Message, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2Message::Representation + + property :type, as: 'type' + end + end + + class GoogleCloudDialogflowV2EntityType + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :auto_expansion_mode, as: 'autoExpansionMode' + property :display_name, as: 'displayName' + property :enable_fuzzy_extraction, as: 'enableFuzzyExtraction' + collection :entities, as: 'entities', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2EntityTypeEntity, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2EntityTypeEntity::Representation + + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class GoogleCloudDialogflowV2EntityTypeEntity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :synonyms, as: 'synonyms' + property :value, as: 'value' + end + end + + class GoogleCloudDialogflowV2EventInput + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :language_code, as: 'languageCode' + property :name, as: 'name' + hash :parameters, as: 'parameters' + end + end + + class GoogleCloudDialogflowV2ExportAgentResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :agent_content, :base64 => true, as: 'agentContent' + property :agent_uri, as: 'agentUri' + end + end + + class GoogleCloudDialogflowV2Intent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action, as: 'action' + collection :default_response_platforms, as: 'defaultResponsePlatforms' + property :display_name, as: 'displayName' + collection :events, as: 'events' + collection :followup_intent_info, as: 'followupIntentInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentFollowupIntentInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentFollowupIntentInfo::Representation + + collection :input_context_names, as: 'inputContextNames' + property :is_fallback, as: 'isFallback' + collection :messages, as: 'messages', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessage::Representation + + property :ml_disabled, as: 'mlDisabled' + property :name, as: 'name' + collection :output_contexts, as: 'outputContexts', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2Context, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2Context::Representation + + collection :parameters, as: 'parameters', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentParameter, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentParameter::Representation + + property :parent_followup_intent_name, as: 'parentFollowupIntentName' + property :priority, as: 'priority' + property :reset_contexts, as: 'resetContexts' + property :root_followup_intent_name, as: 'rootFollowupIntentName' + collection :training_phrases, as: 'trainingPhrases', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentTrainingPhrase, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentTrainingPhrase::Representation + + property :webhook_state, as: 'webhookState' + end + end + + class GoogleCloudDialogflowV2IntentFollowupIntentInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :followup_intent_name, as: 'followupIntentName' + property :parent_followup_intent_name, as: 'parentFollowupIntentName' + end + end + + class GoogleCloudDialogflowV2IntentMessage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :basic_card, as: 'basicCard', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBasicCard, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBasicCard::Representation + + property :browse_carousel_card, as: 'browseCarouselCard', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard::Representation + + property :card, as: 'card', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageCard, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageCard::Representation + + property :carousel_select, as: 'carouselSelect', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageCarouselSelect, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageCarouselSelect::Representation + + property :image, as: 'image', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage::Representation + + property :link_out_suggestion, as: 'linkOutSuggestion', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion::Representation + + property :list_select, as: 'listSelect', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageListSelect, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageListSelect::Representation + + property :media_content, as: 'mediaContent', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageMediaContent, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageMediaContent::Representation + + hash :payload, as: 'payload' + property :platform, as: 'platform' + property :quick_replies, as: 'quickReplies', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageQuickReplies, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageQuickReplies::Representation + + property :simple_responses, as: 'simpleResponses', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageSimpleResponses, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageSimpleResponses::Representation + + property :suggestions, as: 'suggestions', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageSuggestions, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageSuggestions::Representation + + property :table_card, as: 'tableCard', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageTableCard, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageTableCard::Representation + + property :text, as: 'text', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageText, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageText::Representation + + end + end + + class GoogleCloudDialogflowV2IntentMessageBasicCard + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :buttons, as: 'buttons', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBasicCardButton, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBasicCardButton::Representation + + property :formatted_text, as: 'formattedText' + property :image, as: 'image', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage::Representation + + property :subtitle, as: 'subtitle' + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2IntentMessageBasicCardButton + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :open_uri_action, as: 'openUriAction', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction::Representation + + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2IntentMessageBasicCardButtonOpenUriAction + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :uri, as: 'uri' + end + end + + class GoogleCloudDialogflowV2IntentMessageBrowseCarouselCard + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :image_display_options, as: 'imageDisplayOptions' + collection :items, as: 'items', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem::Representation + + end + end + + class GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :footer, as: 'footer' + property :image, as: 'image', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage::Representation + + property :open_uri_action, as: 'openUriAction', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction::Representation + + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :url, as: 'url' + property :url_type_hint, as: 'urlTypeHint' + end + end + + class GoogleCloudDialogflowV2IntentMessageCard + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :buttons, as: 'buttons', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageCardButton, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageCardButton::Representation + + property :image_uri, as: 'imageUri' + property :subtitle, as: 'subtitle' + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2IntentMessageCardButton + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :postback, as: 'postback' + property :text, as: 'text' + end + end + + class GoogleCloudDialogflowV2IntentMessageCarouselSelect + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :items, as: 'items', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageCarouselSelectItem, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageCarouselSelectItem::Representation + + end + end + + class GoogleCloudDialogflowV2IntentMessageCarouselSelectItem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :image, as: 'image', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage::Representation + + property :info, as: 'info', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageSelectItemInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageSelectItemInfo::Representation + + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2IntentMessageColumnProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :header, as: 'header' + property :horizontal_alignment, as: 'horizontalAlignment' + end + end + + class GoogleCloudDialogflowV2IntentMessageImage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :accessibility_text, as: 'accessibilityText' + property :image_uri, as: 'imageUri' + end + end + + class GoogleCloudDialogflowV2IntentMessageLinkOutSuggestion + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :destination_name, as: 'destinationName' + property :uri, as: 'uri' + end + end + + class GoogleCloudDialogflowV2IntentMessageListSelect + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :items, as: 'items', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageListSelectItem, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageListSelectItem::Representation + + property :subtitle, as: 'subtitle' + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2IntentMessageListSelectItem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :image, as: 'image', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage::Representation + + property :info, as: 'info', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageSelectItemInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageSelectItemInfo::Representation + + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2IntentMessageMediaContent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :media_objects, as: 'mediaObjects', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject::Representation + + property :media_type, as: 'mediaType' + end + end + + class GoogleCloudDialogflowV2IntentMessageMediaContentResponseMediaObject + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content_url, as: 'contentUrl' + property :description, as: 'description' + property :icon, as: 'icon', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage::Representation + + property :large_image, as: 'largeImage', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage::Representation + + property :name, as: 'name' + end + end + + class GoogleCloudDialogflowV2IntentMessageQuickReplies + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :quick_replies, as: 'quickReplies' + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2IntentMessageSelectItemInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + collection :synonyms, as: 'synonyms' + end + end + + class GoogleCloudDialogflowV2IntentMessageSimpleResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_text, as: 'displayText' + property :ssml, as: 'ssml' + property :text_to_speech, as: 'textToSpeech' + end + end + + class GoogleCloudDialogflowV2IntentMessageSimpleResponses + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :simple_responses, as: 'simpleResponses', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageSimpleResponse, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageSimpleResponse::Representation + + end + end + + class GoogleCloudDialogflowV2IntentMessageSuggestion + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2IntentMessageSuggestions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :suggestions, as: 'suggestions', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageSuggestion, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageSuggestion::Representation + + end + end + + class GoogleCloudDialogflowV2IntentMessageTableCard + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :buttons, as: 'buttons', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBasicCardButton, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageBasicCardButton::Representation + + collection :column_properties, as: 'columnProperties', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageColumnProperties, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageColumnProperties::Representation + + property :image, as: 'image', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageImage::Representation + + collection :rows, as: 'rows', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageTableCardRow, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageTableCardRow::Representation + + property :subtitle, as: 'subtitle' + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2IntentMessageTableCardCell + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :text, as: 'text' + end + end + + class GoogleCloudDialogflowV2IntentMessageTableCardRow + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :cells, as: 'cells', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageTableCardCell, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessageTableCardCell::Representation + + property :divider_after, as: 'dividerAfter' + end + end + + class GoogleCloudDialogflowV2IntentMessageText + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :text, as: 'text' + end + end + + class GoogleCloudDialogflowV2IntentParameter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :default_value, as: 'defaultValue' + property :display_name, as: 'displayName' + property :entity_type_display_name, as: 'entityTypeDisplayName' + property :is_list, as: 'isList' + property :mandatory, as: 'mandatory' + property :name, as: 'name' + collection :prompts, as: 'prompts' + property :value, as: 'value' + end + end + + class GoogleCloudDialogflowV2IntentTrainingPhrase + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + collection :parts, as: 'parts', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentTrainingPhrasePart, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentTrainingPhrasePart::Representation + + property :times_added_count, as: 'timesAddedCount' + property :type, as: 'type' + end + end + + class GoogleCloudDialogflowV2IntentTrainingPhrasePart + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :alias, as: 'alias' + property :entity_type, as: 'entityType' + property :text, as: 'text' + property :user_defined, as: 'userDefined' + end + end + + class GoogleCloudDialogflowV2Message + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content, as: 'content' + property :create_time, as: 'createTime' + property :language_code, as: 'languageCode' + property :message_annotation, as: 'messageAnnotation', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2MessageAnnotation, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2MessageAnnotation::Representation + + property :name, as: 'name' + property :participant, as: 'participant' + property :participant_role, as: 'participantRole' + end + end + + class GoogleCloudDialogflowV2MessageAnnotation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :contain_entities, as: 'containEntities' + collection :parts, as: 'parts', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2AnnotatedMessagePart, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2AnnotatedMessagePart::Representation + + end + end + + class GoogleCloudDialogflowV2OriginalDetectIntentRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :payload, as: 'payload' + property :source, as: 'source' + property :version, as: 'version' + end + end + + class GoogleCloudDialogflowV2QueryResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action, as: 'action' + property :all_required_params_present, as: 'allRequiredParamsPresent' + hash :diagnostic_info, as: 'diagnosticInfo' + collection :fulfillment_messages, as: 'fulfillmentMessages', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessage::Representation + + property :fulfillment_text, as: 'fulfillmentText' + property :intent, as: 'intent', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2Intent, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2Intent::Representation + + property :intent_detection_confidence, as: 'intentDetectionConfidence' + property :language_code, as: 'languageCode' + collection :output_contexts, as: 'outputContexts', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2Context, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2Context::Representation + + hash :parameters, as: 'parameters' + property :query_text, as: 'queryText' + property :sentiment_analysis_result, as: 'sentimentAnalysisResult', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2SentimentAnalysisResult, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2SentimentAnalysisResult::Representation + + property :speech_recognition_confidence, as: 'speechRecognitionConfidence' + hash :webhook_payload, as: 'webhookPayload' + property :webhook_source, as: 'webhookSource' + end + end + + class GoogleCloudDialogflowV2Sentiment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :magnitude, as: 'magnitude' + property :score, as: 'score' + end + end + + class GoogleCloudDialogflowV2SentimentAnalysisResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :query_text_sentiment, as: 'queryTextSentiment', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2Sentiment, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2Sentiment::Representation + + end + end + + class GoogleCloudDialogflowV2SessionEntityType + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :entities, as: 'entities', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2EntityTypeEntity, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2EntityTypeEntity::Representation + + property :entity_override_mode, as: 'entityOverrideMode' + property :name, as: 'name' + end + end + + class GoogleCloudDialogflowV2WebhookRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :original_detect_intent_request, as: 'originalDetectIntentRequest', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2OriginalDetectIntentRequest, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2OriginalDetectIntentRequest::Representation + + property :query_result, as: 'queryResult', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2QueryResult, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2QueryResult::Representation + + property :response_id, as: 'responseId' + property :session, as: 'session' + end + end + + class GoogleCloudDialogflowV2WebhookResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :followup_event_input, as: 'followupEventInput', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2EventInput, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2EventInput::Representation + + collection :fulfillment_messages, as: 'fulfillmentMessages', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2IntentMessage::Representation + + property :fulfillment_text, as: 'fulfillmentText' + collection :output_contexts, as: 'outputContexts', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2Context, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2Context::Representation + + hash :payload, as: 'payload' + collection :session_entity_types, as: 'sessionEntityTypes', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2SessionEntityType, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2SessionEntityType::Representation + + property :source, as: 'source' + end + end + + class GoogleCloudDialogflowV2beta1AnnotatedConversationDataset + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :completed_example_count, :numeric_string => true, as: 'completedExampleCount' + property :create_time, as: 'createTime' + property :description, as: 'description' + property :display_name, as: 'displayName' + property :example_count, :numeric_string => true, as: 'exampleCount' + property :name, as: 'name' + property :question_type_name, as: 'questionTypeName' + end + end + + class GoogleCloudDialogflowV2beta1AutoApproveSmartMessagingEntriesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :disabled_count, as: 'disabledCount' + property :enabled_count, as: 'enabledCount' + property :unreviewed_count, as: 'unreviewedCount' + end + end + + class GoogleCloudDialogflowV2beta1BatchUpdateEntityTypesResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :entity_types, as: 'entityTypes', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1EntityType, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1EntityType::Representation + + end + end + + class GoogleCloudDialogflowV2beta1BatchUpdateIntentsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :intents, as: 'intents', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1Intent, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1Intent::Representation + + end + end + + class GoogleCloudDialogflowV2beta1Context + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :lifespan_count, as: 'lifespanCount' + property :name, as: 'name' + hash :parameters, as: 'parameters' + end + end + + class GoogleCloudDialogflowV2beta1EntityType + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :auto_expansion_mode, as: 'autoExpansionMode' + property :display_name, as: 'displayName' + property :enable_fuzzy_extraction, as: 'enableFuzzyExtraction' + collection :entities, as: 'entities', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1EntityTypeEntity, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1EntityTypeEntity::Representation + + property :kind, as: 'kind' + property :name, as: 'name' + end + end + + class GoogleCloudDialogflowV2beta1EntityTypeEntity + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :synonyms, as: 'synonyms' + property :value, as: 'value' + end + end + + class GoogleCloudDialogflowV2beta1EventInput + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :language_code, as: 'languageCode' + property :name, as: 'name' + hash :parameters, as: 'parameters' + end + end + + class GoogleCloudDialogflowV2beta1ExportAgentResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :agent_content, :base64 => true, as: 'agentContent' + property :agent_uri, as: 'agentUri' + end + end + + class GoogleCloudDialogflowV2beta1Intent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action, as: 'action' + collection :default_response_platforms, as: 'defaultResponsePlatforms' + property :display_name, as: 'displayName' + property :end_interaction, as: 'endInteraction' + collection :events, as: 'events' + collection :followup_intent_info, as: 'followupIntentInfo', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo::Representation + + collection :input_context_names, as: 'inputContextNames' + property :is_fallback, as: 'isFallback' + collection :messages, as: 'messages', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessage::Representation + + property :ml_disabled, as: 'mlDisabled' + property :ml_enabled, as: 'mlEnabled' + property :name, as: 'name' + collection :output_contexts, as: 'outputContexts', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1Context, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1Context::Representation + + collection :parameters, as: 'parameters', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentParameter, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentParameter::Representation + + property :parent_followup_intent_name, as: 'parentFollowupIntentName' + property :priority, as: 'priority' + property :reset_contexts, as: 'resetContexts' + property :root_followup_intent_name, as: 'rootFollowupIntentName' + collection :training_phrases, as: 'trainingPhrases', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentTrainingPhrase, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentTrainingPhrase::Representation + + property :webhook_state, as: 'webhookState' + end + end + + class GoogleCloudDialogflowV2beta1IntentFollowupIntentInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :followup_intent_name, as: 'followupIntentName' + property :parent_followup_intent_name, as: 'parentFollowupIntentName' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :basic_card, as: 'basicCard', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBasicCard, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBasicCard::Representation + + property :browse_carousel_card, as: 'browseCarouselCard', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard::Representation + + property :card, as: 'card', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageCard, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageCard::Representation + + property :carousel_select, as: 'carouselSelect', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect::Representation + + property :image, as: 'image', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage::Representation + + property :link_out_suggestion, as: 'linkOutSuggestion', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion::Representation + + property :list_select, as: 'listSelect', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageListSelect, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageListSelect::Representation + + property :media_content, as: 'mediaContent', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageMediaContent, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageMediaContent::Representation + + hash :payload, as: 'payload' + property :platform, as: 'platform' + property :quick_replies, as: 'quickReplies', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageQuickReplies, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageQuickReplies::Representation + + property :rbm_carousel_rich_card, as: 'rbmCarouselRichCard', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard::Representation + + property :rbm_standalone_rich_card, as: 'rbmStandaloneRichCard', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard::Representation + + property :rbm_text, as: 'rbmText', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmText, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmText::Representation + + property :simple_responses, as: 'simpleResponses', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses::Representation + + property :suggestions, as: 'suggestions', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageSuggestions, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageSuggestions::Representation + + property :table_card, as: 'tableCard', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTableCard, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTableCard::Representation + + property :telephony_play_audio, as: 'telephonyPlayAudio', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio::Representation + + property :telephony_synthesize_speech, as: 'telephonySynthesizeSpeech', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech::Representation + + property :telephony_transfer_call, as: 'telephonyTransferCall', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall::Representation + + property :text, as: 'text', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageText, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageText::Representation + + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageBasicCard + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :buttons, as: 'buttons', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton::Representation + + property :formatted_text, as: 'formattedText' + property :image, as: 'image', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage::Representation + + property :subtitle, as: 'subtitle' + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :open_uri_action, as: 'openUriAction', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction::Representation + + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageBasicCardButtonOpenUriAction + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :uri, as: 'uri' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCard + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :image_display_options, as: 'imageDisplayOptions' + collection :items, as: 'items', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem::Representation + + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :footer, as: 'footer' + property :image, as: 'image', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage::Representation + + property :open_uri_action, as: 'openUriAction', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction::Representation + + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageBrowseCarouselCardBrowseCarouselCardItemOpenUrlAction + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :url, as: 'url' + property :url_type_hint, as: 'urlTypeHint' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageCard + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :buttons, as: 'buttons', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageCardButton, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageCardButton::Representation + + property :image_uri, as: 'imageUri' + property :subtitle, as: 'subtitle' + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageCardButton + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :postback, as: 'postback' + property :text, as: 'text' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageCarouselSelect + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :items, as: 'items', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem::Representation + + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageCarouselSelectItem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :image, as: 'image', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage::Representation + + property :info, as: 'info', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo::Representation + + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageColumnProperties + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :header, as: 'header' + property :horizontal_alignment, as: 'horizontalAlignment' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageImage + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :accessibility_text, as: 'accessibilityText' + property :image_uri, as: 'imageUri' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageLinkOutSuggestion + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :destination_name, as: 'destinationName' + property :uri, as: 'uri' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageListSelect + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :items, as: 'items', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageListSelectItem, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageListSelectItem::Representation + + property :subtitle, as: 'subtitle' + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageListSelectItem + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :image, as: 'image', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage::Representation + + property :info, as: 'info', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo::Representation + + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageMediaContent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :media_objects, as: 'mediaObjects', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject::Representation + + property :media_type, as: 'mediaType' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageMediaContentResponseMediaObject + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :content_url, as: 'contentUrl' + property :description, as: 'description' + property :icon, as: 'icon', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage::Representation + + property :large_image, as: 'largeImage', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage::Representation + + property :name, as: 'name' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageQuickReplies + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :quick_replies, as: 'quickReplies' + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :description, as: 'description' + property :media, as: 'media', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia::Representation + + collection :suggestions, as: 'suggestions', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion::Representation + + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmCardContentRbmMedia + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :file_uri, as: 'fileUri' + property :height, as: 'height' + property :thumbnail_uri, as: 'thumbnailUri' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmCarouselCard + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :card_contents, as: 'cardContents', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent::Representation + + property :card_width, as: 'cardWidth' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmStandaloneCard + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :card_content, as: 'cardContent', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmCardContent::Representation + + property :card_orientation, as: 'cardOrientation' + property :thumbnail_image_alignment, as: 'thumbnailImageAlignment' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :dial, as: 'dial', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial::Representation + + property :open_url, as: 'openUrl', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri::Representation + + property :postback_data, as: 'postbackData' + property :share_location, as: 'shareLocation', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation::Representation + + property :text, as: 'text' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionDial + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :phone_number, as: 'phoneNumber' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionOpenUri + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :uri, as: 'uri' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedActionRbmSuggestedActionShareLocation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :postback_data, as: 'postbackData' + property :text, as: 'text' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action, as: 'action', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedAction::Representation + + property :reply, as: 'reply', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestedReply::Representation + + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageRbmText + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :rbm_suggestion, as: 'rbmSuggestion', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageRbmSuggestion::Representation + + property :text, as: 'text' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageSelectItemInfo + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :key, as: 'key' + collection :synonyms, as: 'synonyms' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :display_text, as: 'displayText' + property :ssml, as: 'ssml' + property :text_to_speech, as: 'textToSpeech' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageSimpleResponses + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :simple_responses, as: 'simpleResponses', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageSimpleResponse::Representation + + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageSuggestion + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageSuggestions + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :suggestions, as: 'suggestions', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageSuggestion, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageSuggestion::Representation + + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageTableCard + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :buttons, as: 'buttons', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageBasicCardButton::Representation + + collection :column_properties, as: 'columnProperties', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageColumnProperties, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageColumnProperties::Representation + + property :image, as: 'image', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageImage::Representation + + collection :rows, as: 'rows', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTableCardRow, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTableCardRow::Representation + + property :subtitle, as: 'subtitle' + property :title, as: 'title' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageTableCardCell + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :text, as: 'text' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageTableCardRow + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :cells, as: 'cells', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTableCardCell, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessageTableCardCell::Representation + + property :divider_after, as: 'dividerAfter' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageTelephonyPlayAudio + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :audio_uri, as: 'audioUri' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageTelephonySynthesizeSpeech + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :ssml, as: 'ssml' + property :text, as: 'text' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageTelephonyTransferCall + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :phone_number, as: 'phoneNumber' + end + end + + class GoogleCloudDialogflowV2beta1IntentMessageText + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :text, as: 'text' + end + end + + class GoogleCloudDialogflowV2beta1IntentParameter + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :default_value, as: 'defaultValue' + property :display_name, as: 'displayName' + property :entity_type_display_name, as: 'entityTypeDisplayName' + property :is_list, as: 'isList' + property :mandatory, as: 'mandatory' + property :name, as: 'name' + collection :prompts, as: 'prompts' + property :value, as: 'value' + end + end + + class GoogleCloudDialogflowV2beta1IntentTrainingPhrase + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :name, as: 'name' + collection :parts, as: 'parts', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart::Representation + + property :times_added_count, as: 'timesAddedCount' + property :type, as: 'type' + end + end + + class GoogleCloudDialogflowV2beta1IntentTrainingPhrasePart + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :alias, as: 'alias' + property :entity_type, as: 'entityType' + property :text, as: 'text' + property :user_defined, as: 'userDefined' + end + end + + class GoogleCloudDialogflowV2beta1KnowledgeAnswers + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :answers, as: 'answers', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer::Representation + + end + end + + class GoogleCloudDialogflowV2beta1KnowledgeAnswersAnswer + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :answer, as: 'answer' + property :faq_question, as: 'faqQuestion' + property :match_confidence, as: 'matchConfidence' + property :match_confidence_level, as: 'matchConfidenceLevel' + property :source, as: 'source' + end + end + + class GoogleCloudDialogflowV2beta1KnowledgeOperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :state, as: 'state' + end + end + + class GoogleCloudDialogflowV2beta1LabelConversationResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :annotated_conversation_dataset, as: 'annotatedConversationDataset', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1AnnotatedConversationDataset, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1AnnotatedConversationDataset::Representation + + end + end + + class GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + hash :payload, as: 'payload' + property :source, as: 'source' + property :version, as: 'version' + end + end + + class GoogleCloudDialogflowV2beta1QueryResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :action, as: 'action' + property :all_required_params_present, as: 'allRequiredParamsPresent' + hash :diagnostic_info, as: 'diagnosticInfo' + collection :fulfillment_messages, as: 'fulfillmentMessages', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessage::Representation + + property :fulfillment_text, as: 'fulfillmentText' + property :intent, as: 'intent', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1Intent, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1Intent::Representation + + property :intent_detection_confidence, as: 'intentDetectionConfidence' + property :knowledge_answers, as: 'knowledgeAnswers', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1KnowledgeAnswers, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1KnowledgeAnswers::Representation + + property :language_code, as: 'languageCode' + collection :output_contexts, as: 'outputContexts', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1Context, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1Context::Representation + + hash :parameters, as: 'parameters' + property :query_text, as: 'queryText' + property :sentiment_analysis_result, as: 'sentimentAnalysisResult', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1SentimentAnalysisResult, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1SentimentAnalysisResult::Representation + + property :speech_recognition_confidence, as: 'speechRecognitionConfidence' + hash :webhook_payload, as: 'webhookPayload' + property :webhook_source, as: 'webhookSource' + end + end + + class GoogleCloudDialogflowV2beta1Sentiment + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :magnitude, as: 'magnitude' + property :score, as: 'score' + end + end + + class GoogleCloudDialogflowV2beta1SentimentAnalysisResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :query_text_sentiment, as: 'queryTextSentiment', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1Sentiment, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1Sentiment::Representation + + end + end + + class GoogleCloudDialogflowV2beta1SessionEntityType + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :entities, as: 'entities', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1EntityTypeEntity, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1EntityTypeEntity::Representation + + property :entity_override_mode, as: 'entityOverrideMode' + property :name, as: 'name' + end + end + + class GoogleCloudDialogflowV2beta1WebhookRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :alternative_query_results, as: 'alternativeQueryResults', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1QueryResult, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1QueryResult::Representation + + property :original_detect_intent_request, as: 'originalDetectIntentRequest', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1OriginalDetectIntentRequest::Representation + + property :query_result, as: 'queryResult', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1QueryResult, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1QueryResult::Representation + + property :response_id, as: 'responseId' + property :session, as: 'session' + end + end + + class GoogleCloudDialogflowV2beta1WebhookResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :end_interaction, as: 'endInteraction' + property :followup_event_input, as: 'followupEventInput', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1EventInput, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1EventInput::Representation + + collection :fulfillment_messages, as: 'fulfillmentMessages', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessage, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1IntentMessage::Representation + + property :fulfillment_text, as: 'fulfillmentText' + collection :output_contexts, as: 'outputContexts', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1Context, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1Context::Representation + + hash :payload, as: 'payload' + collection :session_entity_types, as: 'sessionEntityTypes', class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1SessionEntityType, decorator: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowV2beta1SessionEntityType::Representation + + property :source, as: 'source' + end + end + + class GoogleCloudDialogflowV3alpha1CreateVersionOperationMetadata + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :version, as: 'version' + end + end + + class GoogleCloudDialogflowV3alpha1ExportAgentResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :agent_content, :base64 => true, as: 'agentContent' + property :agent_uri, as: 'agentUri' + end + end + + class GoogleLongrunningListOperationsResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :next_page_token, as: 'nextPageToken' + collection :operations, as: 'operations', class: Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation, decorator: Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation + + end + end + + class GoogleLongrunningOperation + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :done, as: 'done' + property :error, as: 'error', class: Google::Apis::DialogflowV3beta1::GoogleRpcStatus, decorator: Google::Apis::DialogflowV3beta1::GoogleRpcStatus::Representation + + hash :metadata, as: 'metadata' + property :name, as: 'name' + hash :response, as: 'response' + end + end + + class GoogleProtobufEmpty + # @private + class Representation < Google::Apis::Core::JsonRepresentation + end + end + + class GoogleRpcStatus + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :code, as: 'code' + collection :details, as: 'details' + property :message, as: 'message' + end + end + end + end +end diff --git a/generated/google/apis/dialogflow_v3beta1/service.rb b/generated/google/apis/dialogflow_v3beta1/service.rb new file mode 100644 index 000000000..710aae425 --- /dev/null +++ b/generated/google/apis/dialogflow_v3beta1/service.rb @@ -0,0 +1,288 @@ +# Copyright 2015 Google Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +require 'google/apis/core/base_service' +require 'google/apis/core/json_representation' +require 'google/apis/core/hashable' +require 'google/apis/errors' + +module Google + module Apis + module DialogflowV3beta1 + # Dialogflow API + # + # Builds conversational interfaces (for example, chatbots, and voice-powered + # apps and devices). + # + # @example + # require 'google/apis/dialogflow_v3beta1' + # + # Dialogflow = Google::Apis::DialogflowV3beta1 # Alias the module + # service = Dialogflow::DialogflowService.new + # + # @see https://cloud.google.com/dialogflow/ + class DialogflowService < Google::Apis::Core::BaseService + # @return [String] + # API key. Your API key identifies your project and provides you with API access, + # quota, and reports. Required unless you provide an OAuth 2.0 token. + attr_accessor :key + + # @return [String] + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + attr_accessor :quota_user + + def initialize + super('https://dialogflow.googleapis.com/', '') + @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, + # corresponding to `Code.CANCELLED`. + # @param [String] name + # The name of the operation resource to be cancelled. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def cancel_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v3beta1/{+name}:cancel', options) + command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation + command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of a long-running operation. Clients can use this method + # to poll the operation result at intervals as recommended by the API service. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3beta1/{+name}', options) + command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation + command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists operations that match the specified filter in the request. If the server + # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` + # binding allows API services to override the binding to use different resource + # name schemes, such as `users/*/operations`. To override the binding, API + # services can add a binding such as `"/v1/`name=users/*`/operations"` to their + # service configuration. For backwards compatibility, the default name includes + # the operations collection id, however overriding users must ensure the name + # binding is the parent resource, without the operations collection id. + # @param [String] name + # The name of the operation's parent resource. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleLongrunningListOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV3beta1::GoogleLongrunningListOperationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3beta1/{+name}/operations', options) + command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningListOperationsResponse::Representation + command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningListOperationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Starts asynchronous cancellation on a long-running operation. The server makes + # a best effort to cancel the operation, but success is not guaranteed. If the + # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + # Clients can use Operations.GetOperation or other methods to check whether the + # cancellation succeeded or whether the operation completed despite cancellation. + # On successful cancellation, the operation is not deleted; instead, it becomes + # an operation with an Operation.error value with a google.rpc.Status.code of 1, + # corresponding to `Code.CANCELLED`. + # @param [String] name + # The name of the operation resource to be cancelled. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def cancel_project_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v3beta1/{+name}:cancel', options) + command.response_representation = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty::Representation + command.response_class = Google::Apis::DialogflowV3beta1::GoogleProtobufEmpty + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets the latest state of a long-running operation. Clients can use this method + # to poll the operation result at intervals as recommended by the API service. + # @param [String] name + # The name of the operation resource. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_operation(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3beta1/{+name}', options) + command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation::Representation + command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningOperation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists operations that match the specified filter in the request. If the server + # doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` + # binding allows API services to override the binding to use different resource + # name schemes, such as `users/*/operations`. To override the binding, API + # services can add a binding such as `"/v1/`name=users/*`/operations"` to their + # service configuration. For backwards compatibility, the default name includes + # the operations collection id, however overriding users must ensure the name + # binding is the parent resource, without the operations collection id. + # @param [String] name + # The name of the operation's parent resource. + # @param [String] filter + # The standard list filter. + # @param [Fixnum] page_size + # The standard list page size. + # @param [String] page_token + # The standard list page token. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::DialogflowV3beta1::GoogleLongrunningListOperationsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::DialogflowV3beta1::GoogleLongrunningListOperationsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_project_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v3beta1/{+name}/operations', options) + command.response_representation = Google::Apis::DialogflowV3beta1::GoogleLongrunningListOperationsResponse::Representation + command.response_class = Google::Apis::DialogflowV3beta1::GoogleLongrunningListOperationsResponse + command.params['name'] = name unless name.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + protected + + def apply_command_defaults(command) + command.query['key'] = key unless key.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + end + end + end + end +end diff --git a/generated/google/apis/firebaseml_v1beta2.rb b/generated/google/apis/firebaseml_v1beta2.rb index c58b88a13..e56095f64 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 = '20200803' + REVISION = '20200814' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firebaseml_v1beta2/classes.rb b/generated/google/apis/firebaseml_v1beta2/classes.rb index ad62ce15b..f64aa82bd 100644 --- a/generated/google/apis/firebaseml_v1beta2/classes.rb +++ b/generated/google/apis/firebaseml_v1beta2/classes.rb @@ -315,13 +315,6 @@ module Google # @return [String] attr_accessor :gcs_tflite_uri - # Output only. A boolean indicating that this model was uploaded from the - # console. Read only - # Corresponds to the JSON property `managedUpload` - # @return [Boolean] - attr_accessor :managed_upload - alias_method :managed_upload?, :managed_upload - # Output only. The size of the TFLite model # Corresponds to the JSON property `sizeBytes` # @return [String] @@ -334,7 +327,6 @@ module Google # Update properties of this object def update!(**args) @gcs_tflite_uri = args[:gcs_tflite_uri] if args.key?(:gcs_tflite_uri) - @managed_upload = args[:managed_upload] if args.key?(:managed_upload) @size_bytes = args[:size_bytes] if args.key?(:size_bytes) end end diff --git a/generated/google/apis/firebaseml_v1beta2/representations.rb b/generated/google/apis/firebaseml_v1beta2/representations.rb index c75b77dfb..12450f4dd 100644 --- a/generated/google/apis/firebaseml_v1beta2/representations.rb +++ b/generated/google/apis/firebaseml_v1beta2/representations.rb @@ -146,7 +146,6 @@ module Google # @private class Representation < Google::Apis::Core::JsonRepresentation property :gcs_tflite_uri, as: 'gcsTfliteUri' - property :managed_upload, as: 'managedUpload' property :size_bytes, as: 'sizeBytes' end end diff --git a/generated/google/apis/firestore_v1.rb b/generated/google/apis/firestore_v1.rb index 19f51301b..a584507e6 100644 --- a/generated/google/apis/firestore_v1.rb +++ b/generated/google/apis/firestore_v1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/firestore module FirestoreV1 VERSION = 'V1' - REVISION = '20200725' + 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/firestore_v1/classes.rb b/generated/google/apis/firestore_v1/classes.rb index da5f8b734..f8e17b48d 100644 --- a/generated/google/apis/firestore_v1/classes.rb +++ b/generated/google/apis/firestore_v1/classes.rb @@ -45,19 +45,18 @@ module Google class BatchGetDocumentsRequest include Google::Apis::Core::Hashable - # The names of the documents to retrieve. In the format: - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. - # The request will fail if any of the document is not a child resource of the - # given `database`. Duplicate names will be elided. + # The names of the documents to retrieve. In the format: `projects/`project_id`/ + # databases/`database_id`/documents/`document_path``. The request will fail if + # any of the document is not a child resource of the given `database`. Duplicate + # names will be elided. # Corresponds to the JSON property `documents` # @return [Array] attr_accessor :documents - # A set of field paths on a document. - # Used to restrict a get or update operation on a document to a subset of its - # fields. - # This is different from standard field masks, as this is always scoped to a - # Document, and takes in account the dynamic nature of Value. + # A set of field paths on a document. Used to restrict a get or update operation + # on a document to a subset of its fields. This is different from standard field + # masks, as this is always scoped to a Document, and takes in account the + # dynamic nature of Value. # Corresponds to the JSON property `mask` # @return [Google::Apis::FirestoreV1::DocumentMask] attr_accessor :mask @@ -67,8 +66,8 @@ module Google # @return [Google::Apis::FirestoreV1::TransactionOptions] attr_accessor :new_transaction - # Reads documents as they were at the given time. - # This may not be older than 270 seconds. + # Reads documents as they were at the given time. This may not be older than 270 + # seconds. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -97,29 +96,27 @@ module Google class BatchGetDocumentsResponse include Google::Apis::Core::Hashable - # A Firestore document. - # Must not exceed 1 MiB - 4 bytes. + # A Firestore document. Must not exceed 1 MiB - 4 bytes. # Corresponds to the JSON property `found` # @return [Google::Apis::FirestoreV1::Document] attr_accessor :found - # A document name that was requested but does not exist. In the format: - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. + # A document name that was requested but does not exist. In the format: ` + # projects/`project_id`/databases/`database_id`/documents/`document_path``. # Corresponds to the JSON property `missing` # @return [String] attr_accessor :missing - # The time at which the document was read. - # This may be monotically increasing, in this case the previous documents in - # the result stream are guaranteed not to have changed between their - # read_time and this one. + # The time at which the document was read. This may be monotically increasing, + # in this case the previous documents in the result stream are guaranteed not to + # have changed between their read_time and this one. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time - # The transaction that was started as part of this request. - # Will only be set in the first response, and only if - # BatchGetDocumentsRequest.new_transaction was set in the request. + # The transaction that was started as part of this request. Will only be set in + # the first response, and only if BatchGetDocumentsRequest.new_transaction was + # set in the request. # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -147,10 +144,9 @@ module Google # @return [Hash] attr_accessor :labels - # The writes to apply. - # Method does not apply writes atomically and does not guarantee ordering. - # Each write succeeds or fails independently. You cannot write to the same - # document more than once per request. + # The writes to apply. Method does not apply writes atomically and does not + # guarantee ordering. Each write succeeds or fails independently. You cannot + # write to the same document more than once per request. # Corresponds to the JSON property `writes` # @return [Array] attr_accessor :writes @@ -170,16 +166,14 @@ module Google class BatchWriteResponse include Google::Apis::Core::Hashable - # The status of applying the writes. - # This i-th write status corresponds to the i-th write in the - # request. + # The status of applying the writes. This i-th write status corresponds to the i- + # th write in the request. # Corresponds to the JSON property `status` # @return [Array] attr_accessor :status - # The result of applying the writes. - # This i-th write result corresponds to the i-th write in the - # request. + # The result of applying the writes. This i-th write result corresponds to the i- + # th write in the request. # Corresponds to the JSON property `writeResults` # @return [Array] attr_accessor :write_results @@ -238,16 +232,15 @@ module Google class CollectionSelector include Google::Apis::Core::Hashable - # When false, selects only collections that are immediate children of - # the `parent` specified in the containing `RunQueryRequest`. - # When true, selects all descendant collections. + # When false, selects only collections that are immediate children of the ` + # parent` specified in the containing `RunQueryRequest`. When true, selects all + # descendant collections. # Corresponds to the JSON property `allDescendants` # @return [Boolean] attr_accessor :all_descendants alias_method :all_descendants?, :all_descendants - # The collection ID. - # When set, selects only collections with this ID. + # The collection ID. When set, selects only collections with this ID. # Corresponds to the JSON property `collectionId` # @return [String] attr_accessor :collection_id @@ -273,8 +266,7 @@ module Google # @return [String] attr_accessor :transaction - # The writes to apply. - # Always executed atomically and in order. + # The writes to apply. Always executed atomically and in order. # Corresponds to the JSON property `writes` # @return [Array] attr_accessor :writes @@ -294,15 +286,14 @@ module Google class CommitResponse include Google::Apis::Core::Hashable - # The time at which the commit occurred. Any read with an equal or greater - # `read_time` is guaranteed to see the effects of the commit. + # The time at which the commit occurred. Any read with an equal or greater ` + # read_time` is guaranteed to see the effects of the commit. # Corresponds to the JSON property `commitTime` # @return [String] attr_accessor :commit_time - # The result of applying the writes. - # This i-th write result corresponds to the i-th write in the - # request. + # The result of applying the writes. This i-th write result corresponds to the i- + # th write in the request. # Corresponds to the JSON property `writeResults` # @return [Array] attr_accessor :write_results @@ -322,8 +313,7 @@ module Google class CompositeFilter include Google::Apis::Core::Hashable - # The list of filters to combine. - # Must contain at least one filter. + # The list of filters to combine. Must contain at least one filter. # Corresponds to the JSON property `filters` # @return [Array] attr_accessor :filters @@ -348,16 +338,16 @@ module Google class Cursor include Google::Apis::Core::Hashable - # If the position is just before or just after the given values, relative - # to the sort order defined by the query. + # If the position is just before or just after the given values, relative to the + # sort order defined by the query. # Corresponds to the JSON property `before` # @return [Boolean] attr_accessor :before alias_method :before?, :before - # The values that represent a position, in the order they appear in - # the order by clause of a query. - # Can contain fewer values than specified in the order by clause. + # The values that represent a position, in the order they appear in the order by + # clause of a query. Can contain fewer values than specified in the order by + # clause. # Corresponds to the JSON property `values` # @return [Array] attr_accessor :values @@ -373,52 +363,45 @@ module Google end end - # A Firestore document. - # Must not exceed 1 MiB - 4 bytes. + # A Firestore document. Must not exceed 1 MiB - 4 bytes. class Document include Google::Apis::Core::Hashable - # Output only. The time at which the document was created. - # This value increases monotonically when a document is deleted then - # recreated. It can also be compared to values from other documents and - # the `read_time` of a query. + # Output only. The time at which the document was created. This value increases + # monotonically when a document is deleted then recreated. It can also be + # compared to values from other documents and the `read_time` of a query. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time - # The document's fields. - # The map keys represent field names. - # A simple field name contains only characters `a` to `z`, `A` to `Z`, - # `0` to `9`, or `_`, and must not start with `0` to `9`. For example, - # `foo_bar_17`. - # Field names matching the regular expression `__.*__` are reserved. Reserved - # field names are forbidden except in certain documented contexts. The map - # keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be - # empty. - # Field paths may be used in other contexts to refer to structured fields - # defined here. For `map_value`, the field path is represented by the simple - # or quoted field names of the containing fields, delimited by `.`. For - # example, the structured field - # `"foo" : ` map_value: ` "x&y" : ` string_value: "hello" ```` would be - # represented by the field path `foo.x&y`. - # Within a field path, a quoted field name starts and ends with `` ` `` and - # may contain any character. Some characters, including `` ` ``, must be - # escaped using a `\`. For example, `` `x&y` `` represents `x&y` and - # `` `bak\`tik` `` represents `` bak`tik ``. + # The document's fields. The map keys represent field names. A simple field name + # contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must + # not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the + # regular expression `__.*__` are reserved. Reserved field names are forbidden + # except in certain documented contexts. The map keys, represented as UTF-8, + # must not exceed 1,500 bytes and cannot be empty. Field paths may be used in + # other contexts to refer to structured fields defined here. For `map_value`, + # the field path is represented by the simple or quoted field names of the + # containing fields, delimited by `.`. For example, the structured field `"foo" : + # ` map_value: ` "x&y" : ` string_value: "hello" ```` would be represented by + # the field path `foo.x&y`. Within a field path, a quoted field name starts and + # ends with `` ` `` and may contain any character. Some characters, including `` + # ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` + # and `` `bak\`tik` `` represents `` bak`tik ``. # Corresponds to the JSON property `fields` # @return [Hash] attr_accessor :fields - # The resource name of the document, for example - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. + # The resource name of the document, for example `projects/`project_id`/ + # databases/`database_id`/documents/`document_path``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Output only. The time at which the document was last changed. - # This value is initially set to the `create_time` then increases - # monotonically with each change to the document. It can also be - # compared to values from other documents and the `read_time` of a query. + # Output only. The time at which the document was last changed. This value is + # initially set to the `create_time` then increases monotonically with each + # change to the document. It can also be compared to values from other documents + # and the `read_time` of a query. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -436,16 +419,14 @@ module Google end end - # A Document has changed. - # May be the result of multiple writes, including deletes, that - # ultimately resulted in a new value for the Document. - # Multiple DocumentChange messages may be returned for the same logical - # change, if multiple targets are affected. + # A Document has changed. May be the result of multiple writes, including + # deletes, that ultimately resulted in a new value for the Document. Multiple + # DocumentChange messages may be returned for the same logical change, if + # multiple targets are affected. class DocumentChange include Google::Apis::Core::Hashable - # A Firestore document. - # Must not exceed 1 MiB - 4 bytes. + # A Firestore document. Must not exceed 1 MiB - 4 bytes. # Corresponds to the JSON property `document` # @return [Google::Apis::FirestoreV1::Document] attr_accessor :document @@ -472,11 +453,10 @@ module Google end end - # A Document has been deleted. - # May be the result of multiple writes, including updates, the - # last of which deleted the Document. - # Multiple DocumentDelete messages may be returned for the same logical - # delete, if multiple targets are affected. + # A Document has been deleted. May be the result of multiple writes, including + # updates, the last of which deleted the Document. Multiple DocumentDelete + # messages may be returned for the same logical delete, if multiple targets are + # affected. class DocumentDelete include Google::Apis::Core::Hashable @@ -485,8 +465,8 @@ module Google # @return [String] attr_accessor :document - # The read timestamp at which the delete was observed. - # Greater or equal to the `commit_time` of the delete. + # The read timestamp at which the delete was observed. Greater or equal to the ` + # commit_time` of the delete. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -508,16 +488,15 @@ module Google end end - # A set of field paths on a document. - # Used to restrict a get or update operation on a document to a subset of its - # fields. - # This is different from standard field masks, as this is always scoped to a - # Document, and takes in account the dynamic nature of Value. + # A set of field paths on a document. Used to restrict a get or update operation + # on a document to a subset of its fields. This is different from standard field + # masks, as this is always scoped to a Document, and takes in account the + # dynamic nature of Value. class DocumentMask include Google::Apis::Core::Hashable - # The list of field paths in the mask. See Document.fields for a field - # path syntax reference. + # The list of field paths in the mask. See Document.fields for a field path + # syntax reference. # Corresponds to the JSON property `fieldPaths` # @return [Array] attr_accessor :field_paths @@ -532,12 +511,11 @@ module Google end end - # A Document has been removed from the view of the targets. - # Sent if the document is no longer relevant to a target and is out of view. - # Can be sent instead of a DocumentDelete or a DocumentChange if the server - # can not send the new value of the document. - # Multiple DocumentRemove messages may be returned for the same logical - # write or delete, if multiple targets are affected. + # A Document has been removed from the view of the targets. Sent if the document + # is no longer relevant to a target and is out of view. Can be sent instead of a + # DocumentDelete or a DocumentChange if the server can not send the new value of + # the document. Multiple DocumentRemove messages may be returned for the same + # logical write or delete, if multiple targets are affected. class DocumentRemove include Google::Apis::Core::Hashable @@ -546,8 +524,8 @@ module Google # @return [String] attr_accessor :document - # The read timestamp at which the remove was observed. - # Greater or equal to the `commit_time` of the change/delete/remove. + # The read timestamp at which the remove was observed. Greater or equal to the ` + # commit_time` of the change/delete/remove. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -578,8 +556,7 @@ module Google # @return [String] attr_accessor :document - # The list of transformations to apply to the fields of the document, in - # order. + # The list of transformations to apply to the fields of the document, in order. # This must not be empty. # Corresponds to the JSON property `fieldTransforms` # @return [Array] @@ -600,10 +577,10 @@ module Google class DocumentsTarget include Google::Apis::Core::Hashable - # The names of the documents to retrieve. In the format: - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. - # The request will fail if any of the document is not a child resource of - # the given `database`. Duplicate names will be elided. + # The names of the documents to retrieve. In the format: `projects/`project_id`/ + # databases/`database_id`/documents/`document_path``. The request will fail if + # any of the document is not a child resource of the given `database`. Duplicate + # names will be elided. # Corresponds to the JSON property `documents` # @return [Array] attr_accessor :documents @@ -618,13 +595,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 @@ -641,9 +616,9 @@ module Google class ExistenceFilter include Google::Apis::Core::Hashable - # The total count of documents that match target_id. - # If different from the count of documents in the client that match, the - # client must manually determine which documents no longer match the target. + # The total count of documents that match target_id. If different from the count + # of documents in the client that match, the client must manually determine + # which documents no longer match the target. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count @@ -723,8 +698,7 @@ module Google # @return [Google::Apis::FirestoreV1::ArrayValue] attr_accessor :append_missing_elements - # The path of the field. See Document.fields for the field path syntax - # reference. + # The path of the field. See Document.fields for the field path syntax reference. # Corresponds to the JSON property `fieldPath` # @return [String] attr_accessor :field_path @@ -801,8 +775,8 @@ module Google end end - # Metadata for google.longrunning.Operation results from - # FirestoreAdmin.ExportDocuments. + # Metadata for google.longrunning.Operation results from FirestoreAdmin. + # ExportDocuments. class GoogleFirestoreAdminV1ExportDocumentsMetadata include Google::Apis::Core::Hashable @@ -827,16 +801,14 @@ module Google # @return [String] attr_accessor :output_uri_prefix - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. # Corresponds to the JSON property `progressBytes` # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress] attr_accessor :progress_bytes - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. # Corresponds to the JSON property `progressDocuments` # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress] attr_accessor :progress_documents @@ -871,14 +843,13 @@ module Google # @return [Array] attr_accessor :collection_ids - # The output URI. Currently only supports Google Cloud Storage URIs of the - # form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name - # of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional - # Google Cloud Storage namespace path. When - # choosing a name, be sure to consider Google Cloud Storage naming - # guidelines: https://cloud.google.com/storage/docs/naming. - # If the URI is a bucket (without a namespace path), a prefix will be - # generated based on the start time. + # The output URI. Currently only supports Google Cloud Storage URIs of the form: + # `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the + # Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud + # Storage namespace path. When choosing a name, be sure to consider Google Cloud + # Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If + # the URI is a bucket (without a namespace path), a prefix will be generated + # based on the start time. # Corresponds to the JSON property `outputUriPrefix` # @return [String] attr_accessor :output_uri_prefix @@ -898,9 +869,9 @@ module Google class GoogleFirestoreAdminV1ExportDocumentsResponse include Google::Apis::Core::Hashable - # Location of the output files. This can be used to begin an import - # into Cloud Firestore (this project or another project) after the operation - # completes successfully. + # Location of the output files. This can be used to begin an import into Cloud + # Firestore (this project or another project) after the operation completes + # successfully. # Corresponds to the JSON property `outputUriPrefix` # @return [String] attr_accessor :output_uri_prefix @@ -915,9 +886,9 @@ module Google end end - # Represents a single field in the database. - # Fields are grouped by their "Collection Group", which represent all - # collections in the database with the same id. + # Represents a single field in the database. Fields are grouped by their " + # Collection Group", which represent all collections in the database with the + # same id. class GoogleFirestoreAdminV1Field include Google::Apis::Core::Hashable @@ -926,28 +897,21 @@ module Google # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexConfig] attr_accessor :index_config - # A field name of the form - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # /fields/`field_path`` - # A field path may be a simple field name, e.g. `address` or a path to fields - # within map_value , e.g. `address.city`, - # or a special field path. The only valid special field is `*`, which - # represents any field. - # Field paths may be quoted using ` (backtick). The only character that needs - # to be escaped within a quoted field path is the backtick character itself, - # escaped using a backslash. Special characters in field paths that - # must be quoted include: `*`, `.`, - # ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. - # Examples: - # (Note: Comments here are written in markdown syntax, so there is an - # additional layer of backticks to represent a code block) - # `\`address.city\`` represents a field named `address.city`, not the map key - # `city` in the field `address`. - # `\`*\`` represents a field named `*`, not any field. - # A special `Field` contains the default indexing settings for all fields. - # This field's resource name is: - # `projects/`project_id`/databases/`database_id`/collectionGroups/__default__/ - # fields/*` + # A field name of the form `projects/`project_id`/databases/`database_id`/ + # collectionGroups/`collection_id`/fields/`field_path`` A field path may be a + # simple field name, e.g. `address` or a path to fields within map_value , e.g. ` + # address.city`, or a special field path. The only valid special field is `*`, + # which represents any field. Field paths may be quoted using ` (backtick). The + # only character that needs to be escaped within a quoted field path is the + # backtick character itself, escaped using a backslash. Special characters in + # field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, + # as well as any ascii symbolic characters. Examples: (Note: Comments here are + # written in markdown syntax, so there is an additional layer of backticks to + # represent a code block) `\`address.city\`` represents a field named `address. + # city`, not the map key `city` in the field `address`. `\`*\`` represents a + # field named `*`, not any field. A special `Field` contains the default + # indexing settings for all fields. This field's resource name is: `projects/` + # project_id`/databases/`database_id`/collectionGroups/__default__/fields/*` # Indexes defined on this `Field` will be applied to all fields which do not # have their own `Field` index configuration. # Corresponds to the JSON property `name` @@ -965,8 +929,8 @@ module Google end end - # Metadata for google.longrunning.Operation results from - # FirestoreAdmin.UpdateField. + # Metadata for google.longrunning.Operation results from FirestoreAdmin. + # UpdateField. class GoogleFirestoreAdminV1FieldOperationMetadata include Google::Apis::Core::Hashable @@ -976,29 +940,26 @@ module Google # @return [String] attr_accessor :end_time - # The field resource that this operation is acting on. For example: - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # /fields/`field_path`` + # The field resource that this operation is acting on. For example: `projects/` + # project_id`/databases/`database_id`/collectionGroups/`collection_id`/fields/` + # field_path`` # Corresponds to the JSON property `field` # @return [String] attr_accessor :field - # A list of IndexConfigDelta, which describe the intent of this - # operation. + # A list of IndexConfigDelta, which describe the intent of this operation. # Corresponds to the JSON property `indexConfigDeltas` # @return [Array] attr_accessor :index_config_deltas - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. # Corresponds to the JSON property `progressBytes` # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress] attr_accessor :progress_bytes - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. # Corresponds to the JSON property `progressDocuments` # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress] attr_accessor :progress_documents @@ -1029,8 +990,8 @@ module Google end end - # Metadata for google.longrunning.Operation results from - # FirestoreAdmin.ImportDocuments. + # Metadata for google.longrunning.Operation results from FirestoreAdmin. + # ImportDocuments. class GoogleFirestoreAdminV1ImportDocumentsMetadata include Google::Apis::Core::Hashable @@ -1055,16 +1016,14 @@ module Google # @return [String] attr_accessor :operation_state - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. # Corresponds to the JSON property `progressBytes` # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress] attr_accessor :progress_bytes - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. # Corresponds to the JSON property `progressDocuments` # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress] attr_accessor :progress_documents @@ -1094,16 +1053,14 @@ module Google class GoogleFirestoreAdminV1ImportDocumentsRequest include Google::Apis::Core::Hashable - # Which collection ids to import. Unspecified means all collections included - # in the import. + # Which collection ids to import. Unspecified means all collections included in + # the import. # Corresponds to the JSON property `collectionIds` # @return [Array] attr_accessor :collection_ids - # Location of the exported files. - # This must match the output_uri_prefix of an ExportDocumentsResponse from - # an export that has completed successfully. - # See: + # Location of the exported files. This must match the output_uri_prefix of an + # ExportDocumentsResponse from an export that has completed successfully. See: # google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix. # Corresponds to the JSON property `inputUriPrefix` # @return [String] @@ -1120,39 +1077,37 @@ module Google end end - # Cloud Firestore indexes enable simple and complex queries against - # documents in a database. + # Cloud Firestore indexes enable simple and complex queries against documents in + # a database. class GoogleFirestoreAdminV1Index include Google::Apis::Core::Hashable - # The fields supported by this index. - # For composite indexes, this is always 2 or more fields. - # The last field entry is always for the field path `__name__`. If, on - # creation, `__name__` was not specified as the last field, it will be added + # The fields supported by this index. For composite indexes, this is always 2 or + # more fields. The last field entry is always for the field path `__name__`. If, + # on creation, `__name__` was not specified as the last field, it will be added # automatically with the same direction as that of the last field defined. If - # the final field in a composite index is not directional, the `__name__` - # will be ordered ASCENDING (unless explicitly specified). - # For single field indexes, this will always be exactly one entry with a - # field path equal to the field path of the associated field. + # the final field in a composite index is not directional, the `__name__` will + # be ordered ASCENDING (unless explicitly specified). For single field indexes, + # this will always be exactly one entry with a field path equal to the field + # path of the associated field. # Corresponds to the JSON property `fields` # @return [Array] attr_accessor :fields - # Output only. A server defined name for this index. - # The form of this name for composite indexes will be: - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # /indexes/`composite_index_id`` - # For single field indexes, this field will be empty. + # Output only. A server defined name for this index. The form of this name for + # composite indexes will be: `projects/`project_id`/databases/`database_id`/ + # collectionGroups/`collection_id`/indexes/`composite_index_id`` For single + # field indexes, this field will be empty. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Indexes with a collection query scope specified allow queries - # against a collection that is the child of a specific document, specified at - # query time, and that has the same collection id. - # Indexes with a collection group query scope specified allow queries against - # all collections descended from a specific document, specified at query - # time, and that have the same collection id as this index. + # Indexes with a collection query scope specified allow queries against a + # collection that is the child of a specific document, specified at query time, + # and that has the same collection id. Indexes with a collection group query + # scope specified allow queries against all collections descended from a + # specific document, specified at query time, and that have the same collection + # id as this index. # Corresponds to the JSON property `queryScope` # @return [String] attr_accessor :query_scope @@ -1180,10 +1135,9 @@ module Google include Google::Apis::Core::Hashable # Output only. Specifies the resource name of the `Field` from which this field' - # s - # index configuration is set (when `uses_ancestor_config` is true), - # or from which it *would* be set if this field had no index configuration - # (when `uses_ancestor_config` is false). + # s index configuration is set (when `uses_ancestor_config` is true), or from + # which it *would* be set if this field had no index configuration (when ` + # uses_ancestor_config` is false). # Corresponds to the JSON property `ancestorField` # @return [String] attr_accessor :ancestor_field @@ -1193,19 +1147,18 @@ module Google # @return [Array] attr_accessor :indexes - # Output only - # When true, the `Field`'s index configuration is in the process of being - # reverted. Once complete, the index config will transition to the same - # state as the field specified by `ancestor_field`, at which point - # `uses_ancestor_config` will be `true` and `reverting` will be `false`. + # Output only When true, the `Field`'s index configuration is in the process of + # being reverted. Once complete, the index config will transition to the same + # state as the field specified by `ancestor_field`, at which point ` + # uses_ancestor_config` will be `true` and `reverting` will be `false`. # Corresponds to the JSON property `reverting` # @return [Boolean] attr_accessor :reverting alias_method :reverting?, :reverting # Output only. When true, the `Field`'s index configuration is set from the - # configuration specified by the `ancestor_field`. - # When false, the `Field`'s index configuration is defined explicitly. + # configuration specified by the `ancestor_field`. When false, the `Field`'s + # index configuration is defined explicitly. # Corresponds to the JSON property `usesAncestorConfig` # @return [Boolean] attr_accessor :uses_ancestor_config @@ -1233,8 +1186,8 @@ module Google # @return [String] attr_accessor :change_type - # Cloud Firestore indexes enable simple and complex queries against - # documents in a database. + # Cloud Firestore indexes enable simple and complex queries against documents in + # a database. # Corresponds to the JSON property `index` # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index] attr_accessor :index @@ -1250,9 +1203,8 @@ module Google end end - # A field in an index. - # The field_path describes which field is indexed, the value_mode describes - # how the field value is indexed. + # A field in an index. The field_path describes which field is indexed, the + # value_mode describes how the field value is indexed. class GoogleFirestoreAdminV1IndexField include Google::Apis::Core::Hashable @@ -1261,9 +1213,8 @@ module Google # @return [String] attr_accessor :array_config - # Can be __name__. - # For single field indexes, this must match the name of the field or may - # be omitted. + # Can be __name__. For single field indexes, this must match the name of the + # field or may be omitted. # Corresponds to the JSON property `fieldPath` # @return [String] attr_accessor :field_path @@ -1286,8 +1237,8 @@ module Google end end - # Metadata for google.longrunning.Operation results from - # FirestoreAdmin.CreateIndex. + # Metadata for google.longrunning.Operation results from FirestoreAdmin. + # CreateIndex. class GoogleFirestoreAdminV1IndexOperationMetadata include Google::Apis::Core::Hashable @@ -1297,23 +1248,21 @@ module Google # @return [String] attr_accessor :end_time - # The index resource that this operation is acting on. For example: - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # /indexes/`index_id`` + # The index resource that this operation is acting on. For example: `projects/` + # project_id`/databases/`database_id`/collectionGroups/`collection_id`/indexes/` + # index_id`` # Corresponds to the JSON property `index` # @return [String] attr_accessor :index - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. # Corresponds to the JSON property `progressBytes` # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress] attr_accessor :progress_bytes - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. # Corresponds to the JSON property `progressDocuments` # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress] attr_accessor :progress_documents @@ -1408,9 +1357,8 @@ module Google end end - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. class GoogleFirestoreAdminV1Progress include Google::Apis::Core::Hashable @@ -1478,47 +1426,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::FirestoreV1::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 @@ -1539,9 +1485,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 @@ -1575,8 +1520,7 @@ module Google # @return [Fixnum] attr_accessor :page_size - # A page token. Must be a value from - # ListCollectionIdsResponse. + # A page token. Must be a value from ListCollectionIdsResponse. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token @@ -1702,30 +1646,27 @@ module Google class ListenResponse include Google::Apis::Core::Hashable - # A Document has changed. - # May be the result of multiple writes, including deletes, that - # ultimately resulted in a new value for the Document. - # Multiple DocumentChange messages may be returned for the same logical - # change, if multiple targets are affected. + # A Document has changed. May be the result of multiple writes, including + # deletes, that ultimately resulted in a new value for the Document. Multiple + # DocumentChange messages may be returned for the same logical change, if + # multiple targets are affected. # Corresponds to the JSON property `documentChange` # @return [Google::Apis::FirestoreV1::DocumentChange] attr_accessor :document_change - # A Document has been deleted. - # May be the result of multiple writes, including updates, the - # last of which deleted the Document. - # Multiple DocumentDelete messages may be returned for the same logical - # delete, if multiple targets are affected. + # A Document has been deleted. May be the result of multiple writes, including + # updates, the last of which deleted the Document. Multiple DocumentDelete + # messages may be returned for the same logical delete, if multiple targets are + # affected. # Corresponds to the JSON property `documentDelete` # @return [Google::Apis::FirestoreV1::DocumentDelete] attr_accessor :document_delete - # A Document has been removed from the view of the targets. - # Sent if the document is no longer relevant to a target and is out of view. - # Can be sent instead of a DocumentDelete or a DocumentChange if the server - # can not send the new value of the document. - # Multiple DocumentRemove messages may be returned for the same logical - # write or delete, if multiple targets are affected. + # A Document has been removed from the view of the targets. Sent if the document + # is no longer relevant to a target and is out of view. Can be sent instead of a + # DocumentDelete or a DocumentChange if the server can not send the new value of + # the document. Multiple DocumentRemove messages may be returned for the same + # logical write or delete, if multiple targets are affected. # Corresponds to the JSON property `documentRemove` # @return [Google::Apis::FirestoreV1::DocumentRemove] attr_accessor :document_remove @@ -1758,14 +1699,14 @@ module Google class Location include Google::Apis::Core::Hashable - # The friendly name for this location, typically a nearby city name. - # For example, "Tokyo". + # The friendly name for this location, typically a nearby city name. For example, + # "Tokyo". # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Cross-service attributes for the location. For example - # `"cloud.googleapis.com/region": "us-east1"` + # Cross-service attributes for the location. For example `"cloud.googleapis.com/ + # region": "us-east1"` # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -1781,8 +1722,8 @@ module Google # @return [Hash] attr_accessor :metadata - # Resource name for the location, which may vary between implementations. - # For example: `"projects/example-project/locations/us-east1"` + # Resource name for the location, which may vary between implementations. For + # example: `"projects/example-project/locations/us-east1"` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -1805,11 +1746,10 @@ module Google class MapValue include Google::Apis::Core::Hashable - # The map's fields. - # The map keys represent field names. Field names matching the regular - # expression `__.*__` are reserved. Reserved field names are forbidden except - # in certain documented contexts. The map keys, represented as UTF-8, must - # not exceed 1,500 bytes and cannot be empty. + # The map's fields. The map keys represent field names. Field names matching the + # regular expression `__.*__` are reserved. Reserved field names are forbidden + # except in certain documented contexts. The map keys, represented as UTF-8, + # must not exceed 1,500 bytes and cannot be empty. # Corresponds to the JSON property `fields` # @return [Hash] attr_accessor :fields @@ -1853,37 +1793,34 @@ module Google class PartitionQueryRequest include Google::Apis::Core::Hashable - # The maximum number of partitions to return in this call, subject to - # `partition_count`. - # For example, if `partition_count` = 10 and `page_size` = 8, the first call - # to PartitionQuery will return up to 8 partitions and a `next_page_token` - # if more results exist. A second call to PartitionQuery will return up to - # 2 partitions, to complete the total of 10 specified in `partition_count`. + # The maximum number of partitions to return in this call, subject to ` + # partition_count`. For example, if `partition_count` = 10 and `page_size` = 8, + # the first call to PartitionQuery will return up to 8 partitions and a ` + # next_page_token` if more results exist. A second call to PartitionQuery will + # return up to 2 partitions, to complete the total of 10 specified in ` + # partition_count`. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size - # The `next_page_token` value returned from a previous call to - # PartitionQuery that may be used to get an additional set of results. - # There are no ordering guarantees between sets of results. Thus, using - # multiple sets of results will require merging the different result sets. - # For example, two subsequent calls using a page_token may return: - # * cursor B, cursor M, cursor Q - # * cursor A, cursor U, cursor W - # To obtain a complete result set ordered with respect to the results of the - # query supplied to PartitionQuery, the results sets should be merged: - # cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W + # The `next_page_token` value returned from a previous call to PartitionQuery + # that may be used to get an additional set of results. There are no ordering + # guarantees between sets of results. Thus, using multiple sets of results will + # require merging the different result sets. For example, two subsequent calls + # using a page_token may return: * cursor B, cursor M, cursor Q * cursor A, + # cursor U, cursor W To obtain a complete result set ordered with respect to the + # results of the query supplied to PartitionQuery, the results sets should be + # merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token - # The desired maximum number of partition points. - # The partitions may be returned across multiple pages of results. - # The number must be strictly positive. The actual number of partitions - # returned may be fewer. - # For example, this may be set to one fewer than the number of parallel - # queries to be run, or in running a data pipeline job, one fewer than the - # number of workers or compute instances available. + # The desired maximum number of partition points. The partitions may be returned + # across multiple pages of results. The number must be positive. The actual + # number of partitions returned may be fewer. For example, this may be set to + # one fewer than the number of parallel queries to be run, or in running a data + # pipeline job, one fewer than the number of workers or compute instances + # available. # Corresponds to the JSON property `partitionCount` # @return [Fixnum] attr_accessor :partition_count @@ -1910,25 +1847,22 @@ module Google class PartitionQueryResponse include Google::Apis::Core::Hashable - # A page token that may be used to request an additional set of results, up - # to the number specified by `partition_count` in the PartitionQuery request. - # If blank, there are no more results. + # A page token that may be used to request an additional set of results, up to + # the number specified by `partition_count` in the PartitionQuery request. If + # blank, there are no more results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # Partition results. - # Each partition is a split point that can be used by RunQuery as a starting - # or end point for the query results. The RunQuery requests must be made with - # the same query supplied to this PartitionQuery request. The partition - # cursors will be ordered according to same ordering as the results of the - # query supplied to PartitionQuery. - # For example, if a PartitionQuery request returns partition cursors A and B, - # running the following three queries will return the entire result set of - # the original query: - # * query, end_at A - # * query, start_at A, end_at B - # * query, start_at B + # Partition results. Each partition is a split point that can be used by + # RunQuery as a starting or end point for the query results. The RunQuery + # requests must be made with the same query supplied to this PartitionQuery + # request. The partition cursors will be ordered according to same ordering as + # the results of the query supplied to PartitionQuery. For example, if a + # PartitionQuery request returns partition cursors A and B, running the + # following three queries will return the entire result set of the original + # query: * query, end_at A * query, start_at A, end_at B * query, start_at B An + # empty result may indicate that the query has too few results to be partitioned. # Corresponds to the JSON property `partitions` # @return [Array] attr_accessor :partitions @@ -1948,15 +1882,15 @@ module Google class Precondition include Google::Apis::Core::Hashable - # When set to `true`, the target document must exist. - # When set to `false`, the target document must not exist. + # When set to `true`, the target document must exist. When set to `false`, the + # target document must not exist. # Corresponds to the JSON property `exists` # @return [Boolean] attr_accessor :exists alias_method :exists?, :exists - # When set, the target document must exist and have been last updated at - # that time. + # When set, the target document must exist and have been last updated at that + # time. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -1976,9 +1910,8 @@ module Google class Projection include Google::Apis::Core::Hashable - # The fields to return. - # If empty, all fields are returned. To only return the name - # of the document, use `['__name__']`. + # The fields to return. If empty, all fields are returned. To only return the + # name of the document, use `['__name__']`. # Corresponds to the JSON property `fields` # @return [Array] attr_accessor :fields @@ -1997,12 +1930,11 @@ module Google class QueryTarget include Google::Apis::Core::Hashable - # The parent resource name. In the format: - # `projects/`project_id`/databases/`database_id`/documents` or - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. - # For example: - # `projects/my-project/databases/my-database/documents` or - # `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + # The parent resource name. In the format: `projects/`project_id`/databases/` + # database_id`/documents` or `projects/`project_id`/databases/`database_id`/ + # documents/`document_path``. For example: `projects/my-project/databases/my- + # database/documents` or `projects/my-project/databases/my-database/documents/ + # chatrooms/my-chatroom` # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -2027,8 +1959,7 @@ module Google class ReadOnly include Google::Apis::Core::Hashable - # Reads documents at the given time. - # This may not be older than 60 seconds. + # Reads documents at the given time. This may not be older than 60 seconds. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -2092,8 +2023,8 @@ module Google # @return [Google::Apis::FirestoreV1::TransactionOptions] attr_accessor :new_transaction - # Reads documents as they were at the given time. - # This may not be older than 270 seconds. + # Reads documents as they were at the given time. This may not be older than 270 + # seconds. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -2126,32 +2057,29 @@ module Google class RunQueryResponse include Google::Apis::Core::Hashable - # A Firestore document. - # Must not exceed 1 MiB - 4 bytes. + # A Firestore document. Must not exceed 1 MiB - 4 bytes. # Corresponds to the JSON property `document` # @return [Google::Apis::FirestoreV1::Document] attr_accessor :document - # The time at which the document was read. This may be monotonically - # increasing; in this case, the previous documents in the result stream are - # guaranteed not to have changed between their `read_time` and this one. - # If the query returns no results, a response with `read_time` and no - # `document` will be sent, and this represents the time at which the query - # was run. + # The time at which the document was read. This may be monotonically increasing; + # in this case, the previous documents in the result stream are guaranteed not + # to have changed between their `read_time` and this one. If the query returns + # no results, a response with `read_time` and no `document` will be sent, and + # this represents the time at which the query was run. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time - # The number of results that have been skipped due to an offset between - # the last response and the current response. + # The number of results that have been skipped due to an offset between the last + # response and the current response. # Corresponds to the JSON property `skippedResults` # @return [Fixnum] attr_accessor :skipped_results - # The transaction that was started as part of this request. - # Can only be set in the first response, and only if - # RunQueryRequest.new_transaction was set in the request. - # If set, no other fields will be set in this response. + # The transaction that was started as part of this request. Can only be set in + # the first response, and only if RunQueryRequest.new_transaction was set in the + # request. If set, no other fields will be set in this response. # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -2170,12 +2098,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 @@ -2184,15 +2112,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 @@ -2223,34 +2151,28 @@ module Google # @return [Array] attr_accessor :from - # The maximum number of results to return. - # Applies after all other constraints. + # The maximum number of results to return. Applies after all other constraints. # Must be >= 0 if specified. # Corresponds to the JSON property `limit` # @return [Fixnum] attr_accessor :limit - # The number of results to skip. - # Applies before limit, but after all other constraints. Must be >= 0 if - # specified. + # The number of results to skip. Applies before limit, but after all other + # constraints. Must be >= 0 if specified. # Corresponds to the JSON property `offset` # @return [Fixnum] attr_accessor :offset - # The order to apply to the query results. - # Firestore guarantees a stable ordering through the following rules: - # * Any field required to appear in `order_by`, that is not already - # specified in `order_by`, is appended to the order in field name order - # by default. - # * If an order on `__name__` is not specified, it is appended by default. - # Fields are appended with the same sort direction as the last order - # specified, or 'ASCENDING' if no order was specified. For example: - # * `SELECT * FROM Foo ORDER BY A` becomes - # `SELECT * FROM Foo ORDER BY A, __name__` - # * `SELECT * FROM Foo ORDER BY A DESC` becomes - # `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC` - # * `SELECT * FROM Foo WHERE A > 1` becomes - # `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__` + # The order to apply to the query results. Firestore guarantees a stable + # ordering through the following rules: * Any field required to appear in ` + # order_by`, that is not already specified in `order_by`, is appended to the + # order in field name order by default. * If an order on `__name__` is not + # specified, it is appended by default. Fields are appended with the same sort + # direction as the last order specified, or 'ASCENDING' if no order was + # specified. For example: * `SELECT * FROM Foo ORDER BY A` becomes `SELECT * + # FROM Foo ORDER BY A, __name__` * `SELECT * FROM Foo ORDER BY A DESC` becomes ` + # SELECT * FROM Foo ORDER BY A DESC, __name__ DESC` * `SELECT * FROM Foo WHERE A + # > 1` becomes `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__` # Corresponds to the JSON property `orderBy` # @return [Array] attr_accessor :order_by @@ -2307,14 +2229,14 @@ module Google # @return [Google::Apis::FirestoreV1::QueryTarget] attr_accessor :query - # Start listening after a specific `read_time`. - # The client must know the state of matching documents at this time. + # Start listening after a specific `read_time`. The client must know the state + # of matching documents at this time. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time - # A resume token from a prior TargetChange for an identical target. - # Using a resume token with a different target is unsupported and may fail. + # A resume token from a prior TargetChange for an identical target. Using a + # resume token with a different target is unsupported and may fail. # Corresponds to the JSON property `resumeToken` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -2345,31 +2267,29 @@ module Google class TargetChange 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 `cause` # @return [Google::Apis::FirestoreV1::Status] attr_accessor :cause # The consistent `read_time` for the given `target_ids` (omitted when the - # target_ids are not at a consistent snapshot). - # The stream is guaranteed to send a `read_time` with `target_ids` empty - # whenever the entire stream reaches a new consistent snapshot. ADD, - # CURRENT, and RESET messages are guaranteed to (eventually) result in a - # new consistent snapshot (while NO_CHANGE and REMOVE messages are not). - # For a given stream, `read_time` is guaranteed to be monotonically - # increasing. + # target_ids are not at a consistent snapshot). The stream is guaranteed to send + # a `read_time` with `target_ids` empty whenever the entire stream reaches a new + # consistent snapshot. ADD, CURRENT, and RESET messages are guaranteed to ( + # eventually) result in a new consistent snapshot (while NO_CHANGE and REMOVE + # messages are not). For a given stream, `read_time` is guaranteed to be + # monotonically increasing. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time - # A token that can be used to resume the stream for the given `target_ids`, - # or all targets if `target_ids` is empty. - # Not set on every target change. + # A token that can be used to resume the stream for the given `target_ids`, or + # all targets if `target_ids` is empty. Not set on every target change. # Corresponds to the JSON property `resumeToken` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -2380,9 +2300,8 @@ module Google # @return [String] attr_accessor :target_change_type - # The target IDs of targets that have changed. - # If empty, the change applies to all targets. - # The order of the target IDs is not defined. + # The target IDs of targets that have changed. If empty, the change applies to + # all targets. The order of the target IDs is not defined. # Corresponds to the JSON property `targetIds` # @return [Array] attr_accessor :target_ids @@ -2466,9 +2385,8 @@ module Google attr_accessor :boolean_value alias_method :boolean_value?, :boolean_value - # A bytes value. - # Must not exceed 1 MiB - 89 bytes. - # Only the first 1,500 bytes are considered by queries. + # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes + # are considered by queries. # Corresponds to the JSON property `bytesValue` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -2481,9 +2399,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 `geoPointValue` # @return [Google::Apis::FirestoreV1::LatLng] attr_accessor :geo_point_value @@ -2503,23 +2420,21 @@ module Google # @return [String] attr_accessor :null_value - # A reference to a document. For example: - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. + # A reference to a document. For example: `projects/`project_id`/databases/` + # database_id`/documents/`document_path``. # Corresponds to the JSON property `referenceValue` # @return [String] attr_accessor :reference_value - # A string value. - # The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. - # Only the first 1,500 bytes of the UTF-8 representation are considered by - # queries. + # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 + # bytes. Only the first 1,500 bytes of the UTF-8 representation are considered + # by queries. # Corresponds to the JSON property `stringValue` # @return [String] attr_accessor :string_value - # A timestamp value. - # Precise only to microseconds. When stored, any additional precision is - # rounded down. + # A timestamp value. Precise only to microseconds. When stored, any additional + # precision is rounded down. # Corresponds to the JSON property `timestampValue` # @return [String] attr_accessor :timestamp_value @@ -2553,8 +2468,8 @@ module Google # @return [Google::Apis::FirestoreV1::Precondition] attr_accessor :current_document - # A document name to delete. In the format: - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. + # A document name to delete. In the format: `projects/`project_id`/databases/` + # database_id`/documents/`document_path``. # Corresponds to the JSON property `delete` # @return [String] attr_accessor :delete @@ -2564,25 +2479,22 @@ module Google # @return [Google::Apis::FirestoreV1::DocumentTransform] attr_accessor :transform - # A Firestore document. - # Must not exceed 1 MiB - 4 bytes. + # A Firestore document. Must not exceed 1 MiB - 4 bytes. # Corresponds to the JSON property `update` # @return [Google::Apis::FirestoreV1::Document] attr_accessor :update - # A set of field paths on a document. - # Used to restrict a get or update operation on a document to a subset of its - # fields. - # This is different from standard field masks, as this is always scoped to a - # Document, and takes in account the dynamic nature of Value. + # A set of field paths on a document. Used to restrict a get or update operation + # on a document to a subset of its fields. This is different from standard field + # masks, as this is always scoped to a Document, and takes in account the + # dynamic nature of Value. # Corresponds to the JSON property `updateMask` # @return [Google::Apis::FirestoreV1::DocumentMask] attr_accessor :update_mask - # The transforms to perform after update. - # This field can be set only when the operation is `update`. If present, this - # write is equivalent to performing `update` and `transform` to the same - # document atomically and in order. + # The transforms to perform after update. This field can be set only when the + # operation is `update`. If present, this write is equivalent to performing ` + # update` and `transform` to the same document atomically and in order. # Corresponds to the JSON property `updateTransforms` # @return [Array] attr_accessor :update_transforms @@ -2602,13 +2514,12 @@ module Google end end - # The request for Firestore.Write. - # The first request creates a stream, or resumes an existing one from a token. - # When creating a new stream, the server replies with a response containing - # only an ID and a token, to use in the next request. - # When resuming a stream, the server first streams any responses later than the - # given token, then a response containing only an up-to-date token, to use in - # the next request. + # The request for Firestore.Write. The first request creates a stream, or + # resumes an existing one from a token. When creating a new stream, the server + # replies with a response containing only an ID and a token, to use in the next + # request. When resuming a stream, the server first streams any responses later + # than the given token, then a response containing only an up-to-date token, to + # use in the next request. class WriteRequest include Google::Apis::Core::Hashable @@ -2617,33 +2528,28 @@ module Google # @return [Hash] attr_accessor :labels - # The ID of the write stream to resume. - # This may only be set in the first message. When left empty, a new write - # stream will be created. + # The ID of the write stream to resume. This may only be set in the first + # message. When left empty, a new write stream will be created. # Corresponds to the JSON property `streamId` # @return [String] attr_accessor :stream_id - # A stream token that was previously sent by the server. - # The client should set this field to the token from the most recent - # WriteResponse it has received. This acknowledges that the client has - # received responses up to this token. After sending this token, earlier - # tokens may not be used anymore. - # The server may close the stream if there are too many unacknowledged - # responses. - # Leave this field unset when creating a new stream. To resume a stream at - # a specific point, set this field and the `stream_id` field. - # Leave this field unset when creating a new stream. + # A stream token that was previously sent by the server. The client should set + # this field to the token from the most recent WriteResponse it has received. + # This acknowledges that the client has received responses up to this token. + # After sending this token, earlier tokens may not be used anymore. The server + # may close the stream if there are too many unacknowledged responses. Leave + # this field unset when creating a new stream. To resume a stream at a specific + # point, set this field and the `stream_id` field. Leave this field unset when + # creating a new stream. # Corresponds to the JSON property `streamToken` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :stream_token - # The writes to apply. - # Always executed atomically and in order. - # This must be empty on the first request. - # This may be empty on the last request. - # This must not be empty on all other requests. + # The writes to apply. Always executed atomically and in order. This must be + # empty on the first request. This may be empty on the last request. This must + # not be empty on all other requests. # Corresponds to the JSON property `writes` # @return [Array] attr_accessor :writes @@ -2665,29 +2571,28 @@ module Google class WriteResponse include Google::Apis::Core::Hashable - # The time at which the commit occurred. Any read with an equal or greater - # `read_time` is guaranteed to see the effects of the write. + # The time at which the commit occurred. Any read with an equal or greater ` + # read_time` is guaranteed to see the effects of the write. # Corresponds to the JSON property `commitTime` # @return [String] attr_accessor :commit_time - # The ID of the stream. - # Only set on the first message, when a new stream was created. + # The ID of the stream. Only set on the first message, when a new stream was + # created. # Corresponds to the JSON property `streamId` # @return [String] attr_accessor :stream_id - # A token that represents the position of this response in the stream. - # This can be used by a client to resume the stream at this point. - # This field is always set. + # A token that represents the position of this response in the stream. This can + # be used by a client to resume the stream at this point. This field is always + # set. # Corresponds to the JSON property `streamToken` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :stream_token - # The result of applying the writes. - # This i-th write result corresponds to the i-th write in the - # request. + # The result of applying the writes. This i-th write result corresponds to the i- + # th write in the request. # Corresponds to the JSON property `writeResults` # @return [Array] attr_accessor :write_results @@ -2709,15 +2614,14 @@ module Google class WriteResult include Google::Apis::Core::Hashable - # The results of applying each DocumentTransform.FieldTransform, in the - # same order. + # The results of applying each DocumentTransform.FieldTransform, in the same + # order. # Corresponds to the JSON property `transformResults` # @return [Array] attr_accessor :transform_results - # The last update time of the document after applying the write. Not set - # after a `delete`. - # If the write did not actually change the document, this will be the + # The last update time of the document after applying the write. Not set after a + # `delete`. If the write did not actually change the document, this will be the # previous update_time. # Corresponds to the JSON property `updateTime` # @return [String] diff --git a/generated/google/apis/firestore_v1/service.rb b/generated/google/apis/firestore_v1/service.rb index 0e322d740..6099ec7c9 100644 --- a/generated/google/apis/firestore_v1/service.rb +++ b/generated/google/apis/firestore_v1/service.rb @@ -48,17 +48,16 @@ module Google @batch_path = 'batch' end - # Exports a copy of all or a subset of documents from Google Cloud Firestore - # to another storage system, such as Google Cloud Storage. Recent updates to + # Exports a copy of all or a subset of documents from Google Cloud Firestore to + # another storage system, such as Google Cloud Storage. Recent updates to # documents may not be reflected in the export. The export occurs in the - # background and its progress can be monitored and managed via the - # Operation resource that is created. The output of an export may only be - # used once the associated operation is done. If an export operation is - # cancelled before completion it may leave partial data behind in Google - # Cloud Storage. + # background and its progress can be monitored and managed via the Operation + # resource that is created. The output of an export may only be used once the + # associated operation is done. If an export operation is cancelled before + # completion it may leave partial data behind in Google Cloud Storage. # @param [String] name - # Required. Database to export. Should be of the form: - # `projects/`project_id`/databases/`database_id``. + # Required. Database to export. Should be of the form: `projects/`project_id`/ + # databases/`database_id``. # @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ExportDocumentsRequest] google_firestore_admin_v1_export_documents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -92,11 +91,11 @@ module Google # Imports documents into Google Cloud Firestore. Existing documents with the # same name are overwritten. The import occurs in the background and its # progress can be monitored and managed via the Operation resource that is - # created. If an ImportDocuments operation is cancelled, it is possible - # that a subset of the data has already been imported to Cloud Firestore. + # created. If an ImportDocuments operation is cancelled, it is possible that a + # subset of the data has already been imported to Cloud Firestore. # @param [String] name - # Required. Database to import into. Should be of the form: - # `projects/`project_id`/databases/`database_id``. + # Required. Database to import into. Should be of the form: `projects/` + # project_id`/databases/`database_id``. # @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1ImportDocumentsRequest] google_firestore_admin_v1_import_documents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -129,9 +128,8 @@ module Google # Gets the metadata and configuration for a Field. # @param [String] name - # Required. A name of the form - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # /fields/`field_id`` + # Required. A name of the form `projects/`project_id`/databases/`database_id`/ + # collectionGroups/`collection_id`/fields/`field_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -159,27 +157,23 @@ module Google execute_or_queue_command(command, &block) end - # Lists the field configuration and metadata for this database. - # Currently, FirestoreAdmin.ListFields only supports listing fields - # that have been explicitly overridden. To issue this query, call - # FirestoreAdmin.ListFields with the filter set to - # `indexConfig.usesAncestorConfig:false`. + # Lists the field configuration and metadata for this database. Currently, + # FirestoreAdmin.ListFields only supports listing fields that have been + # explicitly overridden. To issue this query, call FirestoreAdmin.ListFields + # with the filter set to `indexConfig.usesAncestorConfig:false`. # @param [String] parent - # Required. A parent name of the form - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # ` + # Required. A parent name of the form `projects/`project_id`/databases/` + # database_id`/collectionGroups/`collection_id`` # @param [String] filter - # The filter to apply to list results. Currently, - # FirestoreAdmin.ListFields only supports listing fields - # that have been explicitly overridden. To issue this query, call - # FirestoreAdmin.ListFields with the filter set to - # `indexConfig.usesAncestorConfig:false`. + # The filter to apply to list results. Currently, FirestoreAdmin.ListFields only + # supports listing fields that have been explicitly overridden. To issue this + # query, call FirestoreAdmin.ListFields with the filter set to `indexConfig. + # usesAncestorConfig:false`. # @param [Fixnum] page_size # The number of results to return. # @param [String] page_token - # A page token, returned from a previous call to - # FirestoreAdmin.ListFields, that may be used to get the next - # page of results. + # A page token, returned from a previous call to FirestoreAdmin.ListFields, that + # may be used to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -210,47 +204,37 @@ module Google execute_or_queue_command(command, &block) end - # Updates a field configuration. Currently, field updates apply only to - # single field index configuration. However, calls to - # FirestoreAdmin.UpdateField should provide a field mask to avoid - # changing any configuration that the caller isn't aware of. The field mask - # should be specified as: `` paths: "index_config" ``. - # This call returns a google.longrunning.Operation which may be used to - # track the status of the field update. The metadata for - # the operation will be the type FieldOperationMetadata. - # To configure the default field settings for the database, use - # the special `Field` with resource name: - # `projects/`project_id`/databases/`database_id`/collectionGroups/__default__/ - # fields/*`. + # Updates a field configuration. Currently, field updates apply only to single + # field index configuration. However, calls to FirestoreAdmin.UpdateField should + # provide a field mask to avoid changing any configuration that the caller isn't + # aware of. The field mask should be specified as: `` paths: "index_config" ``. + # This call returns a google.longrunning.Operation which may be used to track + # the status of the field update. The metadata for the operation will be the + # type FieldOperationMetadata. To configure the default field settings for the + # database, use the special `Field` with resource name: `projects/`project_id`/ + # databases/`database_id`/collectionGroups/__default__/fields/*`. # @param [String] name - # A field name of the form - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # /fields/`field_path`` - # A field path may be a simple field name, e.g. `address` or a path to fields - # within map_value , e.g. `address.city`, - # or a special field path. The only valid special field is `*`, which - # represents any field. - # Field paths may be quoted using ` (backtick). The only character that needs - # to be escaped within a quoted field path is the backtick character itself, - # escaped using a backslash. Special characters in field paths that - # must be quoted include: `*`, `.`, - # ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. - # Examples: - # (Note: Comments here are written in markdown syntax, so there is an - # additional layer of backticks to represent a code block) - # `\`address.city\`` represents a field named `address.city`, not the map key - # `city` in the field `address`. - # `\`*\`` represents a field named `*`, not any field. - # A special `Field` contains the default indexing settings for all fields. - # This field's resource name is: - # `projects/`project_id`/databases/`database_id`/collectionGroups/__default__/ - # fields/*` + # A field name of the form `projects/`project_id`/databases/`database_id`/ + # collectionGroups/`collection_id`/fields/`field_path`` A field path may be a + # simple field name, e.g. `address` or a path to fields within map_value , e.g. ` + # address.city`, or a special field path. The only valid special field is `*`, + # which represents any field. Field paths may be quoted using ` (backtick). The + # only character that needs to be escaped within a quoted field path is the + # backtick character itself, escaped using a backslash. Special characters in + # field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, + # as well as any ascii symbolic characters. Examples: (Note: Comments here are + # written in markdown syntax, so there is an additional layer of backticks to + # represent a code block) `\`address.city\`` represents a field named `address. + # city`, not the map key `city` in the field `address`. `\`*\`` represents a + # field named `*`, not any field. A special `Field` contains the default + # indexing settings for all fields. This field's resource name is: `projects/` + # project_id`/databases/`database_id`/collectionGroups/__default__/fields/*` # Indexes defined on this `Field` will be applied to all fields which do not # have their own `Field` index configuration. # @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Field] google_firestore_admin_v1_field_object # @param [String] update_mask - # A mask, relative to the field. If specified, only configuration specified - # by this field_mask will be updated in the field. + # A mask, relative to the field. If specified, only configuration specified by + # this field_mask will be updated in the field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -281,13 +265,12 @@ module Google execute_or_queue_command(command, &block) end - # Creates a composite index. This returns a google.longrunning.Operation - # which may be used to track the status of the creation. The metadata for - # the operation will be the type IndexOperationMetadata. + # Creates a composite index. This returns a google.longrunning.Operation which + # may be used to track the status of the creation. The metadata for the + # operation will be the type IndexOperationMetadata. # @param [String] parent - # Required. A parent name of the form - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # ` + # Required. A parent name of the form `projects/`project_id`/databases/` + # database_id`/collectionGroups/`collection_id`` # @param [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Index] google_firestore_admin_v1_index_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -320,9 +303,8 @@ module Google # Deletes a composite index. # @param [String] name - # Required. A name of the form - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # /indexes/`index_id`` + # Required. A name of the form `projects/`project_id`/databases/`database_id`/ + # collectionGroups/`collection_id`/indexes/`index_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -352,9 +334,8 @@ module Google # Gets a composite index. # @param [String] name - # Required. A name of the form - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # /indexes/`index_id`` + # Required. A name of the form `projects/`project_id`/databases/`database_id`/ + # collectionGroups/`collection_id`/indexes/`index_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -384,17 +365,15 @@ module Google # Lists composite indexes. # @param [String] parent - # Required. A parent name of the form - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # ` + # Required. A parent name of the form `projects/`project_id`/databases/` + # database_id`/collectionGroups/`collection_id`` # @param [String] filter # The filter to apply to list results. # @param [Fixnum] page_size # The number of results to return. # @param [String] page_token - # A page token, returned from a previous call to - # FirestoreAdmin.ListIndexes, that may be used to get the next - # page of results. + # A page token, returned from a previous call to FirestoreAdmin.ListIndexes, + # that may be used to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -425,12 +404,11 @@ module Google execute_or_queue_command(command, &block) end - # Gets multiple documents. - # Documents returned by this method are not guaranteed to be returned in the - # same order that they were requested. + # Gets multiple documents. Documents returned by this method are not guaranteed + # to be returned in the same order that they were requested. # @param [String] database - # Required. The database name. In the format: - # `projects/`project_id`/databases/`database_id``. + # Required. The database name. In the format: `projects/`project_id`/databases/` + # database_id``. # @param [Google::Apis::FirestoreV1::BatchGetDocumentsRequest] batch_get_documents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -461,16 +439,14 @@ module Google execute_or_queue_command(command, &block) end - # Applies a batch of write operations. - # The BatchWrite method does not apply the write operations atomically - # and can apply them out of order. Method does not allow more than one write - # per document. Each write succeeds or fails independently. See the - # BatchWriteResponse for the success status of each write. - # If you require an atomically applied set of writes, use - # Commit instead. + # Applies a batch of write operations. The BatchWrite method does not apply the + # write operations atomically and can apply them out of order. Method does not + # allow more than one write per document. Each write succeeds or fails + # independently. See the BatchWriteResponse for the success status of each write. + # If you require an atomically applied set of writes, use Commit instead. # @param [String] database - # Required. The database name. In the format: - # `projects/`project_id`/databases/`database_id``. + # Required. The database name. In the format: `projects/`project_id`/databases/` + # database_id``. # @param [Google::Apis::FirestoreV1::BatchWriteRequest] batch_write_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -503,8 +479,8 @@ module Google # Starts a new transaction. # @param [String] database - # Required. The database name. In the format: - # `projects/`project_id`/databases/`database_id``. + # Required. The database name. In the format: `projects/`project_id`/databases/` + # database_id``. # @param [Google::Apis::FirestoreV1::BeginTransactionRequest] begin_transaction_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -537,8 +513,8 @@ module Google # Commits a transaction, while optionally updating documents. # @param [String] database - # Required. The database name. In the format: - # `projects/`project_id`/databases/`database_id``. + # Required. The database name. In the format: `projects/`project_id`/databases/` + # database_id``. # @param [Google::Apis::FirestoreV1::CommitRequest] commit_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -571,20 +547,19 @@ module Google # Creates a new document. # @param [String] parent - # Required. The parent resource. For example: - # `projects/`project_id`/databases/`database_id`/documents` or - # `projects/`project_id`/databases/`database_id`/documents/chatrooms/` - # chatroom_id`` + # Required. The parent resource. For example: `projects/`project_id`/databases/` + # database_id`/documents` or `projects/`project_id`/databases/`database_id`/ + # documents/chatrooms/`chatroom_id`` # @param [String] collection_id # Required. The collection ID, relative to `parent`, to list. For example: ` # chatrooms`. # @param [Google::Apis::FirestoreV1::Document] document_object # @param [String] document_id - # The client-assigned document ID to use for this document. - # Optional. If not specified, an ID will be assigned by the service. + # The client-assigned document ID to use for this document. Optional. If not + # specified, an ID will be assigned by the service. # @param [Array, String] mask_field_paths - # The list of field paths in the mask. See Document.fields for a field - # path syntax reference. + # The list of field paths in the mask. See Document.fields for a field path + # syntax reference. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -619,14 +594,14 @@ module Google # Deletes a document. # @param [String] name - # Required. The resource name of the Document to delete. In the format: - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. + # Required. The resource name of the Document to delete. In the format: ` + # projects/`project_id`/databases/`database_id`/documents/`document_path``. # @param [Boolean] current_document_exists - # When set to `true`, the target document must exist. - # When set to `false`, the target document must not exist. + # When set to `true`, the target document must exist. When set to `false`, the + # target document must not exist. # @param [String] current_document_update_time - # When set, the target document must exist and have been last updated at - # that time. + # When set, the target document must exist and have been last updated at that + # time. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -658,14 +633,14 @@ module Google # Gets a single document. # @param [String] name - # Required. The resource name of the Document to get. In the format: - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. + # Required. The resource name of the Document to get. In the format: `projects/` + # project_id`/databases/`database_id`/documents/`document_path``. # @param [Array, String] mask_field_paths - # The list of field paths in the mask. See Document.fields for a field - # path syntax reference. + # The list of field paths in the mask. See Document.fields for a field path + # syntax reference. # @param [String] read_time - # Reads the version of the document at the given time. - # This may not be older than 270 seconds. + # Reads the version of the document at the given time. This may not be older + # than 270 seconds. # @param [String] transaction # Reads the document in a transaction. # @param [String] fields @@ -700,19 +675,17 @@ module Google # Lists documents. # @param [String] parent - # Required. The parent resource name. In the format: - # `projects/`project_id`/databases/`database_id`/documents` or - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. - # For example: - # `projects/my-project/databases/my-database/documents` or - # `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + # Required. The parent resource name. In the format: `projects/`project_id`/ + # databases/`database_id`/documents` or `projects/`project_id`/databases/` + # database_id`/documents/`document_path``. For example: `projects/my-project/ + # databases/my-database/documents` or `projects/my-project/databases/my-database/ + # documents/chatrooms/my-chatroom` # @param [String] collection_id # Required. The collection ID, relative to `parent`, to list. For example: ` - # chatrooms` - # or `messages`. + # chatrooms` or `messages`. # @param [Array, String] mask_field_paths - # The list of field paths in the mask. See Document.fields for a field - # path syntax reference. + # The list of field paths in the mask. See Document.fields for a field path + # syntax reference. # @param [String] order_by # The order to sort results by. For example: `priority desc, name`. # @param [Fixnum] page_size @@ -720,15 +693,14 @@ module Google # @param [String] page_token # The `next_page_token` value returned from a previous List request, if any. # @param [String] read_time - # Reads documents as they were at the given time. - # This may not be older than 270 seconds. + # Reads documents as they were at the given time. This may not be older than 270 + # seconds. # @param [Boolean] show_missing - # If the list should show missing documents. A missing document is a - # document that does not exist but has sub-documents. These documents will - # be returned with a key but will not have fields, Document.create_time, - # or Document.update_time set. - # Requests with `show_missing` may not specify `where` or - # `order_by`. + # If the list should show missing documents. A missing document is a document + # that does not exist but has sub-documents. These documents will be returned + # with a key but will not have fields, Document.create_time, or Document. + # update_time set. Requests with `show_missing` may not specify `where` or ` + # order_by`. # @param [String] transaction # Reads documents in a transaction. # @param [String] fields @@ -768,10 +740,9 @@ module Google # Lists all the collection IDs underneath a document. # @param [String] parent - # Required. The parent document. In the format: - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. - # For example: - # `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + # Required. The parent document. In the format: `projects/`project_id`/databases/ + # `database_id`/documents/`document_path``. For example: `projects/my-project/ + # databases/my-database/documents/chatrooms/my-chatroom` # @param [Google::Apis::FirestoreV1::ListCollectionIdsRequest] list_collection_ids_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -804,8 +775,8 @@ module Google # Listens to changes. # @param [String] database - # Required. The database name. In the format: - # `projects/`project_id`/databases/`database_id``. + # Required. The database name. In the format: `projects/`project_id`/databases/` + # database_id``. # @param [Google::Apis::FirestoreV1::ListenRequest] listen_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -836,14 +807,13 @@ module Google execute_or_queue_command(command, &block) end - # Partitions a query by returning partition cursors that can be used to run - # the query in parallel. The returned partition cursors are split points that - # can be used by RunQuery as starting/end points for the query results. + # Partitions a query by returning partition cursors that can be used to run the + # query in parallel. The returned partition cursors are split points that can be + # used by RunQuery as starting/end points for the query results. # @param [String] parent - # Required. The parent resource name. In the format: - # `projects/`project_id`/databases/`database_id`/documents`. - # Document resource names are not supported; only database resource names - # can be specified. + # Required. The parent resource name. In the format: `projects/`project_id`/ + # databases/`database_id`/documents`. Document resource names are not supported; + # only database resource names can be specified. # @param [Google::Apis::FirestoreV1::PartitionQueryRequest] partition_query_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -876,21 +846,21 @@ module Google # Updates or inserts a document. # @param [String] name - # The resource name of the document, for example - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. + # The resource name of the document, for example `projects/`project_id`/ + # databases/`database_id`/documents/`document_path``. # @param [Google::Apis::FirestoreV1::Document] document_object # @param [Boolean] current_document_exists - # When set to `true`, the target document must exist. - # When set to `false`, the target document must not exist. + # When set to `true`, the target document must exist. When set to `false`, the + # target document must not exist. # @param [String] current_document_update_time - # When set, the target document must exist and have been last updated at - # that time. + # When set, the target document must exist and have been last updated at that + # time. # @param [Array, String] mask_field_paths - # The list of field paths in the mask. See Document.fields for a field - # path syntax reference. + # The list of field paths in the mask. See Document.fields for a field path + # syntax reference. # @param [Array, String] update_mask_field_paths - # The list of field paths in the mask. See Document.fields for a field - # path syntax reference. + # The list of field paths in the mask. See Document.fields for a field path + # syntax reference. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -926,8 +896,8 @@ module Google # Rolls back a transaction. # @param [String] database - # Required. The database name. In the format: - # `projects/`project_id`/databases/`database_id``. + # Required. The database name. In the format: `projects/`project_id`/databases/` + # database_id``. # @param [Google::Apis::FirestoreV1::RollbackRequest] rollback_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -960,12 +930,11 @@ module Google # Runs a query. # @param [String] parent - # Required. The parent resource name. In the format: - # `projects/`project_id`/databases/`database_id`/documents` or - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. - # For example: - # `projects/my-project/databases/my-database/documents` or - # `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + # Required. The parent resource name. In the format: `projects/`project_id`/ + # databases/`database_id`/documents` or `projects/`project_id`/databases/` + # database_id`/documents/`document_path``. For example: `projects/my-project/ + # databases/my-database/documents` or `projects/my-project/databases/my-database/ + # documents/chatrooms/my-chatroom` # @param [Google::Apis::FirestoreV1::RunQueryRequest] run_query_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -998,9 +967,8 @@ module Google # Streams batches of document updates and deletes, in order. # @param [String] database - # Required. The database name. In the format: - # `projects/`project_id`/databases/`database_id``. - # This is only required in the first message. + # Required. The database name. In the format: `projects/`project_id`/databases/` + # database_id``. This is only required in the first message. # @param [Google::Apis::FirestoreV1::WriteRequest] write_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -1031,15 +999,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. @@ -1073,10 +1039,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 @@ -1106,9 +1072,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 @@ -1138,15 +1103,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/firestore_v1beta1.rb b/generated/google/apis/firestore_v1beta1.rb index f558fb1ad..e193de536 100644 --- a/generated/google/apis/firestore_v1beta1.rb +++ b/generated/google/apis/firestore_v1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/firestore module FirestoreV1beta1 VERSION = 'V1beta1' - REVISION = '20200725' + 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/firestore_v1beta1/classes.rb b/generated/google/apis/firestore_v1beta1/classes.rb index 3627e4cb8..aff8b024a 100644 --- a/generated/google/apis/firestore_v1beta1/classes.rb +++ b/generated/google/apis/firestore_v1beta1/classes.rb @@ -45,19 +45,18 @@ module Google class BatchGetDocumentsRequest include Google::Apis::Core::Hashable - # The names of the documents to retrieve. In the format: - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. - # The request will fail if any of the document is not a child resource of the - # given `database`. Duplicate names will be elided. + # The names of the documents to retrieve. In the format: `projects/`project_id`/ + # databases/`database_id`/documents/`document_path``. The request will fail if + # any of the document is not a child resource of the given `database`. Duplicate + # names will be elided. # Corresponds to the JSON property `documents` # @return [Array] attr_accessor :documents - # A set of field paths on a document. - # Used to restrict a get or update operation on a document to a subset of its - # fields. - # This is different from standard field masks, as this is always scoped to a - # Document, and takes in account the dynamic nature of Value. + # A set of field paths on a document. Used to restrict a get or update operation + # on a document to a subset of its fields. This is different from standard field + # masks, as this is always scoped to a Document, and takes in account the + # dynamic nature of Value. # Corresponds to the JSON property `mask` # @return [Google::Apis::FirestoreV1beta1::DocumentMask] attr_accessor :mask @@ -67,8 +66,8 @@ module Google # @return [Google::Apis::FirestoreV1beta1::TransactionOptions] attr_accessor :new_transaction - # Reads documents as they were at the given time. - # This may not be older than 270 seconds. + # Reads documents as they were at the given time. This may not be older than 270 + # seconds. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -97,29 +96,27 @@ module Google class BatchGetDocumentsResponse include Google::Apis::Core::Hashable - # A Firestore document. - # Must not exceed 1 MiB - 4 bytes. + # A Firestore document. Must not exceed 1 MiB - 4 bytes. # Corresponds to the JSON property `found` # @return [Google::Apis::FirestoreV1beta1::Document] attr_accessor :found - # A document name that was requested but does not exist. In the format: - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. + # A document name that was requested but does not exist. In the format: ` + # projects/`project_id`/databases/`database_id`/documents/`document_path``. # Corresponds to the JSON property `missing` # @return [String] attr_accessor :missing - # The time at which the document was read. - # This may be monotically increasing, in this case the previous documents in - # the result stream are guaranteed not to have changed between their - # read_time and this one. + # The time at which the document was read. This may be monotically increasing, + # in this case the previous documents in the result stream are guaranteed not to + # have changed between their read_time and this one. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time - # The transaction that was started as part of this request. - # Will only be set in the first response, and only if - # BatchGetDocumentsRequest.new_transaction was set in the request. + # The transaction that was started as part of this request. Will only be set in + # the first response, and only if BatchGetDocumentsRequest.new_transaction was + # set in the request. # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -147,10 +144,9 @@ module Google # @return [Hash] attr_accessor :labels - # The writes to apply. - # Method does not apply writes atomically and does not guarantee ordering. - # Each write succeeds or fails independently. You cannot write to the same - # document more than once per request. + # The writes to apply. Method does not apply writes atomically and does not + # guarantee ordering. Each write succeeds or fails independently. You cannot + # write to the same document more than once per request. # Corresponds to the JSON property `writes` # @return [Array] attr_accessor :writes @@ -170,16 +166,14 @@ module Google class BatchWriteResponse include Google::Apis::Core::Hashable - # The status of applying the writes. - # This i-th write status corresponds to the i-th write in the - # request. + # The status of applying the writes. This i-th write status corresponds to the i- + # th write in the request. # Corresponds to the JSON property `status` # @return [Array] attr_accessor :status - # The result of applying the writes. - # This i-th write result corresponds to the i-th write in the - # request. + # The result of applying the writes. This i-th write result corresponds to the i- + # th write in the request. # Corresponds to the JSON property `writeResults` # @return [Array] attr_accessor :write_results @@ -238,16 +232,15 @@ module Google class CollectionSelector include Google::Apis::Core::Hashable - # When false, selects only collections that are immediate children of - # the `parent` specified in the containing `RunQueryRequest`. - # When true, selects all descendant collections. + # When false, selects only collections that are immediate children of the ` + # parent` specified in the containing `RunQueryRequest`. When true, selects all + # descendant collections. # Corresponds to the JSON property `allDescendants` # @return [Boolean] attr_accessor :all_descendants alias_method :all_descendants?, :all_descendants - # The collection ID. - # When set, selects only collections with this ID. + # The collection ID. When set, selects only collections with this ID. # Corresponds to the JSON property `collectionId` # @return [String] attr_accessor :collection_id @@ -273,8 +266,7 @@ module Google # @return [String] attr_accessor :transaction - # The writes to apply. - # Always executed atomically and in order. + # The writes to apply. Always executed atomically and in order. # Corresponds to the JSON property `writes` # @return [Array] attr_accessor :writes @@ -294,15 +286,14 @@ module Google class CommitResponse include Google::Apis::Core::Hashable - # The time at which the commit occurred. Any read with an equal or greater - # `read_time` is guaranteed to see the effects of the commit. + # The time at which the commit occurred. Any read with an equal or greater ` + # read_time` is guaranteed to see the effects of the commit. # Corresponds to the JSON property `commitTime` # @return [String] attr_accessor :commit_time - # The result of applying the writes. - # This i-th write result corresponds to the i-th write in the - # request. + # The result of applying the writes. This i-th write result corresponds to the i- + # th write in the request. # Corresponds to the JSON property `writeResults` # @return [Array] attr_accessor :write_results @@ -322,8 +313,7 @@ module Google class CompositeFilter include Google::Apis::Core::Hashable - # The list of filters to combine. - # Must contain at least one filter. + # The list of filters to combine. Must contain at least one filter. # Corresponds to the JSON property `filters` # @return [Array] attr_accessor :filters @@ -348,16 +338,16 @@ module Google class Cursor include Google::Apis::Core::Hashable - # If the position is just before or just after the given values, relative - # to the sort order defined by the query. + # If the position is just before or just after the given values, relative to the + # sort order defined by the query. # Corresponds to the JSON property `before` # @return [Boolean] attr_accessor :before alias_method :before?, :before - # The values that represent a position, in the order they appear in - # the order by clause of a query. - # Can contain fewer values than specified in the order by clause. + # The values that represent a position, in the order they appear in the order by + # clause of a query. Can contain fewer values than specified in the order by + # clause. # Corresponds to the JSON property `values` # @return [Array] attr_accessor :values @@ -373,52 +363,45 @@ module Google end end - # A Firestore document. - # Must not exceed 1 MiB - 4 bytes. + # A Firestore document. Must not exceed 1 MiB - 4 bytes. class Document include Google::Apis::Core::Hashable - # Output only. The time at which the document was created. - # This value increases monotonically when a document is deleted then - # recreated. It can also be compared to values from other documents and - # the `read_time` of a query. + # Output only. The time at which the document was created. This value increases + # monotonically when a document is deleted then recreated. It can also be + # compared to values from other documents and the `read_time` of a query. # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time - # The document's fields. - # The map keys represent field names. - # A simple field name contains only characters `a` to `z`, `A` to `Z`, - # `0` to `9`, or `_`, and must not start with `0` to `9`. For example, - # `foo_bar_17`. - # Field names matching the regular expression `__.*__` are reserved. Reserved - # field names are forbidden except in certain documented contexts. The map - # keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be - # empty. - # Field paths may be used in other contexts to refer to structured fields - # defined here. For `map_value`, the field path is represented by the simple - # or quoted field names of the containing fields, delimited by `.`. For - # example, the structured field - # `"foo" : ` map_value: ` "x&y" : ` string_value: "hello" ```` would be - # represented by the field path `foo.x&y`. - # Within a field path, a quoted field name starts and ends with `` ` `` and - # may contain any character. Some characters, including `` ` ``, must be - # escaped using a `\`. For example, `` `x&y` `` represents `x&y` and - # `` `bak\`tik` `` represents `` bak`tik ``. + # The document's fields. The map keys represent field names. A simple field name + # contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must + # not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the + # regular expression `__.*__` are reserved. Reserved field names are forbidden + # except in certain documented contexts. The map keys, represented as UTF-8, + # must not exceed 1,500 bytes and cannot be empty. Field paths may be used in + # other contexts to refer to structured fields defined here. For `map_value`, + # the field path is represented by the simple or quoted field names of the + # containing fields, delimited by `.`. For example, the structured field `"foo" : + # ` map_value: ` "x&y" : ` string_value: "hello" ```` would be represented by + # the field path `foo.x&y`. Within a field path, a quoted field name starts and + # ends with `` ` `` and may contain any character. Some characters, including `` + # ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` + # and `` `bak\`tik` `` represents `` bak`tik ``. # Corresponds to the JSON property `fields` # @return [Hash] attr_accessor :fields - # The resource name of the document, for example - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. + # The resource name of the document, for example `projects/`project_id`/ + # databases/`database_id`/documents/`document_path``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Output only. The time at which the document was last changed. - # This value is initially set to the `create_time` then increases - # monotonically with each change to the document. It can also be - # compared to values from other documents and the `read_time` of a query. + # Output only. The time at which the document was last changed. This value is + # initially set to the `create_time` then increases monotonically with each + # change to the document. It can also be compared to values from other documents + # and the `read_time` of a query. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -436,16 +419,14 @@ module Google end end - # A Document has changed. - # May be the result of multiple writes, including deletes, that - # ultimately resulted in a new value for the Document. - # Multiple DocumentChange messages may be returned for the same logical - # change, if multiple targets are affected. + # A Document has changed. May be the result of multiple writes, including + # deletes, that ultimately resulted in a new value for the Document. Multiple + # DocumentChange messages may be returned for the same logical change, if + # multiple targets are affected. class DocumentChange include Google::Apis::Core::Hashable - # A Firestore document. - # Must not exceed 1 MiB - 4 bytes. + # A Firestore document. Must not exceed 1 MiB - 4 bytes. # Corresponds to the JSON property `document` # @return [Google::Apis::FirestoreV1beta1::Document] attr_accessor :document @@ -472,11 +453,10 @@ module Google end end - # A Document has been deleted. - # May be the result of multiple writes, including updates, the - # last of which deleted the Document. - # Multiple DocumentDelete messages may be returned for the same logical - # delete, if multiple targets are affected. + # A Document has been deleted. May be the result of multiple writes, including + # updates, the last of which deleted the Document. Multiple DocumentDelete + # messages may be returned for the same logical delete, if multiple targets are + # affected. class DocumentDelete include Google::Apis::Core::Hashable @@ -485,8 +465,8 @@ module Google # @return [String] attr_accessor :document - # The read timestamp at which the delete was observed. - # Greater or equal to the `commit_time` of the delete. + # The read timestamp at which the delete was observed. Greater or equal to the ` + # commit_time` of the delete. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -508,16 +488,15 @@ module Google end end - # A set of field paths on a document. - # Used to restrict a get or update operation on a document to a subset of its - # fields. - # This is different from standard field masks, as this is always scoped to a - # Document, and takes in account the dynamic nature of Value. + # A set of field paths on a document. Used to restrict a get or update operation + # on a document to a subset of its fields. This is different from standard field + # masks, as this is always scoped to a Document, and takes in account the + # dynamic nature of Value. class DocumentMask include Google::Apis::Core::Hashable - # The list of field paths in the mask. See Document.fields for a field - # path syntax reference. + # The list of field paths in the mask. See Document.fields for a field path + # syntax reference. # Corresponds to the JSON property `fieldPaths` # @return [Array] attr_accessor :field_paths @@ -532,12 +511,11 @@ module Google end end - # A Document has been removed from the view of the targets. - # Sent if the document is no longer relevant to a target and is out of view. - # Can be sent instead of a DocumentDelete or a DocumentChange if the server - # can not send the new value of the document. - # Multiple DocumentRemove messages may be returned for the same logical - # write or delete, if multiple targets are affected. + # A Document has been removed from the view of the targets. Sent if the document + # is no longer relevant to a target and is out of view. Can be sent instead of a + # DocumentDelete or a DocumentChange if the server can not send the new value of + # the document. Multiple DocumentRemove messages may be returned for the same + # logical write or delete, if multiple targets are affected. class DocumentRemove include Google::Apis::Core::Hashable @@ -546,8 +524,8 @@ module Google # @return [String] attr_accessor :document - # The read timestamp at which the remove was observed. - # Greater or equal to the `commit_time` of the change/delete/remove. + # The read timestamp at which the remove was observed. Greater or equal to the ` + # commit_time` of the change/delete/remove. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -578,8 +556,7 @@ module Google # @return [String] attr_accessor :document - # The list of transformations to apply to the fields of the document, in - # order. + # The list of transformations to apply to the fields of the document, in order. # This must not be empty. # Corresponds to the JSON property `fieldTransforms` # @return [Array] @@ -600,10 +577,10 @@ module Google class DocumentsTarget include Google::Apis::Core::Hashable - # The names of the documents to retrieve. In the format: - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. - # The request will fail if any of the document is not a child resource of - # the given `database`. Duplicate names will be elided. + # The names of the documents to retrieve. In the format: `projects/`project_id`/ + # databases/`database_id`/documents/`document_path``. The request will fail if + # any of the document is not a child resource of the given `database`. Duplicate + # names will be elided. # Corresponds to the JSON property `documents` # @return [Array] attr_accessor :documents @@ -618,13 +595,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 @@ -641,9 +616,9 @@ module Google class ExistenceFilter include Google::Apis::Core::Hashable - # The total count of documents that match target_id. - # If different from the count of documents in the client that match, the - # client must manually determine which documents no longer match the target. + # The total count of documents that match target_id. If different from the count + # of documents in the client that match, the client must manually determine + # which documents no longer match the target. # Corresponds to the JSON property `count` # @return [Fixnum] attr_accessor :count @@ -723,8 +698,7 @@ module Google # @return [Google::Apis::FirestoreV1beta1::ArrayValue] attr_accessor :append_missing_elements - # The path of the field. See Document.fields for the field path syntax - # reference. + # The path of the field. See Document.fields for the field path syntax reference. # Corresponds to the JSON property `fieldPath` # @return [String] attr_accessor :field_path @@ -810,8 +784,8 @@ module Google # @return [Array] attr_accessor :collection_ids - # The time the operation ended, either successfully or otherwise. Unset if - # the operation is still active. + # The time the operation ended, either successfully or otherwise. Unset if the + # operation is still active. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -866,14 +840,13 @@ module Google # @return [Array] attr_accessor :collection_ids - # The output URI. Currently only supports Google Cloud Storage URIs of the - # form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name - # of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional - # Google Cloud Storage namespace path. When - # choosing a name, be sure to consider Google Cloud Storage naming - # guidelines: https://cloud.google.com/storage/docs/naming. - # If the URI is a bucket (without a namespace path), a prefix will be - # generated based on the start time. + # The output URI. Currently only supports Google Cloud Storage URIs of the form: + # `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the + # Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud + # Storage namespace path. When choosing a name, be sure to consider Google Cloud + # Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If + # the URI is a bucket (without a namespace path), a prefix will be generated + # based on the start time. # Corresponds to the JSON property `outputUriPrefix` # @return [String] attr_accessor :output_uri_prefix @@ -893,9 +866,9 @@ module Google class GoogleFirestoreAdminV1beta1ExportDocumentsResponse include Google::Apis::Core::Hashable - # Location of the output files. This can be used to begin an import - # into Cloud Firestore (this project or another project) after the operation - # completes successfully. + # Location of the output files. This can be used to begin an import into Cloud + # Firestore (this project or another project) after the operation completes + # successfully. # Corresponds to the JSON property `outputUriPrefix` # @return [String] attr_accessor :output_uri_prefix @@ -919,8 +892,8 @@ module Google # @return [Array] attr_accessor :collection_ids - # The time the operation ended, either successfully or otherwise. Unset if - # the operation is still active. + # The time the operation ended, either successfully or otherwise. Unset if the + # operation is still active. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time @@ -970,16 +943,14 @@ module Google class GoogleFirestoreAdminV1beta1ImportDocumentsRequest include Google::Apis::Core::Hashable - # Which collection ids to import. Unspecified means all collections included - # in the import. + # Which collection ids to import. Unspecified means all collections included in + # the import. # Corresponds to the JSON property `collectionIds` # @return [Array] attr_accessor :collection_ids - # Location of the exported files. - # This must match the output_uri_prefix of an ExportDocumentsResponse from - # an export that has completed successfully. - # See: + # Location of the exported files. This must match the output_uri_prefix of an + # ExportDocumentsResponse from an export that has completed successfully. See: # google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix. # Corresponds to the JSON property `inputUriPrefix` # @return [String] @@ -1010,14 +981,12 @@ module Google # @return [Array] attr_accessor :fields - # The resource name of the index. - # Output only. + # The resource name of the index. Output only. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The state of the index. - # Output only. + # The state of the index. Output only. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state @@ -1039,10 +1008,10 @@ module Google class GoogleFirestoreAdminV1beta1IndexField include Google::Apis::Core::Hashable - # The path of the field. Must match the field path specification described - # by google.firestore.v1beta1.Document.fields. - # Special field path `__name__` may be used by itself or at the end of a - # path. `__type__` may be used only at the end of path. + # The path of the field. Must match the field path specification described by + # google.firestore.v1beta1.Document.fields. Special field path `__name__` may be + # used by itself or at the end of a path. `__type__` may be used only at the end + # of path. # Corresponds to the JSON property `fieldPath` # @return [String] attr_accessor :field_path @@ -1063,14 +1032,14 @@ module Google end end - # Metadata for index operations. This metadata populates - # the metadata field of google.longrunning.Operation. + # Metadata for index operations. This metadata populates the metadata field of + # google.longrunning.Operation. class GoogleFirestoreAdminV1beta1IndexOperationMetadata include Google::Apis::Core::Hashable - # True if the [google.longrunning.Operation] was cancelled. If the - # cancellation is in progress, cancelled will be true but - # google.longrunning.Operation.done will be false. + # True if the [google.longrunning.Operation] was cancelled. If the cancellation + # is in progress, cancelled will be true but google.longrunning.Operation.done + # will be false. # Corresponds to the JSON property `cancelled` # @return [Boolean] attr_accessor :cancelled @@ -1081,14 +1050,14 @@ module Google # @return [Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Progress] attr_accessor :document_progress - # The time the operation ended, either successfully or otherwise. Unset if - # the operation is still active. + # The time the operation ended, either successfully or otherwise. Unset if the + # operation is still active. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time - # The index resource that this operation is acting on. For example: - # `projects/`project_id`/databases/`database_id`/indexes/`index_id`` + # The index resource that this operation is acting on. For example: `projects/` + # project_id`/databases/`database_id`/indexes/`index_id`` # Corresponds to the JSON property `index` # @return [String] attr_accessor :index @@ -1160,14 +1129,14 @@ module Google class GoogleFirestoreAdminV1beta1Progress include Google::Apis::Core::Hashable - # An estimate of how much work has been completed. Note that this may be - # greater than `work_estimated`. + # An estimate of how much work has been completed. Note that this may be greater + # than `work_estimated`. # Corresponds to the JSON property `workCompleted` # @return [Fixnum] attr_accessor :work_completed - # An estimate of how much work needs to be performed. Zero if the - # work estimate is unavailable. May change as work progresses. + # An estimate of how much work needs to be performed. Zero if the work estimate + # is unavailable. May change as work progresses. # Corresponds to the JSON property `workEstimated` # @return [Fixnum] attr_accessor :work_estimated @@ -1188,47 +1157,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::FirestoreV1beta1::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 @@ -1249,9 +1216,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 @@ -1285,8 +1251,7 @@ module Google # @return [Fixnum] attr_accessor :page_size - # A page token. Must be a value from - # ListCollectionIdsResponse. + # A page token. Must be a value from ListCollectionIdsResponse. # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token @@ -1387,30 +1352,27 @@ module Google class ListenResponse include Google::Apis::Core::Hashable - # A Document has changed. - # May be the result of multiple writes, including deletes, that - # ultimately resulted in a new value for the Document. - # Multiple DocumentChange messages may be returned for the same logical - # change, if multiple targets are affected. + # A Document has changed. May be the result of multiple writes, including + # deletes, that ultimately resulted in a new value for the Document. Multiple + # DocumentChange messages may be returned for the same logical change, if + # multiple targets are affected. # Corresponds to the JSON property `documentChange` # @return [Google::Apis::FirestoreV1beta1::DocumentChange] attr_accessor :document_change - # A Document has been deleted. - # May be the result of multiple writes, including updates, the - # last of which deleted the Document. - # Multiple DocumentDelete messages may be returned for the same logical - # delete, if multiple targets are affected. + # A Document has been deleted. May be the result of multiple writes, including + # updates, the last of which deleted the Document. Multiple DocumentDelete + # messages may be returned for the same logical delete, if multiple targets are + # affected. # Corresponds to the JSON property `documentDelete` # @return [Google::Apis::FirestoreV1beta1::DocumentDelete] attr_accessor :document_delete - # A Document has been removed from the view of the targets. - # Sent if the document is no longer relevant to a target and is out of view. - # Can be sent instead of a DocumentDelete or a DocumentChange if the server - # can not send the new value of the document. - # Multiple DocumentRemove messages may be returned for the same logical - # write or delete, if multiple targets are affected. + # A Document has been removed from the view of the targets. Sent if the document + # is no longer relevant to a target and is out of view. Can be sent instead of a + # DocumentDelete or a DocumentChange if the server can not send the new value of + # the document. Multiple DocumentRemove messages may be returned for the same + # logical write or delete, if multiple targets are affected. # Corresponds to the JSON property `documentRemove` # @return [Google::Apis::FirestoreV1beta1::DocumentRemove] attr_accessor :document_remove @@ -1443,11 +1405,10 @@ module Google class MapValue include Google::Apis::Core::Hashable - # The map's fields. - # The map keys represent field names. Field names matching the regular - # expression `__.*__` are reserved. Reserved field names are forbidden except - # in certain documented contexts. The map keys, represented as UTF-8, must - # not exceed 1,500 bytes and cannot be empty. + # The map's fields. The map keys represent field names. Field names matching the + # regular expression `__.*__` are reserved. Reserved field names are forbidden + # except in certain documented contexts. The map keys, represented as UTF-8, + # must not exceed 1,500 bytes and cannot be empty. # Corresponds to the JSON property `fields` # @return [Hash] attr_accessor :fields @@ -1491,37 +1452,34 @@ module Google class PartitionQueryRequest include Google::Apis::Core::Hashable - # The maximum number of partitions to return in this call, subject to - # `partition_count`. - # For example, if `partition_count` = 10 and `page_size` = 8, the first call - # to PartitionQuery will return up to 8 partitions and a `next_page_token` - # if more results exist. A second call to PartitionQuery will return up to - # 2 partitions, to complete the total of 10 specified in `partition_count`. + # The maximum number of partitions to return in this call, subject to ` + # partition_count`. For example, if `partition_count` = 10 and `page_size` = 8, + # the first call to PartitionQuery will return up to 8 partitions and a ` + # next_page_token` if more results exist. A second call to PartitionQuery will + # return up to 2 partitions, to complete the total of 10 specified in ` + # partition_count`. # Corresponds to the JSON property `pageSize` # @return [Fixnum] attr_accessor :page_size - # The `next_page_token` value returned from a previous call to - # PartitionQuery that may be used to get an additional set of results. - # There are no ordering guarantees between sets of results. Thus, using - # multiple sets of results will require merging the different result sets. - # For example, two subsequent calls using a page_token may return: - # * cursor B, cursor M, cursor Q - # * cursor A, cursor U, cursor W - # To obtain a complete result set ordered with respect to the results of the - # query supplied to PartitionQuery, the results sets should be merged: - # cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W + # The `next_page_token` value returned from a previous call to PartitionQuery + # that may be used to get an additional set of results. There are no ordering + # guarantees between sets of results. Thus, using multiple sets of results will + # require merging the different result sets. For example, two subsequent calls + # using a page_token may return: * cursor B, cursor M, cursor Q * cursor A, + # cursor U, cursor W To obtain a complete result set ordered with respect to the + # results of the query supplied to PartitionQuery, the results sets should be + # merged: cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W # Corresponds to the JSON property `pageToken` # @return [String] attr_accessor :page_token - # The desired maximum number of partition points. - # The partitions may be returned across multiple pages of results. - # The number must be strictly positive. The actual number of partitions - # returned may be fewer. - # For example, this may be set to one fewer than the number of parallel - # queries to be run, or in running a data pipeline job, one fewer than the - # number of workers or compute instances available. + # The desired maximum number of partition points. The partitions may be returned + # across multiple pages of results. The number must be positive. The actual + # number of partitions returned may be fewer. For example, this may be set to + # one fewer than the number of parallel queries to be run, or in running a data + # pipeline job, one fewer than the number of workers or compute instances + # available. # Corresponds to the JSON property `partitionCount` # @return [Fixnum] attr_accessor :partition_count @@ -1548,25 +1506,22 @@ module Google class PartitionQueryResponse include Google::Apis::Core::Hashable - # A page token that may be used to request an additional set of results, up - # to the number specified by `partition_count` in the PartitionQuery request. - # If blank, there are no more results. + # A page token that may be used to request an additional set of results, up to + # the number specified by `partition_count` in the PartitionQuery request. If + # blank, there are no more results. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token - # Partition results. - # Each partition is a split point that can be used by RunQuery as a starting - # or end point for the query results. The RunQuery requests must be made with - # the same query supplied to this PartitionQuery request. The partition - # cursors will be ordered according to same ordering as the results of the - # query supplied to PartitionQuery. - # For example, if a PartitionQuery request returns partition cursors A and B, - # running the following three queries will return the entire result set of - # the original query: - # * query, end_at A - # * query, start_at A, end_at B - # * query, start_at B + # Partition results. Each partition is a split point that can be used by + # RunQuery as a starting or end point for the query results. The RunQuery + # requests must be made with the same query supplied to this PartitionQuery + # request. The partition cursors will be ordered according to same ordering as + # the results of the query supplied to PartitionQuery. For example, if a + # PartitionQuery request returns partition cursors A and B, running the + # following three queries will return the entire result set of the original + # query: * query, end_at A * query, start_at A, end_at B * query, start_at B An + # empty result may indicate that the query has too few results to be partitioned. # Corresponds to the JSON property `partitions` # @return [Array] attr_accessor :partitions @@ -1586,15 +1541,15 @@ module Google class Precondition include Google::Apis::Core::Hashable - # When set to `true`, the target document must exist. - # When set to `false`, the target document must not exist. + # When set to `true`, the target document must exist. When set to `false`, the + # target document must not exist. # Corresponds to the JSON property `exists` # @return [Boolean] attr_accessor :exists alias_method :exists?, :exists - # When set, the target document must exist and have been last updated at - # that time. + # When set, the target document must exist and have been last updated at that + # time. # Corresponds to the JSON property `updateTime` # @return [String] attr_accessor :update_time @@ -1614,9 +1569,8 @@ module Google class Projection include Google::Apis::Core::Hashable - # The fields to return. - # If empty, all fields are returned. To only return the name - # of the document, use `['__name__']`. + # The fields to return. If empty, all fields are returned. To only return the + # name of the document, use `['__name__']`. # Corresponds to the JSON property `fields` # @return [Array] attr_accessor :fields @@ -1635,12 +1589,11 @@ module Google class QueryTarget include Google::Apis::Core::Hashable - # The parent resource name. In the format: - # `projects/`project_id`/databases/`database_id`/documents` or - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. - # For example: - # `projects/my-project/databases/my-database/documents` or - # `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + # The parent resource name. In the format: `projects/`project_id`/databases/` + # database_id`/documents` or `projects/`project_id`/databases/`database_id`/ + # documents/`document_path``. For example: `projects/my-project/databases/my- + # database/documents` or `projects/my-project/databases/my-database/documents/ + # chatrooms/my-chatroom` # Corresponds to the JSON property `parent` # @return [String] attr_accessor :parent @@ -1665,8 +1618,7 @@ module Google class ReadOnly include Google::Apis::Core::Hashable - # Reads documents at the given time. - # This may not be older than 60 seconds. + # Reads documents at the given time. This may not be older than 60 seconds. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -1730,8 +1682,8 @@ module Google # @return [Google::Apis::FirestoreV1beta1::TransactionOptions] attr_accessor :new_transaction - # Reads documents as they were at the given time. - # This may not be older than 270 seconds. + # Reads documents as they were at the given time. This may not be older than 270 + # seconds. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time @@ -1764,32 +1716,29 @@ module Google class RunQueryResponse include Google::Apis::Core::Hashable - # A Firestore document. - # Must not exceed 1 MiB - 4 bytes. + # A Firestore document. Must not exceed 1 MiB - 4 bytes. # Corresponds to the JSON property `document` # @return [Google::Apis::FirestoreV1beta1::Document] attr_accessor :document - # The time at which the document was read. This may be monotonically - # increasing; in this case, the previous documents in the result stream are - # guaranteed not to have changed between their `read_time` and this one. - # If the query returns no results, a response with `read_time` and no - # `document` will be sent, and this represents the time at which the query - # was run. + # The time at which the document was read. This may be monotonically increasing; + # in this case, the previous documents in the result stream are guaranteed not + # to have changed between their `read_time` and this one. If the query returns + # no results, a response with `read_time` and no `document` will be sent, and + # this represents the time at which the query was run. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time - # The number of results that have been skipped due to an offset between - # the last response and the current response. + # The number of results that have been skipped due to an offset between the last + # response and the current response. # Corresponds to the JSON property `skippedResults` # @return [Fixnum] attr_accessor :skipped_results - # The transaction that was started as part of this request. - # Can only be set in the first response, and only if - # RunQueryRequest.new_transaction was set in the request. - # If set, no other fields will be set in this response. + # The transaction that was started as part of this request. Can only be set in + # the first response, and only if RunQueryRequest.new_transaction was set in the + # request. If set, no other fields will be set in this response. # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1808,12 +1757,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 @@ -1822,15 +1771,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 @@ -1861,34 +1810,28 @@ module Google # @return [Array] attr_accessor :from - # The maximum number of results to return. - # Applies after all other constraints. + # The maximum number of results to return. Applies after all other constraints. # Must be >= 0 if specified. # Corresponds to the JSON property `limit` # @return [Fixnum] attr_accessor :limit - # The number of results to skip. - # Applies before limit, but after all other constraints. Must be >= 0 if - # specified. + # The number of results to skip. Applies before limit, but after all other + # constraints. Must be >= 0 if specified. # Corresponds to the JSON property `offset` # @return [Fixnum] attr_accessor :offset - # The order to apply to the query results. - # Firestore guarantees a stable ordering through the following rules: - # * Any field required to appear in `order_by`, that is not already - # specified in `order_by`, is appended to the order in field name order - # by default. - # * If an order on `__name__` is not specified, it is appended by default. - # Fields are appended with the same sort direction as the last order - # specified, or 'ASCENDING' if no order was specified. For example: - # * `SELECT * FROM Foo ORDER BY A` becomes - # `SELECT * FROM Foo ORDER BY A, __name__` - # * `SELECT * FROM Foo ORDER BY A DESC` becomes - # `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC` - # * `SELECT * FROM Foo WHERE A > 1` becomes - # `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__` + # The order to apply to the query results. Firestore guarantees a stable + # ordering through the following rules: * Any field required to appear in ` + # order_by`, that is not already specified in `order_by`, is appended to the + # order in field name order by default. * If an order on `__name__` is not + # specified, it is appended by default. Fields are appended with the same sort + # direction as the last order specified, or 'ASCENDING' if no order was + # specified. For example: * `SELECT * FROM Foo ORDER BY A` becomes `SELECT * + # FROM Foo ORDER BY A, __name__` * `SELECT * FROM Foo ORDER BY A DESC` becomes ` + # SELECT * FROM Foo ORDER BY A DESC, __name__ DESC` * `SELECT * FROM Foo WHERE A + # > 1` becomes `SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__` # Corresponds to the JSON property `orderBy` # @return [Array] attr_accessor :order_by @@ -1945,14 +1888,14 @@ module Google # @return [Google::Apis::FirestoreV1beta1::QueryTarget] attr_accessor :query - # Start listening after a specific `read_time`. - # The client must know the state of matching documents at this time. + # Start listening after a specific `read_time`. The client must know the state + # of matching documents at this time. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time - # A resume token from a prior TargetChange for an identical target. - # Using a resume token with a different target is unsupported and may fail. + # A resume token from a prior TargetChange for an identical target. Using a + # resume token with a different target is unsupported and may fail. # Corresponds to the JSON property `resumeToken` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -1983,31 +1926,29 @@ module Google class TargetChange 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 `cause` # @return [Google::Apis::FirestoreV1beta1::Status] attr_accessor :cause # The consistent `read_time` for the given `target_ids` (omitted when the - # target_ids are not at a consistent snapshot). - # The stream is guaranteed to send a `read_time` with `target_ids` empty - # whenever the entire stream reaches a new consistent snapshot. ADD, - # CURRENT, and RESET messages are guaranteed to (eventually) result in a - # new consistent snapshot (while NO_CHANGE and REMOVE messages are not). - # For a given stream, `read_time` is guaranteed to be monotonically - # increasing. + # target_ids are not at a consistent snapshot). The stream is guaranteed to send + # a `read_time` with `target_ids` empty whenever the entire stream reaches a new + # consistent snapshot. ADD, CURRENT, and RESET messages are guaranteed to ( + # eventually) result in a new consistent snapshot (while NO_CHANGE and REMOVE + # messages are not). For a given stream, `read_time` is guaranteed to be + # monotonically increasing. # Corresponds to the JSON property `readTime` # @return [String] attr_accessor :read_time - # A token that can be used to resume the stream for the given `target_ids`, - # or all targets if `target_ids` is empty. - # Not set on every target change. + # A token that can be used to resume the stream for the given `target_ids`, or + # all targets if `target_ids` is empty. Not set on every target change. # Corresponds to the JSON property `resumeToken` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -2018,9 +1959,8 @@ module Google # @return [String] attr_accessor :target_change_type - # The target IDs of targets that have changed. - # If empty, the change applies to all targets. - # The order of the target IDs is not defined. + # The target IDs of targets that have changed. If empty, the change applies to + # all targets. The order of the target IDs is not defined. # Corresponds to the JSON property `targetIds` # @return [Array] attr_accessor :target_ids @@ -2104,9 +2044,8 @@ module Google attr_accessor :boolean_value alias_method :boolean_value?, :boolean_value - # A bytes value. - # Must not exceed 1 MiB - 89 bytes. - # Only the first 1,500 bytes are considered by queries. + # A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes + # are considered by queries. # Corresponds to the JSON property `bytesValue` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -2119,9 +2058,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 `geoPointValue` # @return [Google::Apis::FirestoreV1beta1::LatLng] attr_accessor :geo_point_value @@ -2141,23 +2079,21 @@ module Google # @return [String] attr_accessor :null_value - # A reference to a document. For example: - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. + # A reference to a document. For example: `projects/`project_id`/databases/` + # database_id`/documents/`document_path``. # Corresponds to the JSON property `referenceValue` # @return [String] attr_accessor :reference_value - # A string value. - # The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. - # Only the first 1,500 bytes of the UTF-8 representation are considered by - # queries. + # A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 + # bytes. Only the first 1,500 bytes of the UTF-8 representation are considered + # by queries. # Corresponds to the JSON property `stringValue` # @return [String] attr_accessor :string_value - # A timestamp value. - # Precise only to microseconds. When stored, any additional precision is - # rounded down. + # A timestamp value. Precise only to microseconds. When stored, any additional + # precision is rounded down. # Corresponds to the JSON property `timestampValue` # @return [String] attr_accessor :timestamp_value @@ -2191,8 +2127,8 @@ module Google # @return [Google::Apis::FirestoreV1beta1::Precondition] attr_accessor :current_document - # A document name to delete. In the format: - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. + # A document name to delete. In the format: `projects/`project_id`/databases/` + # database_id`/documents/`document_path``. # Corresponds to the JSON property `delete` # @return [String] attr_accessor :delete @@ -2202,25 +2138,22 @@ module Google # @return [Google::Apis::FirestoreV1beta1::DocumentTransform] attr_accessor :transform - # A Firestore document. - # Must not exceed 1 MiB - 4 bytes. + # A Firestore document. Must not exceed 1 MiB - 4 bytes. # Corresponds to the JSON property `update` # @return [Google::Apis::FirestoreV1beta1::Document] attr_accessor :update - # A set of field paths on a document. - # Used to restrict a get or update operation on a document to a subset of its - # fields. - # This is different from standard field masks, as this is always scoped to a - # Document, and takes in account the dynamic nature of Value. + # A set of field paths on a document. Used to restrict a get or update operation + # on a document to a subset of its fields. This is different from standard field + # masks, as this is always scoped to a Document, and takes in account the + # dynamic nature of Value. # Corresponds to the JSON property `updateMask` # @return [Google::Apis::FirestoreV1beta1::DocumentMask] attr_accessor :update_mask - # The transforms to perform after update. - # This field can be set only when the operation is `update`. If present, this - # write is equivalent to performing `update` and `transform` to the same - # document atomically and in order. + # The transforms to perform after update. This field can be set only when the + # operation is `update`. If present, this write is equivalent to performing ` + # update` and `transform` to the same document atomically and in order. # Corresponds to the JSON property `updateTransforms` # @return [Array] attr_accessor :update_transforms @@ -2240,13 +2173,12 @@ module Google end end - # The request for Firestore.Write. - # The first request creates a stream, or resumes an existing one from a token. - # When creating a new stream, the server replies with a response containing - # only an ID and a token, to use in the next request. - # When resuming a stream, the server first streams any responses later than the - # given token, then a response containing only an up-to-date token, to use in - # the next request. + # The request for Firestore.Write. The first request creates a stream, or + # resumes an existing one from a token. When creating a new stream, the server + # replies with a response containing only an ID and a token, to use in the next + # request. When resuming a stream, the server first streams any responses later + # than the given token, then a response containing only an up-to-date token, to + # use in the next request. class WriteRequest include Google::Apis::Core::Hashable @@ -2255,33 +2187,28 @@ module Google # @return [Hash] attr_accessor :labels - # The ID of the write stream to resume. - # This may only be set in the first message. When left empty, a new write - # stream will be created. + # The ID of the write stream to resume. This may only be set in the first + # message. When left empty, a new write stream will be created. # Corresponds to the JSON property `streamId` # @return [String] attr_accessor :stream_id - # A stream token that was previously sent by the server. - # The client should set this field to the token from the most recent - # WriteResponse it has received. This acknowledges that the client has - # received responses up to this token. After sending this token, earlier - # tokens may not be used anymore. - # The server may close the stream if there are too many unacknowledged - # responses. - # Leave this field unset when creating a new stream. To resume a stream at - # a specific point, set this field and the `stream_id` field. - # Leave this field unset when creating a new stream. + # A stream token that was previously sent by the server. The client should set + # this field to the token from the most recent WriteResponse it has received. + # This acknowledges that the client has received responses up to this token. + # After sending this token, earlier tokens may not be used anymore. The server + # may close the stream if there are too many unacknowledged responses. Leave + # this field unset when creating a new stream. To resume a stream at a specific + # point, set this field and the `stream_id` field. Leave this field unset when + # creating a new stream. # Corresponds to the JSON property `streamToken` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :stream_token - # The writes to apply. - # Always executed atomically and in order. - # This must be empty on the first request. - # This may be empty on the last request. - # This must not be empty on all other requests. + # The writes to apply. Always executed atomically and in order. This must be + # empty on the first request. This may be empty on the last request. This must + # not be empty on all other requests. # Corresponds to the JSON property `writes` # @return [Array] attr_accessor :writes @@ -2303,29 +2230,28 @@ module Google class WriteResponse include Google::Apis::Core::Hashable - # The time at which the commit occurred. Any read with an equal or greater - # `read_time` is guaranteed to see the effects of the write. + # The time at which the commit occurred. Any read with an equal or greater ` + # read_time` is guaranteed to see the effects of the write. # Corresponds to the JSON property `commitTime` # @return [String] attr_accessor :commit_time - # The ID of the stream. - # Only set on the first message, when a new stream was created. + # The ID of the stream. Only set on the first message, when a new stream was + # created. # Corresponds to the JSON property `streamId` # @return [String] attr_accessor :stream_id - # A token that represents the position of this response in the stream. - # This can be used by a client to resume the stream at this point. - # This field is always set. + # A token that represents the position of this response in the stream. This can + # be used by a client to resume the stream at this point. This field is always + # set. # Corresponds to the JSON property `streamToken` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :stream_token - # The result of applying the writes. - # This i-th write result corresponds to the i-th write in the - # request. + # The result of applying the writes. This i-th write result corresponds to the i- + # th write in the request. # Corresponds to the JSON property `writeResults` # @return [Array] attr_accessor :write_results @@ -2347,15 +2273,14 @@ module Google class WriteResult include Google::Apis::Core::Hashable - # The results of applying each DocumentTransform.FieldTransform, in the - # same order. + # The results of applying each DocumentTransform.FieldTransform, in the same + # order. # Corresponds to the JSON property `transformResults` # @return [Array] attr_accessor :transform_results - # The last update time of the document after applying the write. Not set - # after a `delete`. - # If the write did not actually change the document, this will be the + # The last update time of the document after applying the write. Not set after a + # `delete`. If the write did not actually change the document, this will be the # previous update_time. # Corresponds to the JSON property `updateTime` # @return [String] diff --git a/generated/google/apis/firestore_v1beta1/service.rb b/generated/google/apis/firestore_v1beta1/service.rb index e749962c6..1c8e67dcf 100644 --- a/generated/google/apis/firestore_v1beta1/service.rb +++ b/generated/google/apis/firestore_v1beta1/service.rb @@ -48,17 +48,16 @@ module Google @batch_path = 'batch' end - # Exports a copy of all or a subset of documents from Google Cloud Firestore - # to another storage system, such as Google Cloud Storage. Recent updates to + # Exports a copy of all or a subset of documents from Google Cloud Firestore to + # another storage system, such as Google Cloud Storage. Recent updates to # documents may not be reflected in the export. The export occurs in the - # background and its progress can be monitored and managed via the - # Operation resource that is created. The output of an export may only be - # used once the associated operation is done. If an export operation is - # cancelled before completion it may leave partial data behind in Google - # Cloud Storage. + # background and its progress can be monitored and managed via the Operation + # resource that is created. The output of an export may only be used once the + # associated operation is done. If an export operation is cancelled before + # completion it may leave partial data behind in Google Cloud Storage. # @param [String] name - # Database to export. Should be of the form: - # `projects/`project_id`/databases/`database_id``. + # Database to export. Should be of the form: `projects/`project_id`/databases/` + # database_id``. # @param [Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ExportDocumentsRequest] google_firestore_admin_v1beta1_export_documents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -92,11 +91,11 @@ module Google # Imports documents into Google Cloud Firestore. Existing documents with the # same name are overwritten. The import occurs in the background and its # progress can be monitored and managed via the Operation resource that is - # created. If an ImportDocuments operation is cancelled, it is possible - # that a subset of the data has already been imported to Cloud Firestore. + # created. If an ImportDocuments operation is cancelled, it is possible that a + # subset of the data has already been imported to Cloud Firestore. # @param [String] name - # Database to import into. Should be of the form: - # `projects/`project_id`/databases/`database_id``. + # Database to import into. Should be of the form: `projects/`project_id`/ + # databases/`database_id``. # @param [Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ImportDocumentsRequest] google_firestore_admin_v1beta1_import_documents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -127,12 +126,11 @@ module Google execute_or_queue_command(command, &block) end - # Gets multiple documents. - # Documents returned by this method are not guaranteed to be returned in the - # same order that they were requested. + # Gets multiple documents. Documents returned by this method are not guaranteed + # to be returned in the same order that they were requested. # @param [String] database - # Required. The database name. In the format: - # `projects/`project_id`/databases/`database_id``. + # Required. The database name. In the format: `projects/`project_id`/databases/` + # database_id``. # @param [Google::Apis::FirestoreV1beta1::BatchGetDocumentsRequest] batch_get_documents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -163,16 +161,14 @@ module Google execute_or_queue_command(command, &block) end - # Applies a batch of write operations. - # The BatchWrite method does not apply the write operations atomically - # and can apply them out of order. Method does not allow more than one write - # per document. Each write succeeds or fails independently. See the - # BatchWriteResponse for the success status of each write. - # If you require an atomically applied set of writes, use - # Commit instead. + # Applies a batch of write operations. The BatchWrite method does not apply the + # write operations atomically and can apply them out of order. Method does not + # allow more than one write per document. Each write succeeds or fails + # independently. See the BatchWriteResponse for the success status of each write. + # If you require an atomically applied set of writes, use Commit instead. # @param [String] database - # Required. The database name. In the format: - # `projects/`project_id`/databases/`database_id``. + # Required. The database name. In the format: `projects/`project_id`/databases/` + # database_id``. # @param [Google::Apis::FirestoreV1beta1::BatchWriteRequest] batch_write_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -205,8 +201,8 @@ module Google # Starts a new transaction. # @param [String] database - # Required. The database name. In the format: - # `projects/`project_id`/databases/`database_id``. + # Required. The database name. In the format: `projects/`project_id`/databases/` + # database_id``. # @param [Google::Apis::FirestoreV1beta1::BeginTransactionRequest] begin_transaction_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -239,8 +235,8 @@ module Google # Commits a transaction, while optionally updating documents. # @param [String] database - # Required. The database name. In the format: - # `projects/`project_id`/databases/`database_id``. + # Required. The database name. In the format: `projects/`project_id`/databases/` + # database_id``. # @param [Google::Apis::FirestoreV1beta1::CommitRequest] commit_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -273,20 +269,19 @@ module Google # Creates a new document. # @param [String] parent - # Required. The parent resource. For example: - # `projects/`project_id`/databases/`database_id`/documents` or - # `projects/`project_id`/databases/`database_id`/documents/chatrooms/` - # chatroom_id`` + # Required. The parent resource. For example: `projects/`project_id`/databases/` + # database_id`/documents` or `projects/`project_id`/databases/`database_id`/ + # documents/chatrooms/`chatroom_id`` # @param [String] collection_id # Required. The collection ID, relative to `parent`, to list. For example: ` # chatrooms`. # @param [Google::Apis::FirestoreV1beta1::Document] document_object # @param [String] document_id - # The client-assigned document ID to use for this document. - # Optional. If not specified, an ID will be assigned by the service. + # The client-assigned document ID to use for this document. Optional. If not + # specified, an ID will be assigned by the service. # @param [Array, String] mask_field_paths - # The list of field paths in the mask. See Document.fields for a field - # path syntax reference. + # The list of field paths in the mask. See Document.fields for a field path + # syntax reference. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -321,14 +316,14 @@ module Google # Deletes a document. # @param [String] name - # Required. The resource name of the Document to delete. In the format: - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. + # Required. The resource name of the Document to delete. In the format: ` + # projects/`project_id`/databases/`database_id`/documents/`document_path``. # @param [Boolean] current_document_exists - # When set to `true`, the target document must exist. - # When set to `false`, the target document must not exist. + # When set to `true`, the target document must exist. When set to `false`, the + # target document must not exist. # @param [String] current_document_update_time - # When set, the target document must exist and have been last updated at - # that time. + # When set, the target document must exist and have been last updated at that + # time. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -360,14 +355,14 @@ module Google # Gets a single document. # @param [String] name - # Required. The resource name of the Document to get. In the format: - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. + # Required. The resource name of the Document to get. In the format: `projects/` + # project_id`/databases/`database_id`/documents/`document_path``. # @param [Array, String] mask_field_paths - # The list of field paths in the mask. See Document.fields for a field - # path syntax reference. + # The list of field paths in the mask. See Document.fields for a field path + # syntax reference. # @param [String] read_time - # Reads the version of the document at the given time. - # This may not be older than 270 seconds. + # Reads the version of the document at the given time. This may not be older + # than 270 seconds. # @param [String] transaction # Reads the document in a transaction. # @param [String] fields @@ -402,19 +397,17 @@ module Google # Lists documents. # @param [String] parent - # Required. The parent resource name. In the format: - # `projects/`project_id`/databases/`database_id`/documents` or - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. - # For example: - # `projects/my-project/databases/my-database/documents` or - # `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + # Required. The parent resource name. In the format: `projects/`project_id`/ + # databases/`database_id`/documents` or `projects/`project_id`/databases/` + # database_id`/documents/`document_path``. For example: `projects/my-project/ + # databases/my-database/documents` or `projects/my-project/databases/my-database/ + # documents/chatrooms/my-chatroom` # @param [String] collection_id # Required. The collection ID, relative to `parent`, to list. For example: ` - # chatrooms` - # or `messages`. + # chatrooms` or `messages`. # @param [Array, String] mask_field_paths - # The list of field paths in the mask. See Document.fields for a field - # path syntax reference. + # The list of field paths in the mask. See Document.fields for a field path + # syntax reference. # @param [String] order_by # The order to sort results by. For example: `priority desc, name`. # @param [Fixnum] page_size @@ -422,15 +415,14 @@ module Google # @param [String] page_token # The `next_page_token` value returned from a previous List request, if any. # @param [String] read_time - # Reads documents as they were at the given time. - # This may not be older than 270 seconds. + # Reads documents as they were at the given time. This may not be older than 270 + # seconds. # @param [Boolean] show_missing - # If the list should show missing documents. A missing document is a - # document that does not exist but has sub-documents. These documents will - # be returned with a key but will not have fields, Document.create_time, - # or Document.update_time set. - # Requests with `show_missing` may not specify `where` or - # `order_by`. + # If the list should show missing documents. A missing document is a document + # that does not exist but has sub-documents. These documents will be returned + # with a key but will not have fields, Document.create_time, or Document. + # update_time set. Requests with `show_missing` may not specify `where` or ` + # order_by`. # @param [String] transaction # Reads documents in a transaction. # @param [String] fields @@ -470,10 +462,9 @@ module Google # Lists all the collection IDs underneath a document. # @param [String] parent - # Required. The parent document. In the format: - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. - # For example: - # `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + # Required. The parent document. In the format: `projects/`project_id`/databases/ + # `database_id`/documents/`document_path``. For example: `projects/my-project/ + # databases/my-database/documents/chatrooms/my-chatroom` # @param [Google::Apis::FirestoreV1beta1::ListCollectionIdsRequest] list_collection_ids_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -506,8 +497,8 @@ module Google # Listens to changes. # @param [String] database - # Required. The database name. In the format: - # `projects/`project_id`/databases/`database_id``. + # Required. The database name. In the format: `projects/`project_id`/databases/` + # database_id``. # @param [Google::Apis::FirestoreV1beta1::ListenRequest] listen_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -538,14 +529,13 @@ module Google execute_or_queue_command(command, &block) end - # Partitions a query by returning partition cursors that can be used to run - # the query in parallel. The returned partition cursors are split points that - # can be used by RunQuery as starting/end points for the query results. + # Partitions a query by returning partition cursors that can be used to run the + # query in parallel. The returned partition cursors are split points that can be + # used by RunQuery as starting/end points for the query results. # @param [String] parent - # Required. The parent resource name. In the format: - # `projects/`project_id`/databases/`database_id`/documents`. - # Document resource names are not supported; only database resource names - # can be specified. + # Required. The parent resource name. In the format: `projects/`project_id`/ + # databases/`database_id`/documents`. Document resource names are not supported; + # only database resource names can be specified. # @param [Google::Apis::FirestoreV1beta1::PartitionQueryRequest] partition_query_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -578,21 +568,21 @@ module Google # Updates or inserts a document. # @param [String] name - # The resource name of the document, for example - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. + # The resource name of the document, for example `projects/`project_id`/ + # databases/`database_id`/documents/`document_path``. # @param [Google::Apis::FirestoreV1beta1::Document] document_object # @param [Boolean] current_document_exists - # When set to `true`, the target document must exist. - # When set to `false`, the target document must not exist. + # When set to `true`, the target document must exist. When set to `false`, the + # target document must not exist. # @param [String] current_document_update_time - # When set, the target document must exist and have been last updated at - # that time. + # When set, the target document must exist and have been last updated at that + # time. # @param [Array, String] mask_field_paths - # The list of field paths in the mask. See Document.fields for a field - # path syntax reference. + # The list of field paths in the mask. See Document.fields for a field path + # syntax reference. # @param [Array, String] update_mask_field_paths - # The list of field paths in the mask. See Document.fields for a field - # path syntax reference. + # The list of field paths in the mask. See Document.fields for a field path + # syntax reference. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -628,8 +618,8 @@ module Google # Rolls back a transaction. # @param [String] database - # Required. The database name. In the format: - # `projects/`project_id`/databases/`database_id``. + # Required. The database name. In the format: `projects/`project_id`/databases/` + # database_id``. # @param [Google::Apis::FirestoreV1beta1::RollbackRequest] rollback_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -662,12 +652,11 @@ module Google # Runs a query. # @param [String] parent - # Required. The parent resource name. In the format: - # `projects/`project_id`/databases/`database_id`/documents` or - # `projects/`project_id`/databases/`database_id`/documents/`document_path``. - # For example: - # `projects/my-project/databases/my-database/documents` or - # `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom` + # Required. The parent resource name. In the format: `projects/`project_id`/ + # databases/`database_id`/documents` or `projects/`project_id`/databases/` + # database_id`/documents/`document_path``. For example: `projects/my-project/ + # databases/my-database/documents` or `projects/my-project/databases/my-database/ + # documents/chatrooms/my-chatroom` # @param [Google::Apis::FirestoreV1beta1::RunQueryRequest] run_query_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -700,9 +689,8 @@ module Google # Streams batches of document updates and deletes, in order. # @param [String] database - # Required. The database name. In the format: - # `projects/`project_id`/databases/`database_id``. - # This is only required in the first message. + # Required. The database name. In the format: `projects/`project_id`/databases/` + # database_id``. This is only required in the first message. # @param [Google::Apis::FirestoreV1beta1::WriteRequest] write_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -733,20 +721,17 @@ module Google execute_or_queue_command(command, &block) end - # Creates the specified index. - # A newly created index's initial state is `CREATING`. On completion of the - # returned google.longrunning.Operation, the state will be `READY`. - # If the index already exists, the call will return an `ALREADY_EXISTS` - # status. - # During creation, the process could result in an error, in which case the - # index will move to the `ERROR` state. The process can be recovered by - # fixing the data that caused the error, removing the index with - # delete, then re-creating the index with - # create. - # Indexes with a single field cannot be created. + # Creates the specified index. A newly created index's initial state is ` + # CREATING`. On completion of the returned google.longrunning.Operation, the + # state will be `READY`. If the index already exists, the call will return an ` + # ALREADY_EXISTS` status. During creation, the process could result in an error, + # in which case the index will move to the `ERROR` state. The process can be + # recovered by fixing the data that caused the error, removing the index with + # delete, then re-creating the index with create. Indexes with a single field + # cannot be created. # @param [String] parent - # The name of the database this index will apply to. For example: - # `projects/`project_id`/databases/`database_id`` + # The name of the database this index will apply to. For example: `projects/` + # project_id`/databases/`database_id`` # @param [Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Index] google_firestore_admin_v1beta1_index_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -779,8 +764,8 @@ module Google # Deletes an index. # @param [String] name - # The index name. For example: - # `projects/`project_id`/databases/`database_id`/indexes/`index_id`` + # The index name. For example: `projects/`project_id`/databases/`database_id`/ + # indexes/`index_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -810,8 +795,8 @@ module Google # Gets an index. # @param [String] name - # The name of the index. For example: - # `projects/`project_id`/databases/`database_id`/indexes/`index_id`` + # The name of the index. For example: `projects/`project_id`/databases/` + # database_id`/indexes/`index_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -841,8 +826,7 @@ module Google # Lists the indexes that match the specified filters. # @param [String] parent - # The database name. For example: - # `projects/`project_id`/databases/`database_id`` + # The database name. For example: `projects/`project_id`/databases/`database_id`` # @param [String] filter # @param [Fixnum] page_size # The standard List page size. diff --git a/generated/google/apis/firestore_v1beta2.rb b/generated/google/apis/firestore_v1beta2.rb index b7ef1ece3..82490b80d 100644 --- a/generated/google/apis/firestore_v1beta2.rb +++ b/generated/google/apis/firestore_v1beta2.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/firestore module FirestoreV1beta2 VERSION = 'V1beta2' - REVISION = '20200215' + REVISION = '20200801' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/firestore_v1beta2/classes.rb b/generated/google/apis/firestore_v1beta2/classes.rb index aaf22b884..174d374c7 100644 --- a/generated/google/apis/firestore_v1beta2/classes.rb +++ b/generated/google/apis/firestore_v1beta2/classes.rb @@ -22,13 +22,11 @@ module Google module Apis module FirestoreV1beta2 - # A generic empty message that you can re-use to avoid defining duplicated - # empty messages in your APIs. A typical example is to use it as the request - # or the response type of an API method. For instance: - # service Foo ` - # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); - # ` - # The JSON representation for `Empty` is empty JSON object ````. + # A generic empty message that you can re-use to avoid defining duplicated empty + # messages in your APIs. A typical example is to use it as the request or the + # response type of an API method. For instance: service Foo ` rpc Bar(google. + # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for + # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable @@ -41,8 +39,8 @@ module Google end end - # Metadata for google.longrunning.Operation results from - # FirestoreAdmin.ExportDocuments. + # Metadata for google.longrunning.Operation results from FirestoreAdmin. + # ExportDocuments. class GoogleFirestoreAdminV1beta2ExportDocumentsMetadata include Google::Apis::Core::Hashable @@ -67,16 +65,14 @@ module Google # @return [String] attr_accessor :output_uri_prefix - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. # Corresponds to the JSON property `progressBytes` # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress] attr_accessor :progress_bytes - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. # Corresponds to the JSON property `progressDocuments` # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress] attr_accessor :progress_documents @@ -111,14 +107,13 @@ module Google # @return [Array] attr_accessor :collection_ids - # The output URI. Currently only supports Google Cloud Storage URIs of the - # form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name - # of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional - # Google Cloud Storage namespace path. When - # choosing a name, be sure to consider Google Cloud Storage naming - # guidelines: https://cloud.google.com/storage/docs/naming. - # If the URI is a bucket (without a namespace path), a prefix will be - # generated based on the start time. + # The output URI. Currently only supports Google Cloud Storage URIs of the form: + # `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the + # Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud + # Storage namespace path. When choosing a name, be sure to consider Google Cloud + # Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If + # the URI is a bucket (without a namespace path), a prefix will be generated + # based on the start time. # Corresponds to the JSON property `outputUriPrefix` # @return [String] attr_accessor :output_uri_prefix @@ -138,9 +133,9 @@ module Google class GoogleFirestoreAdminV1beta2ExportDocumentsResponse include Google::Apis::Core::Hashable - # Location of the output files. This can be used to begin an import - # into Cloud Firestore (this project or another project) after the operation - # completes successfully. + # Location of the output files. This can be used to begin an import into Cloud + # Firestore (this project or another project) after the operation completes + # successfully. # Corresponds to the JSON property `outputUriPrefix` # @return [String] attr_accessor :output_uri_prefix @@ -155,9 +150,9 @@ module Google end end - # Represents a single field in the database. - # Fields are grouped by their "Collection Group", which represent all - # collections in the database with the same id. + # Represents a single field in the database. Fields are grouped by their " + # Collection Group", which represent all collections in the database with the + # same id. class GoogleFirestoreAdminV1beta2Field include Google::Apis::Core::Hashable @@ -166,28 +161,21 @@ module Google # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2IndexConfig] attr_accessor :index_config - # A field name of the form - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # /fields/`field_path`` - # A field path may be a simple field name, e.g. `address` or a path to fields - # within map_value , e.g. `address.city`, - # or a special field path. The only valid special field is `*`, which - # represents any field. - # Field paths may be quoted using ` (backtick). The only character that needs - # to be escaped within a quoted field path is the backtick character itself, - # escaped using a backslash. Special characters in field paths that - # must be quoted include: `*`, `.`, - # ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. - # Examples: - # (Note: Comments here are written in markdown syntax, so there is an - # additional layer of backticks to represent a code block) - # `\`address.city\`` represents a field named `address.city`, not the map key - # `city` in the field `address`. - # `\`*\`` represents a field named `*`, not any field. - # A special `Field` contains the default indexing settings for all fields. - # This field's resource name is: - # `projects/`project_id`/databases/`database_id`/collectionGroups/__default__/ - # fields/*` + # A field name of the form `projects/`project_id`/databases/`database_id`/ + # collectionGroups/`collection_id`/fields/`field_path`` A field path may be a + # simple field name, e.g. `address` or a path to fields within map_value , e.g. ` + # address.city`, or a special field path. The only valid special field is `*`, + # which represents any field. Field paths may be quoted using ` (backtick). The + # only character that needs to be escaped within a quoted field path is the + # backtick character itself, escaped using a backslash. Special characters in + # field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, + # as well as any ascii symbolic characters. Examples: (Note: Comments here are + # written in markdown syntax, so there is an additional layer of backticks to + # represent a code block) `\`address.city\`` represents a field named `address. + # city`, not the map key `city` in the field `address`. `\`*\`` represents a + # field named `*`, not any field. A special `Field` contains the default + # indexing settings for all fields. This field's resource name is: `projects/` + # project_id`/databases/`database_id`/collectionGroups/__default__/fields/*` # Indexes defined on this `Field` will be applied to all fields which do not # have their own `Field` index configuration. # Corresponds to the JSON property `name` @@ -205,21 +193,19 @@ module Google end end - # Metadata for google.longrunning.Operation results from - # FirestoreAdmin.UpdateField. + # Metadata for google.longrunning.Operation results from FirestoreAdmin. + # UpdateField. class GoogleFirestoreAdminV1beta2FieldOperationMetadata include Google::Apis::Core::Hashable - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. # Corresponds to the JSON property `bytesProgress` # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress] attr_accessor :bytes_progress - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. # Corresponds to the JSON property `documentProgress` # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress] attr_accessor :document_progress @@ -230,15 +216,14 @@ module Google # @return [String] attr_accessor :end_time - # The field resource that this operation is acting on. For example: - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # /fields/`field_path`` + # The field resource that this operation is acting on. For example: `projects/` + # project_id`/databases/`database_id`/collectionGroups/`collection_id`/fields/` + # field_path`` # Corresponds to the JSON property `field` # @return [String] attr_accessor :field - # A list of IndexConfigDelta, which describe the intent of this - # operation. + # A list of IndexConfigDelta, which describe the intent of this operation. # Corresponds to the JSON property `indexConfigDeltas` # @return [Array] attr_accessor :index_config_deltas @@ -269,8 +254,8 @@ module Google end end - # Metadata for google.longrunning.Operation results from - # FirestoreAdmin.ImportDocuments. + # Metadata for google.longrunning.Operation results from FirestoreAdmin. + # ImportDocuments. class GoogleFirestoreAdminV1beta2ImportDocumentsMetadata include Google::Apis::Core::Hashable @@ -295,16 +280,14 @@ module Google # @return [String] attr_accessor :operation_state - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. # Corresponds to the JSON property `progressBytes` # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress] attr_accessor :progress_bytes - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. # Corresponds to the JSON property `progressDocuments` # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress] attr_accessor :progress_documents @@ -334,16 +317,14 @@ module Google class GoogleFirestoreAdminV1beta2ImportDocumentsRequest include Google::Apis::Core::Hashable - # Which collection ids to import. Unspecified means all collections included - # in the import. + # Which collection ids to import. Unspecified means all collections included in + # the import. # Corresponds to the JSON property `collectionIds` # @return [Array] attr_accessor :collection_ids - # Location of the exported files. - # This must match the output_uri_prefix of an ExportDocumentsResponse from - # an export that has completed successfully. - # See: + # Location of the exported files. This must match the output_uri_prefix of an + # ExportDocumentsResponse from an export that has completed successfully. See: # google.firestore.admin.v1beta2.ExportDocumentsResponse.output_uri_prefix. # Corresponds to the JSON property `inputUriPrefix` # @return [String] @@ -360,39 +341,37 @@ module Google end end - # Cloud Firestore indexes enable simple and complex queries against - # documents in a database. + # Cloud Firestore indexes enable simple and complex queries against documents in + # a database. class GoogleFirestoreAdminV1beta2Index include Google::Apis::Core::Hashable - # The fields supported by this index. - # For composite indexes, this is always 2 or more fields. - # The last field entry is always for the field path `__name__`. If, on - # creation, `__name__` was not specified as the last field, it will be added + # The fields supported by this index. For composite indexes, this is always 2 or + # more fields. The last field entry is always for the field path `__name__`. If, + # on creation, `__name__` was not specified as the last field, it will be added # automatically with the same direction as that of the last field defined. If - # the final field in a composite index is not directional, the `__name__` - # will be ordered ASCENDING (unless explicitly specified). - # For single field indexes, this will always be exactly one entry with a - # field path equal to the field path of the associated field. + # the final field in a composite index is not directional, the `__name__` will + # be ordered ASCENDING (unless explicitly specified). For single field indexes, + # this will always be exactly one entry with a field path equal to the field + # path of the associated field. # Corresponds to the JSON property `fields` # @return [Array] attr_accessor :fields - # Output only. A server defined name for this index. - # The form of this name for composite indexes will be: - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # /indexes/`composite_index_id`` - # For single field indexes, this field will be empty. + # Output only. A server defined name for this index. The form of this name for + # composite indexes will be: `projects/`project_id`/databases/`database_id`/ + # collectionGroups/`collection_id`/indexes/`composite_index_id`` For single + # field indexes, this field will be empty. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # Indexes with a collection query scope specified allow queries - # against a collection that is the child of a specific document, specified at - # query time, and that has the same collection id. - # Indexes with a collection group query scope specified allow queries against - # all collections descended from a specific document, specified at query - # time, and that have the same collection id as this index. + # Indexes with a collection query scope specified allow queries against a + # collection that is the child of a specific document, specified at query time, + # and that has the same collection id. Indexes with a collection group query + # scope specified allow queries against all collections descended from a + # specific document, specified at query time, and that have the same collection + # id as this index. # Corresponds to the JSON property `queryScope` # @return [String] attr_accessor :query_scope @@ -420,10 +399,9 @@ module Google include Google::Apis::Core::Hashable # Output only. Specifies the resource name of the `Field` from which this field' - # s - # index configuration is set (when `uses_ancestor_config` is true), - # or from which it *would* be set if this field had no index configuration - # (when `uses_ancestor_config` is false). + # s index configuration is set (when `uses_ancestor_config` is true), or from + # which it *would* be set if this field had no index configuration (when ` + # uses_ancestor_config` is false). # Corresponds to the JSON property `ancestorField` # @return [String] attr_accessor :ancestor_field @@ -433,19 +411,18 @@ module Google # @return [Array] attr_accessor :indexes - # Output only - # When true, the `Field`'s index configuration is in the process of being - # reverted. Once complete, the index config will transition to the same - # state as the field specified by `ancestor_field`, at which point - # `uses_ancestor_config` will be `true` and `reverting` will be `false`. + # Output only When true, the `Field`'s index configuration is in the process of + # being reverted. Once complete, the index config will transition to the same + # state as the field specified by `ancestor_field`, at which point ` + # uses_ancestor_config` will be `true` and `reverting` will be `false`. # Corresponds to the JSON property `reverting` # @return [Boolean] attr_accessor :reverting alias_method :reverting?, :reverting # Output only. When true, the `Field`'s index configuration is set from the - # configuration specified by the `ancestor_field`. - # When false, the `Field`'s index configuration is defined explicitly. + # configuration specified by the `ancestor_field`. When false, the `Field`'s + # index configuration is defined explicitly. # Corresponds to the JSON property `usesAncestorConfig` # @return [Boolean] attr_accessor :uses_ancestor_config @@ -473,8 +450,8 @@ module Google # @return [String] attr_accessor :change_type - # Cloud Firestore indexes enable simple and complex queries against - # documents in a database. + # Cloud Firestore indexes enable simple and complex queries against documents in + # a database. # Corresponds to the JSON property `index` # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Index] attr_accessor :index @@ -490,9 +467,8 @@ module Google end end - # A field in an index. - # The field_path describes which field is indexed, the value_mode describes - # how the field value is indexed. + # A field in an index. The field_path describes which field is indexed, the + # value_mode describes how the field value is indexed. class GoogleFirestoreAdminV1beta2IndexField include Google::Apis::Core::Hashable @@ -501,9 +477,8 @@ module Google # @return [String] attr_accessor :array_config - # Can be __name__. - # For single field indexes, this must match the name of the field or may - # be omitted. + # Can be __name__. For single field indexes, this must match the name of the + # field or may be omitted. # Corresponds to the JSON property `fieldPath` # @return [String] attr_accessor :field_path @@ -526,8 +501,8 @@ module Google end end - # Metadata for google.longrunning.Operation results from - # FirestoreAdmin.CreateIndex. + # Metadata for google.longrunning.Operation results from FirestoreAdmin. + # CreateIndex. class GoogleFirestoreAdminV1beta2IndexOperationMetadata include Google::Apis::Core::Hashable @@ -537,23 +512,21 @@ module Google # @return [String] attr_accessor :end_time - # The index resource that this operation is acting on. For example: - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # /indexes/`index_id`` + # The index resource that this operation is acting on. For example: `projects/` + # project_id`/databases/`database_id`/collectionGroups/`collection_id`/indexes/` + # index_id`` # Corresponds to the JSON property `index` # @return [String] attr_accessor :index - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. # Corresponds to the JSON property `progressBytes` # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress] attr_accessor :progress_bytes - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. # Corresponds to the JSON property `progressDocuments` # @return [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Progress] attr_accessor :progress_documents @@ -635,9 +608,8 @@ module Google end end - # Describes the progress of the operation. - # Unit of work is generic and must be interpreted based on where Progress - # is used. + # Describes the progress of the operation. Unit of work is generic and must be + # interpreted based on where Progress is used. class GoogleFirestoreAdminV1beta2Progress include Google::Apis::Core::Hashable @@ -667,47 +639,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::FirestoreV1beta2::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 @@ -726,12 +696,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 @@ -740,15 +710,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/firestore_v1beta2/service.rb b/generated/google/apis/firestore_v1beta2/service.rb index 8027961a3..7302e342e 100644 --- a/generated/google/apis/firestore_v1beta2/service.rb +++ b/generated/google/apis/firestore_v1beta2/service.rb @@ -48,17 +48,16 @@ module Google @batch_path = 'batch' end - # Exports a copy of all or a subset of documents from Google Cloud Firestore - # to another storage system, such as Google Cloud Storage. Recent updates to + # Exports a copy of all or a subset of documents from Google Cloud Firestore to + # another storage system, such as Google Cloud Storage. Recent updates to # documents may not be reflected in the export. The export occurs in the - # background and its progress can be monitored and managed via the - # Operation resource that is created. The output of an export may only be - # used once the associated operation is done. If an export operation is - # cancelled before completion it may leave partial data behind in Google - # Cloud Storage. + # background and its progress can be monitored and managed via the Operation + # resource that is created. The output of an export may only be used once the + # associated operation is done. If an export operation is cancelled before + # completion it may leave partial data behind in Google Cloud Storage. # @param [String] name - # Database to export. Should be of the form: - # `projects/`project_id`/databases/`database_id``. + # Database to export. Should be of the form: `projects/`project_id`/databases/` + # database_id``. # @param [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2ExportDocumentsRequest] google_firestore_admin_v1beta2_export_documents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -92,11 +91,11 @@ module Google # Imports documents into Google Cloud Firestore. Existing documents with the # same name are overwritten. The import occurs in the background and its # progress can be monitored and managed via the Operation resource that is - # created. If an ImportDocuments operation is cancelled, it is possible - # that a subset of the data has already been imported to Cloud Firestore. + # created. If an ImportDocuments operation is cancelled, it is possible that a + # subset of the data has already been imported to Cloud Firestore. # @param [String] name - # Database to import into. Should be of the form: - # `projects/`project_id`/databases/`database_id``. + # Database to import into. Should be of the form: `projects/`project_id`/ + # databases/`database_id``. # @param [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2ImportDocumentsRequest] google_firestore_admin_v1beta2_import_documents_request_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -129,9 +128,8 @@ module Google # Gets the metadata and configuration for a Field. # @param [String] name - # A name of the form - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # /fields/`field_id`` + # A name of the form `projects/`project_id`/databases/`database_id`/ + # collectionGroups/`collection_id`/fields/`field_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -159,27 +157,23 @@ module Google execute_or_queue_command(command, &block) end - # Lists the field configuration and metadata for this database. - # Currently, FirestoreAdmin.ListFields only supports listing fields - # that have been explicitly overridden. To issue this query, call - # FirestoreAdmin.ListFields with the filter set to - # `indexConfig.usesAncestorConfig:false`. + # Lists the field configuration and metadata for this database. Currently, + # FirestoreAdmin.ListFields only supports listing fields that have been + # explicitly overridden. To issue this query, call FirestoreAdmin.ListFields + # with the filter set to `indexConfig.usesAncestorConfig:false`. # @param [String] parent - # A parent name of the form - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # ` + # A parent name of the form `projects/`project_id`/databases/`database_id`/ + # collectionGroups/`collection_id`` # @param [String] filter - # The filter to apply to list results. Currently, - # FirestoreAdmin.ListFields only supports listing fields - # that have been explicitly overridden. To issue this query, call - # FirestoreAdmin.ListFields with the filter set to - # `indexConfig.usesAncestorConfig:false`. + # The filter to apply to list results. Currently, FirestoreAdmin.ListFields only + # supports listing fields that have been explicitly overridden. To issue this + # query, call FirestoreAdmin.ListFields with the filter set to `indexConfig. + # usesAncestorConfig:false`. # @param [Fixnum] page_size # The number of results to return. # @param [String] page_token - # A page token, returned from a previous call to - # FirestoreAdmin.ListFields, that may be used to get the next - # page of results. + # A page token, returned from a previous call to FirestoreAdmin.ListFields, that + # may be used to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -210,47 +204,37 @@ module Google execute_or_queue_command(command, &block) end - # Updates a field configuration. Currently, field updates apply only to - # single field index configuration. However, calls to - # FirestoreAdmin.UpdateField should provide a field mask to avoid - # changing any configuration that the caller isn't aware of. The field mask - # should be specified as: `` paths: "index_config" ``. - # This call returns a google.longrunning.Operation which may be used to - # track the status of the field update. The metadata for - # the operation will be the type FieldOperationMetadata. - # To configure the default field settings for the database, use - # the special `Field` with resource name: - # `projects/`project_id`/databases/`database_id`/collectionGroups/__default__/ - # fields/*`. + # Updates a field configuration. Currently, field updates apply only to single + # field index configuration. However, calls to FirestoreAdmin.UpdateField should + # provide a field mask to avoid changing any configuration that the caller isn't + # aware of. The field mask should be specified as: `` paths: "index_config" ``. + # This call returns a google.longrunning.Operation which may be used to track + # the status of the field update. The metadata for the operation will be the + # type FieldOperationMetadata. To configure the default field settings for the + # database, use the special `Field` with resource name: `projects/`project_id`/ + # databases/`database_id`/collectionGroups/__default__/fields/*`. # @param [String] name - # A field name of the form - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # /fields/`field_path`` - # A field path may be a simple field name, e.g. `address` or a path to fields - # within map_value , e.g. `address.city`, - # or a special field path. The only valid special field is `*`, which - # represents any field. - # Field paths may be quoted using ` (backtick). The only character that needs - # to be escaped within a quoted field path is the backtick character itself, - # escaped using a backslash. Special characters in field paths that - # must be quoted include: `*`, `.`, - # ``` (backtick), `[`, `]`, as well as any ascii symbolic characters. - # Examples: - # (Note: Comments here are written in markdown syntax, so there is an - # additional layer of backticks to represent a code block) - # `\`address.city\`` represents a field named `address.city`, not the map key - # `city` in the field `address`. - # `\`*\`` represents a field named `*`, not any field. - # A special `Field` contains the default indexing settings for all fields. - # This field's resource name is: - # `projects/`project_id`/databases/`database_id`/collectionGroups/__default__/ - # fields/*` + # A field name of the form `projects/`project_id`/databases/`database_id`/ + # collectionGroups/`collection_id`/fields/`field_path`` A field path may be a + # simple field name, e.g. `address` or a path to fields within map_value , e.g. ` + # address.city`, or a special field path. The only valid special field is `*`, + # which represents any field. Field paths may be quoted using ` (backtick). The + # only character that needs to be escaped within a quoted field path is the + # backtick character itself, escaped using a backslash. Special characters in + # field paths that must be quoted include: `*`, `.`, ``` (backtick), `[`, `]`, + # as well as any ascii symbolic characters. Examples: (Note: Comments here are + # written in markdown syntax, so there is an additional layer of backticks to + # represent a code block) `\`address.city\`` represents a field named `address. + # city`, not the map key `city` in the field `address`. `\`*\`` represents a + # field named `*`, not any field. A special `Field` contains the default + # indexing settings for all fields. This field's resource name is: `projects/` + # project_id`/databases/`database_id`/collectionGroups/__default__/fields/*` # Indexes defined on this `Field` will be applied to all fields which do not # have their own `Field` index configuration. # @param [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Field] google_firestore_admin_v1beta2_field_object # @param [String] update_mask - # A mask, relative to the field. If specified, only configuration specified - # by this field_mask will be updated in the field. + # A mask, relative to the field. If specified, only configuration specified by + # this field_mask will be updated in the field. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -281,13 +265,12 @@ module Google execute_or_queue_command(command, &block) end - # Creates a composite index. This returns a google.longrunning.Operation - # which may be used to track the status of the creation. The metadata for - # the operation will be the type IndexOperationMetadata. + # Creates a composite index. This returns a google.longrunning.Operation which + # may be used to track the status of the creation. The metadata for the + # operation will be the type IndexOperationMetadata. # @param [String] parent - # A parent name of the form - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # ` + # A parent name of the form `projects/`project_id`/databases/`database_id`/ + # collectionGroups/`collection_id`` # @param [Google::Apis::FirestoreV1beta2::GoogleFirestoreAdminV1beta2Index] google_firestore_admin_v1beta2_index_object # @param [String] fields # Selector specifying which fields to include in a partial response. @@ -320,9 +303,8 @@ module Google # Deletes a composite index. # @param [String] name - # A name of the form - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # /indexes/`index_id`` + # A name of the form `projects/`project_id`/databases/`database_id`/ + # collectionGroups/`collection_id`/indexes/`index_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -352,9 +334,8 @@ module Google # Gets a composite index. # @param [String] name - # A name of the form - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # /indexes/`index_id`` + # A name of the form `projects/`project_id`/databases/`database_id`/ + # collectionGroups/`collection_id`/indexes/`index_id`` # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -384,17 +365,15 @@ module Google # Lists composite indexes. # @param [String] parent - # A parent name of the form - # `projects/`project_id`/databases/`database_id`/collectionGroups/`collection_id` - # ` + # A parent name of the form `projects/`project_id`/databases/`database_id`/ + # collectionGroups/`collection_id`` # @param [String] filter # The filter to apply to list results. # @param [Fixnum] page_size # The number of results to return. # @param [String] page_token - # A page token, returned from a previous call to - # FirestoreAdmin.ListIndexes, that may be used to get the next - # page of results. + # A page token, returned from a previous call to FirestoreAdmin.ListIndexes, + # that may be used to get the next page of results. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user diff --git a/generated/google/apis/gmailpostmastertools_v1beta1.rb b/generated/google/apis/gmailpostmastertools_v1beta1.rb index 10921b088..079379698 100644 --- a/generated/google/apis/gmailpostmastertools_v1beta1.rb +++ b/generated/google/apis/gmailpostmastertools_v1beta1.rb @@ -18,7 +18,7 @@ require 'google/apis/gmailpostmastertools_v1beta1/representations.rb' module Google module Apis - # Postmaster Tools API + # Gmail Postmaster Tools API # # The Postmaster Tools API is a RESTful API that provides programmatic access to # email traffic metrics (like spam reports, delivery errors etc) otherwise @@ -27,7 +27,7 @@ module Google # @see https://developers.google.com/gmail/postmaster module GmailpostmastertoolsV1beta1 VERSION = 'V1beta1' - REVISION = '20200811' + REVISION = '20200817' # See email traffic metrics for the domains you have registered in Gmail Postmaster Tools AUTH_POSTMASTER_READONLY = 'https://www.googleapis.com/auth/postmaster.readonly' diff --git a/generated/google/apis/gmailpostmastertools_v1beta1/service.rb b/generated/google/apis/gmailpostmastertools_v1beta1/service.rb index 28008e429..04be29f74 100644 --- a/generated/google/apis/gmailpostmastertools_v1beta1/service.rb +++ b/generated/google/apis/gmailpostmastertools_v1beta1/service.rb @@ -20,7 +20,7 @@ require 'google/apis/errors' module Google module Apis module GmailpostmastertoolsV1beta1 - # Postmaster Tools API + # Gmail Postmaster Tools API # # The Postmaster Tools API is a RESTful API that provides programmatic access to # email traffic metrics (like spam reports, delivery errors etc) otherwise diff --git a/generated/google/apis/healthcare_v1.rb b/generated/google/apis/healthcare_v1.rb index ed2826014..f7460f210 100644 --- a/generated/google/apis/healthcare_v1.rb +++ b/generated/google/apis/healthcare_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/healthcare module HealthcareV1 VERSION = 'V1' - REVISION = '20200723' + REVISION = '20200813' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/healthcare_v1/classes.rb b/generated/google/apis/healthcare_v1/classes.rb index ab8c16346..57f0feba2 100644 --- a/generated/google/apis/healthcare_v1/classes.rb +++ b/generated/google/apis/healthcare_v1/classes.rb @@ -1150,8 +1150,8 @@ module Google class GoogleCloudHealthcareV1FhirBigQueryDestination include Google::Apis::Core::Hashable - # BigQuery URI to a dataset, up to 2000 characters long, in the format - # `bq://projectId.bqDatasetId` + # BigQuery URI to an existing dataset, up to 2000 characters long, in the + # format `bq://projectId.bqDatasetId`. # Corresponds to the JSON property `datasetUri` # @return [String] attr_accessor :dataset_uri diff --git a/generated/google/apis/healthcare_v1beta1.rb b/generated/google/apis/healthcare_v1beta1.rb index 41d29b366..cdacd1b8c 100644 --- a/generated/google/apis/healthcare_v1beta1.rb +++ b/generated/google/apis/healthcare_v1beta1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/healthcare module HealthcareV1beta1 VERSION = 'V1beta1' - REVISION = '20200723' + REVISION = '20200813' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/healthcare_v1beta1/classes.rb b/generated/google/apis/healthcare_v1beta1/classes.rb index 9f48e1c39..32beaac4a 100644 --- a/generated/google/apis/healthcare_v1beta1/classes.rb +++ b/generated/google/apis/healthcare_v1beta1/classes.rb @@ -901,6 +901,17 @@ module Google # @return [Google::Apis::HealthcareV1beta1::NotificationConfig] attr_accessor :notification_config + # A list of streaming configs used to configure the destination of streaming + # exports for every DICOM instance insertion in this DICOM store. + # After a new config is added to `stream_configs`, DICOM instance + # insertions are streamed to the new destination. + # When a config is removed from `stream_configs`, the server stops streaming + # to that destination. + # Each config must contain a unique destination. + # Corresponds to the JSON property `streamConfigs` + # @return [Array] + attr_accessor :stream_configs + def initialize(**args) update!(**args) end @@ -910,6 +921,7 @@ module Google @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @notification_config = args[:notification_config] if args.key?(:notification_config) + @stream_configs = args[:stream_configs] if args.key?(:stream_configs) end end @@ -1908,12 +1920,31 @@ module Google end end + # StreamConfig specifies configuration for a streaming DICOM export. + class GoogleCloudHealthcareV1beta1DicomStreamConfig + include Google::Apis::Core::Hashable + + # The BigQuery table where the server writes output. + # Corresponds to the JSON property `bigqueryDestination` + # @return [Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1DicomBigQueryDestination] + attr_accessor :bigquery_destination + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @bigquery_destination = args[:bigquery_destination] if args.key?(:bigquery_destination) + end + end + # The configuration for exporting to BigQuery. class GoogleCloudHealthcareV1beta1FhirBigQueryDestination include Google::Apis::Core::Hashable - # BigQuery URI to a dataset, up to 2000 characters long, in the format - # `bq://projectId.bqDatasetId` + # BigQuery URI to an existing dataset, up to 2000 characters long, in the + # format `bq://projectId.bqDatasetId`. # Corresponds to the JSON property `datasetUri` # @return [String] attr_accessor :dataset_uri diff --git a/generated/google/apis/healthcare_v1beta1/representations.rb b/generated/google/apis/healthcare_v1beta1/representations.rb index b51a5ac5f..2ab9f3e89 100644 --- a/generated/google/apis/healthcare_v1beta1/representations.rb +++ b/generated/google/apis/healthcare_v1beta1/representations.rb @@ -334,6 +334,12 @@ module Google include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudHealthcareV1beta1DicomStreamConfig + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudHealthcareV1beta1FhirBigQueryDestination class Representation < Google::Apis::Core::JsonRepresentation; end @@ -974,6 +980,8 @@ module Google property :name, as: 'name' property :notification_config, as: 'notificationConfig', class: Google::Apis::HealthcareV1beta1::NotificationConfig, decorator: Google::Apis::HealthcareV1beta1::NotificationConfig::Representation + collection :stream_configs, as: 'streamConfigs', class: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1DicomStreamConfig, decorator: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1DicomStreamConfig::Representation + end end @@ -1215,6 +1223,14 @@ module Google end end + class GoogleCloudHealthcareV1beta1DicomStreamConfig + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :bigquery_destination, as: 'bigqueryDestination', class: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1DicomBigQueryDestination, decorator: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1DicomBigQueryDestination::Representation + + end + end + class GoogleCloudHealthcareV1beta1FhirBigQueryDestination # @private class Representation < Google::Apis::Core::JsonRepresentation diff --git a/generated/google/apis/lifesciences_v2beta.rb b/generated/google/apis/lifesciences_v2beta.rb index d2b2d31f3..854361fb2 100644 --- a/generated/google/apis/lifesciences_v2beta.rb +++ b/generated/google/apis/lifesciences_v2beta.rb @@ -26,7 +26,7 @@ module Google # @see https://cloud.google.com/life-sciences module LifesciencesV2beta VERSION = 'V2beta' - REVISION = '20200603' + REVISION = '20200806' # 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/lifesciences_v2beta/classes.rb b/generated/google/apis/lifesciences_v2beta/classes.rb index 9ac529653..65e33fa3e 100644 --- a/generated/google/apis/lifesciences_v2beta/classes.rb +++ b/generated/google/apis/lifesciences_v2beta/classes.rb @@ -31,13 +31,12 @@ module Google # @return [Fixnum] attr_accessor :count - # The accelerator type string (for example, "nvidia-tesla-k80"). - # Only NVIDIA GPU accelerators are currently supported. If an NVIDIA GPU is - # attached, the required runtime libraries will be made available to all - # containers under `/usr/local/nvidia`. The driver version to install must - # be specified using the NVIDIA driver version parameter on the virtual - # machine specification. Note that attaching a GPU increases the worker VM - # startup time by a few minutes. + # The accelerator type string (for example, "nvidia-tesla-k80"). Only NVIDIA GPU + # accelerators are currently supported. If an NVIDIA GPU is attached, the + # required runtime libraries will be made available to all containers under `/ + # usr/local/nvidia`. The driver version to install must be specified using the + # NVIDIA driver version parameter on the virtual machine specification. Note + # that attaching a GPU increases the worker VM startup time by a few minutes. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -58,61 +57,58 @@ module Google include Google::Apis::Core::Hashable # By default, after an action fails, no further actions are run. This flag - # indicates that this action must be run even if the pipeline has already - # failed. This is useful for actions that copy output files off of the VM - # or for debugging. Note that no actions will be run if image prefetching - # fails. + # indicates that this action must be run even if the pipeline has already failed. + # This is useful for actions that copy output files off of the VM or for + # debugging. Note that no actions will be run if image prefetching fails. # Corresponds to the JSON property `alwaysRun` # @return [Boolean] attr_accessor :always_run alias_method :always_run?, :always_run - # If specified, overrides the `CMD` specified in the container. If the - # container also has an `ENTRYPOINT` the values are used as entrypoint - # arguments. Otherwise, they are used as a command and arguments to run - # inside the container. + # If specified, overrides the `CMD` specified in the container. If the container + # also has an `ENTRYPOINT` the values are used as entrypoint arguments. + # Otherwise, they are used as a command and arguments to run inside the + # container. # Corresponds to the JSON property `commands` # @return [Array] attr_accessor :commands - # An optional name for the container. The container hostname will be set to - # this name, making it useful for inter-container communication. The name - # must contain only upper and lowercase alphanumeric characters and hyphens - # and cannot start with a hyphen. + # An optional name for the container. The container hostname will be set to this + # name, making it useful for inter-container communication. The name must + # contain only upper and lowercase alphanumeric characters and hyphens and + # cannot start with a hyphen. # Corresponds to the JSON property `containerName` # @return [String] attr_accessor :container_name - # Holds encrypted information that is only decrypted and stored in RAM - # by the worker VM when running the pipeline. + # Holds encrypted information that is only decrypted and stored in RAM by the + # worker VM when running the pipeline. # Corresponds to the JSON property `credentials` # @return [Google::Apis::LifesciencesV2beta::Secret] attr_accessor :credentials - # All container images are typically downloaded before any actions are - # executed. This helps prevent typos in URIs or issues like lack of disk - # space from wasting large amounts of compute resources. - # If set, this flag prevents the worker from downloading the image until - # just before the action is executed. + # All container images are typically downloaded before any actions are executed. + # This helps prevent typos in URIs or issues like lack of disk space from + # wasting large amounts of compute resources. If set, this flag prevents the + # worker from downloading the image until just before the action is executed. # Corresponds to the JSON property `disableImagePrefetch` # @return [Boolean] attr_accessor :disable_image_prefetch alias_method :disable_image_prefetch?, :disable_image_prefetch - # A small portion of the container's standard error stream is typically - # captured and returned inside the `ContainerStoppedEvent`. Setting this - # flag disables this functionality. + # A small portion of the container's standard error stream is typically captured + # and returned inside the `ContainerStoppedEvent`. Setting this flag disables + # this functionality. # Corresponds to the JSON property `disableStandardErrorCapture` # @return [Boolean] attr_accessor :disable_standard_error_capture alias_method :disable_standard_error_capture?, :disable_standard_error_capture - # Enable access to the FUSE device for this action. Filesystems can then - # be mounted into disks shared with other actions. The other actions do - # not need the `enable_fuse` flag to access the mounted filesystem. - # This has the effect of causing the container to be executed with - # `CAP_SYS_ADMIN` and exposes `/dev/fuse` to the container, so use it only - # for containers you trust. + # Enable access to the FUSE device for this action. Filesystems can then be + # mounted into disks shared with other actions. The other actions do not need + # the `enable_fuse` flag to access the mounted filesystem. This has the effect + # of causing the container to be executed with `CAP_SYS_ADMIN` and exposes `/dev/ + # fuse` to the container, so use it only for containers you trust. # Corresponds to the JSON property `enableFuse` # @return [Boolean] attr_accessor :enable_fuse @@ -123,111 +119,99 @@ module Google # @return [String] attr_accessor :entrypoint - # The environment to pass into the container. This environment is merged - # with values specified in the google.cloud.lifesciences.v2beta.Pipeline - # message, overwriting any duplicate values. - # In addition to the values passed here, a few other values are - # automatically injected into the environment. These cannot be hidden or - # overwritten. - # `GOOGLE_PIPELINE_FAILED` will be set to "1" if the pipeline failed - # because an action has exited with a non-zero status (and did not have the - # `IGNORE_EXIT_STATUS` flag set). This can be used to determine if additional - # debug or logging actions should execute. - # `GOOGLE_LAST_EXIT_STATUS` will be set to the exit status of the last - # non-background action that executed. This can be used by workflow engine - # authors to determine whether an individual action has succeeded or failed. + # The environment to pass into the container. This environment is merged with + # values specified in the google.cloud.lifesciences.v2beta.Pipeline message, + # overwriting any duplicate values. In addition to the values passed here, a few + # other values are automatically injected into the environment. These cannot be + # hidden or overwritten. `GOOGLE_PIPELINE_FAILED` will be set to "1" if the + # pipeline failed because an action has exited with a non-zero status (and did + # not have the `IGNORE_EXIT_STATUS` flag set). This can be used to determine if + # additional debug or logging actions should execute. `GOOGLE_LAST_EXIT_STATUS` + # will be set to the exit status of the last non-background action that executed. + # This can be used by workflow engine authors to determine whether an + # individual action has succeeded or failed. # Corresponds to the JSON property `environment` # @return [Hash] attr_accessor :environment - # Normally, a non-zero exit status causes the pipeline to fail. This flag - # allows execution of other actions to continue instead. + # Normally, a non-zero exit status causes the pipeline to fail. This flag allows + # execution of other actions to continue instead. # Corresponds to the JSON property `ignoreExitStatus` # @return [Boolean] attr_accessor :ignore_exit_status alias_method :ignore_exit_status?, :ignore_exit_status # Required. The URI to pull the container image from. Note that all images - # referenced - # by actions in the pipeline are pulled before the first action runs. If - # multiple actions reference the same image, it is only pulled once, - # ensuring that the same image is used for all actions in a single pipeline. - # The image URI can be either a complete host and image specification (e.g., - # quay.io/biocontainers/samtools), a library and image name (e.g., - # google/cloud-sdk) or a bare image name ('bash') to pull from the default - # library. No schema is required in any of these cases. - # If the specified image is not public, the service account specified for - # the Virtual Machine must have access to pull the images from GCR, or - # appropriate credentials must be specified in the - # google.cloud.lifesciences.v2beta.Action.credentials field. + # referenced by actions in the pipeline are pulled before the first action runs. + # If multiple actions reference the same image, it is only pulled once, ensuring + # that the same image is used for all actions in a single pipeline. The image + # URI can be either a complete host and image specification (e.g., quay.io/ + # biocontainers/samtools), a library and image name (e.g., google/cloud-sdk) or + # a bare image name ('bash') to pull from the default library. No schema is + # required in any of these cases. If the specified image is not public, the + # service account specified for the Virtual Machine must have access to pull the + # images from GCR, or appropriate credentials must be specified in the google. + # cloud.lifesciences.v2beta.Action.credentials field. # Corresponds to the JSON property `imageUri` # @return [String] attr_accessor :image_uri - # Labels to associate with the action. This field is provided to assist - # workflow engine authors in identifying actions (for example, to indicate - # what sort of action they perform, such as localization or debugging). - # They are returned in the operation metadata, but are otherwise ignored. + # Labels to associate with the action. This field is provided to assist workflow + # engine authors in identifying actions (for example, to indicate what sort of + # action they perform, such as localization or debugging). They are returned in + # the operation metadata, but are otherwise ignored. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels - # A list of mounts to make available to the action. - # In addition to the values specified here, every action has a special - # virtual disk mounted under `/google` that contains log files and other - # operational components. - #
    - #
  • /google/logs All logs written during the pipeline - # execution.
    • - #
  • /google/logs/output The combined standard output and - # standard error of all actions run as part of the pipeline - # execution.
    • - #
  • /google/logs/action/*/stdout The complete contents of - # each individual action's standard output.
    • - #
  • /google/logs/action/*/stderr The complete contents of - # each individual action's standard error output.
    • - #
+ # A list of mounts to make available to the action. In addition to the values + # specified here, every action has a special virtual disk mounted under `/google` + # that contains log files and other operational components. - /google/logs All + # logs written during the pipeline execution. - /google/logs/output The combined + # standard output and standard error of all actions run as part of the pipeline + # execution. - /google/logs/action/*/stdout The complete contents of each + # individual action's standard output. - /google/logs/action/*/stderr The + # complete contents of each individual action's standard error output. # Corresponds to the JSON property `mounts` # @return [Array] attr_accessor :mounts - # An optional identifier for a PID namespace to run the action inside. - # Multiple actions should use the same string to share a namespace. If - # unspecified, a separate isolated namespace is used. + # An optional identifier for a PID namespace to run the action inside. Multiple + # actions should use the same string to share a namespace. If unspecified, a + # separate isolated namespace is used. # Corresponds to the JSON property `pidNamespace` # @return [String] attr_accessor :pid_namespace - # A map of containers to host port mappings for this container. If the - # container already specifies exposed ports, use the - # `PUBLISH_EXPOSED_PORTS` flag instead. - # The host port number must be less than 65536. If it is zero, an unused - # random port is assigned. To determine the resulting port number, consult - # the `ContainerStartedEvent` in the operation metadata. + # A map of containers to host port mappings for this container. If the container + # already specifies exposed ports, use the `PUBLISH_EXPOSED_PORTS` flag instead. + # The host port number must be less than 65536. If it is zero, an unused random + # port is assigned. To determine the resulting port number, consult the ` + # ContainerStartedEvent` in the operation metadata. # Corresponds to the JSON property `portMappings` # @return [Hash] attr_accessor :port_mappings # Exposes all ports specified by `EXPOSE` statements in the container. To - # discover the host side port numbers, consult the `ACTION_STARTED` event - # in the operation metadata. + # discover the host side port numbers, consult the `ACTION_STARTED` event in the + # operation metadata. # Corresponds to the JSON property `publishExposedPorts` # @return [Boolean] attr_accessor :publish_exposed_ports alias_method :publish_exposed_ports?, :publish_exposed_ports # This flag allows an action to continue running in the background while - # executing subsequent actions. This is useful to provide services to - # other actions (or to provide debugging support tools like SSH servers). + # executing subsequent actions. This is useful to provide services to other + # actions (or to provide debugging support tools like SSH servers). # Corresponds to the JSON property `runInBackground` # @return [Boolean] attr_accessor :run_in_background alias_method :run_in_background?, :run_in_background - # The maximum amount of time to give the action to complete. If the action - # fails to complete before the timeout, it will be terminated and the exit - # status will be non-zero. The pipeline will continue or terminate based - # on the rules defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags. + # The maximum amount of time to give the action to complete. If the action fails + # to complete before the timeout, it will be terminated and the exit status will + # be non-zero. The pipeline will continue or terminate based on the rules + # defined by the `ALWAYS_RUN` and `IGNORE_EXIT_STATUS` flags. # Corresponds to the JSON property `timeout` # @return [String] attr_accessor :timeout @@ -272,9 +256,9 @@ module Google end end - # An event generated when a container is forcibly terminated by the - # worker. Currently, this only occurs when the container outlives the - # timeout specified by the user. + # An event generated when a container is forcibly terminated by the worker. + # Currently, this only occurs when the container outlives the timeout specified + # by the user. class ContainerKilledEvent include Google::Apis::Core::Hashable @@ -302,17 +286,17 @@ module Google # @return [Fixnum] attr_accessor :action_id - # The public IP address that can be used to connect to the container. This - # field is only populated when at least one port mapping is present. If the - # instance was created with a private address, this field will be empty even - # if port mappings exist. + # The public IP address that can be used to connect to the container. This field + # is only populated when at least one port mapping is present. If the instance + # was created with a private address, this field will be empty even if port + # mappings exist. # Corresponds to the JSON property `ipAddress` # @return [String] attr_accessor :ip_address - # The container-to-host port mappings installed for this container. This - # set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag - # as well as any specified in the `Action` definition. + # The container-to-host port mappings installed for this container. This set + # will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag as well + # as any specified in the `Action` definition. # Corresponds to the JSON property `portMappings` # @return [Hash] attr_accessor :port_mappings @@ -343,13 +327,13 @@ module Google # @return [Fixnum] attr_accessor :exit_status - # The tail end of any content written to standard error by the container. - # If the content emits large amounts of debugging noise or contains - # sensitive information, you can prevent the content from being printed by - # setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. - # Note that only a small amount of the end of the stream is captured here. - # The entire stream is stored in the `/google/logs` directory mounted into - # each action, and can be copied off the machine as described elsewhere. + # The tail end of any content written to standard error by the container. If the + # content emits large amounts of debugging noise or contains sensitive + # information, you can prevent the content from being printed by setting the ` + # DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that only a small amount of the end + # of the stream is captured here. The entire stream is stored in the `/google/ + # logs` directory mounted into each action, and can be copied off the machine as + # described elsewhere. # Corresponds to the JSON property `stderr` # @return [String] attr_accessor :stderr @@ -366,22 +350,22 @@ module Google end end - # An event generated whenever a resource limitation or transient error - # delays execution of a pipeline that was otherwise ready to run. + # An event generated whenever a resource limitation or transient error delays + # execution of a pipeline that was otherwise ready to run. class DelayedEvent include Google::Apis::Core::Hashable - # A textual description of the cause of the delay. The string can change - # without notice because it is often generated by another service (such as - # Compute Engine). + # A textual description of the cause of the delay. The string can change without + # notice because it is often generated by another service (such as Compute + # Engine). # Corresponds to the JSON property `cause` # @return [String] attr_accessor :cause - # If the delay was caused by a resource shortage, this field lists the - # Compute Engine metrics that are preventing this operation from running - # (for example, `CPUS` or `INSTANCES`). If the particular metric is not - # known, a single `UNKNOWN` metric will be present. + # If the delay was caused by a resource shortage, this field lists the Compute + # Engine metrics that are preventing this operation from running (for example, ` + # CPUS` or `INSTANCES`). If the particular metric is not known, a single ` + # UNKNOWN` metric will be present. # Corresponds to the JSON property `metrics` # @return [Array] attr_accessor :metrics @@ -397,25 +381,24 @@ module Google end end - # Carries information about a disk that can be attached to a VM. - # See https://cloud.google.com/compute/docs/disks/performance for more - # information about disk type, size, and performance considerations. + # Carries information about a disk that can be attached to a VM. See https:// + # cloud.google.com/compute/docs/disks/performance for more information about + # disk type, size, and performance considerations. class Disk include Google::Apis::Core::Hashable - # A user-supplied name for the disk. Used when mounting the disk into - # actions. The name must contain only upper and lowercase alphanumeric - # characters and hyphens and cannot start with a hyphen. + # A user-supplied name for the disk. Used when mounting the disk into actions. + # The name must contain only upper and lowercase alphanumeric characters and + # hyphens and cannot start with a hyphen. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name - # The size, in GB, of the disk to attach. If the size is not - # specified, a default is chosen to ensure reasonable I/O performance. - # If the disk type is specified as `local-ssd`, multiple local drives are - # automatically combined to provide the requested size. Note, however, that - # each physical SSD is 375GB in size, and no more than 8 drives can be - # attached to a single instance. + # The size, in GB, of the disk to attach. If the size is not specified, a + # default is chosen to ensure reasonable I/O performance. If the disk type is + # specified as `local-ssd`, multiple local drives are automatically combined to + # provide the requested size. Note, however, that each physical SSD is 375GB in + # size, and no more than 8 drives can be attached to a single instance. # Corresponds to the JSON property `sizeGb` # @return [Fixnum] attr_accessor :size_gb @@ -443,13 +426,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 @@ -466,9 +447,9 @@ module Google class Event include Google::Apis::Core::Hashable - # An event generated when a container is forcibly terminated by the - # worker. Currently, this only occurs when the container outlives the - # timeout specified by the user. + # An event generated when a container is forcibly terminated by the worker. + # Currently, this only occurs when the container outlives the timeout specified + # by the user. # Corresponds to the JSON property `containerKilled` # @return [Google::Apis::LifesciencesV2beta::ContainerKilledEvent] attr_accessor :container_killed @@ -483,21 +464,21 @@ module Google # @return [Google::Apis::LifesciencesV2beta::ContainerStoppedEvent] attr_accessor :container_stopped - # An event generated whenever a resource limitation or transient error - # delays execution of a pipeline that was otherwise ready to run. + # An event generated whenever a resource limitation or transient error delays + # execution of a pipeline that was otherwise ready to run. # Corresponds to the JSON property `delayed` # @return [Google::Apis::LifesciencesV2beta::DelayedEvent] attr_accessor :delayed - # A human-readable description of the event. Note that these strings can - # change at any time without notice. Any application logic must use the - # information in the `details` field. + # A human-readable description of the event. Note that these strings can change + # at any time without notice. Any application logic must use the information in + # the `details` field. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description - # An event generated when the execution of a pipeline has failed. Note - # that other events can continue to occur after this event. + # An event generated when the execution of a pipeline has failed. Note that + # other events can continue to occur after this event. # Corresponds to the JSON property `failed` # @return [Google::Apis::LifesciencesV2beta::FailedEvent] attr_accessor :failed @@ -517,22 +498,21 @@ module Google # @return [String] attr_accessor :timestamp - # An event generated when the execution of a container results in a - # non-zero exit status that was not otherwise ignored. Execution will - # continue, but only actions that are flagged as `ALWAYS_RUN` will be - # executed. Other actions will be skipped. + # An event generated when the execution of a container results in a non-zero + # exit status that was not otherwise ignored. Execution will continue, but only + # actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will + # be skipped. # Corresponds to the JSON property `unexpectedExitStatus` # @return [Google::Apis::LifesciencesV2beta::UnexpectedExitStatusEvent] attr_accessor :unexpected_exit_status - # An event generated after a worker VM has been assigned to run the - # pipeline. + # An event generated after a worker VM has been assigned to run the pipeline. # Corresponds to the JSON property `workerAssigned` # @return [Google::Apis::LifesciencesV2beta::WorkerAssignedEvent] attr_accessor :worker_assigned - # An event generated when the worker VM that was assigned to the pipeline - # has been released (deleted). + # An event generated when the worker VM that was assigned to the pipeline has + # been released (deleted). # Corresponds to the JSON property `workerReleased` # @return [Google::Apis::LifesciencesV2beta::WorkerReleasedEvent] attr_accessor :worker_released @@ -558,8 +538,8 @@ module Google end end - # An event generated when the execution of a pipeline has failed. Note - # that other events can continue to occur after this event. + # An event generated when the execution of a pipeline has failed. Note that + # other events can continue to occur after this event. class FailedEvent include Google::Apis::Core::Hashable @@ -638,14 +618,14 @@ module Google class Location include Google::Apis::Core::Hashable - # The friendly name for this location, typically a nearby city name. - # For example, "Tokyo". + # The friendly name for this location, typically a nearby city name. For example, + # "Tokyo". # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Cross-service attributes for the location. For example - # `"cloud.googleapis.com/region": "us-east1"` + # Cross-service attributes for the location. For example `"cloud.googleapis.com/ + # region": "us-east1"` # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -661,8 +641,8 @@ module Google # @return [Hash] attr_accessor :metadata - # Resource name for the location, which may vary between implementations. - # For example: `"projects/example-project/locations/us-east1"` + # Resource name for the location, which may vary between implementations. For + # example: `"projects/example-project/locations/us-east1"` # Corresponds to the JSON property `name` # @return [String] attr_accessor :name @@ -681,8 +661,8 @@ module Google end end - # Carries information about the pipeline execution that is returned - # in the long running operation's metadata field. + # Carries information about the pipeline execution that is returned in the long + # running operation's metadata field. class Metadata include Google::Apis::Core::Hashable @@ -768,30 +748,28 @@ module Google class Network include Google::Apis::Core::Hashable - # The network name to attach the VM's network interface to. The value will - # be prefixed with `global/networks/` unless it contains a `/`, in which - # case it is assumed to be a fully specified network resource URL. - # If unspecified, the global default network is used. + # The network name to attach the VM's network interface to. The value will be + # prefixed with `global/networks/` unless it contains a `/`, in which case it is + # assumed to be a fully specified network resource URL. If unspecified, the + # global default network is used. # Corresponds to the JSON property `network` # @return [String] attr_accessor :network - # If the specified network is configured for custom subnet creation, the - # name of the subnetwork to attach the instance to must be specified here. - # The value is prefixed with `regions/*/subnetworks/` unless it contains a - # `/`, in which case it is assumed to be a fully specified subnetwork - # resource URL. - # If the `*` character appears in the value, it is replaced with the region - # that the virtual machine has been allocated in. + # If the specified network is configured for custom subnet creation, the name of + # the subnetwork to attach the instance to must be specified here. The value is + # prefixed with `regions/*/subnetworks/` unless it contains a `/`, in which case + # it is assumed to be a fully specified subnetwork resource URL. If the `*` + # character appears in the value, it is replaced with the region that the + # virtual machine has been allocated in. # Corresponds to the JSON property `subnetwork` # @return [String] attr_accessor :subnetwork - # If set to true, do not attach a public IP address to the VM. Note that - # without a public IP address, additional configuration is required to - # allow the VM to access Google services. - # See https://cloud.google.com/vpc/docs/configure-private-google-access - # for more information. + # If set to true, do not attach a public IP address to the VM. Note that without + # a public IP address, additional configuration is required to allow the VM to + # access Google services. See https://cloud.google.com/vpc/docs/configure- + # private-google-access for more information. # Corresponds to the JSON property `usePrivateAddress` # @return [Boolean] attr_accessor :use_private_address @@ -814,20 +792,19 @@ module Google class Operation include Google::Apis::Core::Hashable - # If the value is `false`, it means the operation is still in progress. - # If `true`, the operation is completed, and either `error` or `response` is - # available. + # If the value is `false`, it means the operation is still in progress. If `true` + # , the operation is completed, and either `error` or `response` is available. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done - # The `Status` type defines a logical error model that is suitable for - # different programming environments, including REST APIs and RPC APIs. It is - # used by [gRPC](https://github.com/grpc). Each `Status` message contains - # three pieces of data: error code, error message, and error details. - # You can find out more about this error model and how to work with it in the - # [API Design Guide](https://cloud.google.com/apis/design/errors). + # The `Status` type defines a logical error model that is suitable for different + # programming environments, including REST APIs and RPC APIs. It is used by [ + # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of + # data: error code, error message, and error details. You can find out more + # about this error model and how to work with it in the [API Design Guide](https: + # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `error` # @return [Google::Apis::LifesciencesV2beta::Status] attr_accessor :error @@ -837,7 +814,7 @@ module Google # @return [Hash] attr_accessor :metadata - # The server-assigned name for the operation. This may be passed to the other + # The server-assigned name for the operation. This may be passed to the other # operation methods to retrieve information about the operation's status. # Corresponds to the JSON property `name` # @return [String] @@ -872,23 +849,22 @@ module Google attr_accessor :actions # The environment to pass into every action. Each action can also specify - # additional environment variables but cannot delete an entry from this map - # (though they can overwrite it with a different value). + # additional environment variables but cannot delete an entry from this map ( + # though they can overwrite it with a different value). # Corresponds to the JSON property `environment` # @return [Hash] attr_accessor :environment - # The system resources for the pipeline run. - # At least one zone or region must be specified or the pipeline run will fail. + # The system resources for the pipeline run. At least one zone or region must be + # specified or the pipeline run will fail. # Corresponds to the JSON property `resources` # @return [Google::Apis::LifesciencesV2beta::Resources] attr_accessor :resources - # The maximum amount of time to give the pipeline to complete. This includes - # the time spent waiting for a worker to be allocated. If the pipeline fails - # to complete before the timeout, it will be cancelled and the error code - # will be set to DEADLINE_EXCEEDED. - # If unspecified, it will default to 7 days. + # The maximum amount of time to give the pipeline to complete. This includes the + # time spent waiting for a worker to be allocated. If the pipeline fails to + # complete before the timeout, it will be cancelled and the error code will be + # set to DEADLINE_EXCEEDED. If unspecified, it will default to 7 days. # Corresponds to the JSON property `timeout` # @return [String] attr_accessor :timeout @@ -944,13 +920,13 @@ module Google end end - # The system resources for the pipeline run. - # At least one zone or region must be specified or the pipeline run will fail. + # The system resources for the pipeline run. At least one zone or region must be + # specified or the pipeline run will fail. class Resources include Google::Apis::Core::Hashable - # The list of regions allowed for VM allocation. If set, the `zones` field - # must not be set. + # The list of regions allowed for VM allocation. If set, the `zones` field must + # not be set. # Corresponds to the JSON property `regions` # @return [Array] attr_accessor :regions @@ -960,8 +936,8 @@ module Google # @return [Google::Apis::LifesciencesV2beta::VirtualMachine] attr_accessor :virtual_machine - # The list of zones allowed for VM allocation. If set, the `regions` field - # must not be set. + # The list of zones allowed for VM allocation. If set, the `regions` field must + # not be set. # Corresponds to the JSON property `zones` # @return [Array] attr_accessor :zones @@ -978,17 +954,17 @@ module Google end end - # The arguments to the `RunPipeline` method. The requesting user must have - # the `iam.serviceAccounts.actAs` permission for the Cloud Life Sciences - # service account or the request will fail. + # The arguments to the `RunPipeline` method. The requesting user must have the ` + # iam.serviceAccounts.actAs` permission for the Cloud Life Sciences service + # account or the request will fail. class RunPipelineRequest include Google::Apis::Core::Hashable - # User-defined labels to associate with the returned operation. These - # labels are not propagated to any Google Cloud Platform resources used by - # the operation, and can be modified at any time. - # To associate labels with resources created while executing the operation, - # see the appropriate resource message (for example, `VirtualMachine`). + # User-defined labels to associate with the returned operation. These labels are + # not propagated to any Google Cloud Platform resources used by the operation, + # and can be modified at any time. To associate labels with resources created + # while executing the operation, see the appropriate resource message (for + # example, `VirtualMachine`). # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels @@ -1023,20 +999,20 @@ module Google end end - # Holds encrypted information that is only decrypted and stored in RAM - # by the worker VM when running the pipeline. + # Holds encrypted information that is only decrypted and stored in RAM by the + # worker VM when running the pipeline. class Secret include Google::Apis::Core::Hashable - # The value of the cipherText response from the `encrypt` method. This field - # is intentionally unaudited. + # The value of the cipherText response from the `encrypt` method. This field is + # intentionally unaudited. # Corresponds to the JSON property `cipherText` # @return [String] attr_accessor :cipher_text - # The name of the Cloud KMS key that will be used to decrypt the secret - # value. The VM service account must have the required permissions and - # authentication scopes to invoke the `decrypt` method on the specified key. + # The name of the Cloud KMS key that will be used to decrypt the secret value. + # The VM service account must have the required permissions and authentication + # scopes to invoke the `decrypt` method on the specified key. # Corresponds to the JSON property `keyName` # @return [String] attr_accessor :key_name @@ -1056,14 +1032,14 @@ module Google class ServiceAccount include Google::Apis::Core::Hashable - # Email address of the service account. If not specified, the default - # Compute Engine service account for the project will be used. + # Email address of the service account. If not specified, the default Compute + # Engine service account for the project will be used. # Corresponds to the JSON property `email` # @return [String] attr_accessor :email - # List of scopes to be enabled for this service account on the VM, in - # addition to the cloud-platform API scope that will be added by default. + # List of scopes to be enabled for this service account on the VM, in addition + # to the cloud-platform API scope that will be added by default. # Corresponds to the JSON property `scopes` # @return [Array] attr_accessor :scopes @@ -1079,12 +1055,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 @@ -1093,15 +1069,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 @@ -1118,10 +1094,10 @@ module Google end end - # An event generated when the execution of a container results in a - # non-zero exit status that was not otherwise ignored. Execution will - # continue, but only actions that are flagged as `ALWAYS_RUN` will be - # executed. Other actions will be skipped. + # An event generated when the execution of a container results in a non-zero + # exit status that was not otherwise ignored. Execution will continue, but only + # actions that are flagged as `ALWAYS_RUN` will be executed. Other actions will + # be skipped. class UnexpectedExitStatusEvent include Google::Apis::Core::Hashable @@ -1155,34 +1131,32 @@ module Google # @return [Array] attr_accessor :accelerators - # The size of the boot disk, in GB. The boot disk must be large - # enough to accommodate all of the Docker images from each action in the - # pipeline at the same time. If not specified, a small but reasonable - # default value is used. + # The size of the boot disk, in GB. The boot disk must be large enough to + # accommodate all of the Docker images from each action in the pipeline at the + # same time. If not specified, a small but reasonable default value is used. # Corresponds to the JSON property `bootDiskSizeGb` # @return [Fixnum] attr_accessor :boot_disk_size_gb - # The host operating system image to use. - # Currently, only Container-Optimized OS images can be used. - # The default value is `projects/cos-cloud/global/images/family/cos-stable`, - # which selects the latest stable release of Container-Optimized OS. - # This option is provided to allow testing against the beta release of the - # operating system to ensure that the new version does not interact - # negatively with production pipelines. - # To test a pipeline against the beta release of Container-Optimized OS, - # use the value `projects/cos-cloud/global/images/family/cos-beta`. + # The host operating system image to use. Currently, only Container-Optimized OS + # images can be used. The default value is `projects/cos-cloud/global/images/ + # family/cos-stable`, which selects the latest stable release of Container- + # Optimized OS. This option is provided to allow testing against the beta + # release of the operating system to ensure that the new version does not + # interact negatively with production pipelines. To test a pipeline against the + # beta release of Container-Optimized OS, use the value `projects/cos-cloud/ + # global/images/family/cos-beta`. # Corresponds to the JSON property `bootImage` # @return [String] attr_accessor :boot_image # The CPU platform to request. An instance based on a newer platform can be - # allocated, but never one with fewer capabilities. The value of this - # parameter must be a valid Compute Engine CPU platform name (such as "Intel - # Skylake"). This parameter is only useful for carefully optimized work - # loads where the CPU platform has a significant impact. - # For more information about the effect of this parameter, see - # https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform. + # allocated, but never one with fewer capabilities. The value of this parameter + # must be a valid Compute Engine CPU platform name (such as "Intel Skylake"). + # This parameter is only useful for carefully optimized work loads where the CPU + # platform has a significant impact. For more information about the effect of + # this parameter, see https://cloud.google.com/compute/docs/instances/specify- + # min-cpu-platform. # Corresponds to the JSON property `cpuPlatform` # @return [String] attr_accessor :cpu_platform @@ -1193,10 +1167,12 @@ module Google attr_accessor :disks # The Compute Engine Disk Images to use as a Docker cache. The disks will be - # mounted into the Docker folder in a way that the images present in the - # cache will not need to be pulled. The digests of the cached images must - # match those of the tags used or the latest version will still be pulled. - # Only a single image is supported. + # mounted into the Docker folder in a way that the images present in the cache + # will not need to be pulled. The digests of the cached images must match those + # of the tags used or the latest version will still be pulled. The root + # directory of the ext4 image must contain `image` and `overlay2` directories + # copied from the Docker directory of a VM where the desired Docker images have + # already been pulled. Only a single image is supported. # Corresponds to the JSON property `dockerCacheImages` # @return [Array] attr_accessor :docker_cache_images @@ -1208,25 +1184,22 @@ module Google alias_method :enable_stackdriver_monitoring?, :enable_stackdriver_monitoring # Optional set of labels to apply to the VM and any attached disk resources. - # These labels must adhere to the [name and value - # restrictions](https://cloud.google.com/compute/docs/labeling-resources) on - # VM labels imposed by Compute Engine. - # Labels keys with the prefix 'google-' are reserved for use by Google. - # Labels applied at creation time to the VM. Applied on a best-effort basis - # to attached disk resources shortly after VM creation. + # These labels must adhere to the [name and value restrictions](https://cloud. + # google.com/compute/docs/labeling-resources) on VM labels imposed by Compute + # Engine. Labels keys with the prefix 'google-' are reserved for use by Google. + # Labels applied at creation time to the VM. Applied on a best-effort basis to + # attached disk resources shortly after VM creation. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Required. The machine type of the virtual machine to create. Must be the short - # name - # of a standard machine type (such as "n1-standard-1") or a custom machine - # type (such as "custom-1-4096", where "1" indicates the number of vCPUs and - # "4096" indicates the memory in MB). See - # [Creating an instance with a custom machine - # type](https://cloud.google.com/compute/docs/instances/creating-instance-with- - # custom-machine-type#create) - # for more specifications on creating a custom machine type. + # name of a standard machine type (such as "n1-standard-1") or a custom machine + # type (such as "custom-1-4096", where "1" indicates the number of vCPUs and " + # 4096" indicates the memory in MB). See [Creating an instance with a custom + # machine type](https://cloud.google.com/compute/docs/instances/creating- + # instance-with-custom-machine-type#create) for more specifications on creating + # a custom machine type. # Corresponds to the JSON property `machineType` # @return [String] attr_accessor :machine_type @@ -1236,10 +1209,10 @@ module Google # @return [Google::Apis::LifesciencesV2beta::Network] attr_accessor :network - # The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator. - # The version specified here must be compatible with the GPU libraries - # contained in the container being executed, and must be one of the drivers - # hosted in the `nvidia-drivers-us-public` bucket on Google Cloud Storage. + # The NVIDIA driver version to use when attaching an NVIDIA GPU accelerator. The + # version specified here must be compatible with the GPU libraries contained in + # the container being executed, and must be one of the drivers hosted in the ` + # nvidia-drivers-us-public` bucket on Google Cloud Storage. # Corresponds to the JSON property `nvidiaDriverVersion` # @return [String] attr_accessor :nvidia_driver_version @@ -1277,8 +1250,7 @@ module Google end end - # An event generated after a worker VM has been assigned to run the - # pipeline. + # An event generated after a worker VM has been assigned to run the pipeline. class WorkerAssignedEvent include Google::Apis::Core::Hashable @@ -1309,8 +1281,8 @@ module Google end end - # An event generated when the worker VM that was assigned to the pipeline - # has been released (deleted). + # An event generated when the worker VM that was assigned to the pipeline has + # been released (deleted). class WorkerReleasedEvent include Google::Apis::Core::Hashable diff --git a/generated/google/apis/lifesciences_v2beta/service.rb b/generated/google/apis/lifesciences_v2beta/service.rb index 4837619b6..510e6ae97 100644 --- a/generated/google/apis/lifesciences_v2beta/service.rb +++ b/generated/google/apis/lifesciences_v2beta/service.rb @@ -117,15 +117,12 @@ 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. Clients may use Operations.GetOperation - # or Operations.ListOperations - # to check whether the cancellation succeeded or the operation completed - # despite cancellation. + # Starts asynchronous cancellation on a long-running operation. The server makes + # a best effort to cancel the operation, but success is not guaranteed. Clients + # may use Operations.GetOperation or Operations.ListOperations to check whether + # the cancellation succeeded or the operation completed despite cancellation. # Authorization requires the following [Google IAM](https://cloud.google.com/iam) - # permission: - # * `lifesciences.operations.cancel` + # permission: * `lifesciences.operations.cancel` # @param [String] name # The name of the operation resource to be cancelled. # @param [Google::Apis::LifesciencesV2beta::CancelOperationRequest] cancel_operation_request_object @@ -158,12 +155,10 @@ 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. # Authorization requires the following [Google IAM](https://cloud.google.com/iam) - # permission: - # * `lifesciences.operations.get` + # permission: * `lifesciences.operations.get` # @param [String] name # The name of the operation resource. # @param [String] fields @@ -193,24 +188,20 @@ module Google execute_or_queue_command(command, &block) end - # Lists operations that match the specified filter in the request. - # Authorization requires the following [Google IAM](https://cloud.google.com/iam) - # permission: - # * `lifesciences.operations.list` + # Lists operations that match the specified filter in the request. Authorization + # requires the following [Google IAM](https://cloud.google.com/iam) permission: * + # `lifesciences.operations.list` # @param [String] name # The name of the operation's parent resource. # @param [String] filter - # A string for filtering Operations. - # The following filter fields are supported: - # * createTime: The time this job was created - # * events: The set of event (names) that have occurred while running - # the pipeline. The : operator can be used to determine if a - # particular event has occurred. - # * error: If the pipeline is running, this value is NULL. Once the - # pipeline finishes, the value is the standard Google error code. - # * labels.key or labels."key with space" where key is a label key. - # * done: If the pipeline is running, this value is false. Once the - # pipeline finishes, the value is true. + # A string for filtering Operations. The following filter fields are supported: * + # createTime: The time this job was created * events: The set of event (names) + # that have occurred while running the pipeline. The : operator can be used to + # determine if a particular event has occurred. * error: If the pipeline is + # running, this value is NULL. Once the pipeline finishes, the value is the + # standard Google error code. * labels.key or labels."key with space" where key + # is a label key. * done: If the pipeline is running, this value is false. Once + # the pipeline finishes, the value is true. # @param [Fixnum] page_size # The maximum number of results to return. The maximum value is 256. # @param [String] page_token @@ -245,20 +236,17 @@ module Google execute_or_queue_command(command, &block) end - # Runs a pipeline. The returned Operation's metadata field will contain a - # google.cloud.lifesciences.v2beta.Metadata object describing the status - # of the pipeline execution. The - # response field will contain a - # google.cloud.lifesciences.v2beta.RunPipelineResponse object if the - # pipeline completes successfully. - # **Note:** Before you can use this method, the *Life Sciences Service Agent* - # must have access to your project. This is done automatically when the - # Cloud Life Sciences API is first enabled, but if you delete this permission - # you must disable and re-enable the API to grant the Life Sciences - # Service Agent the required permissions. - # Authorization requires the following [Google - # IAM](https://cloud.google.com/iam/) permission: - # * `lifesciences.workflows.run` + # Runs a pipeline. The returned Operation's metadata field will contain a google. + # cloud.lifesciences.v2beta.Metadata object describing the status of the + # pipeline execution. The response field will contain a google.cloud. + # lifesciences.v2beta.RunPipelineResponse object if the pipeline completes + # successfully. **Note:** Before you can use this method, the *Life Sciences + # Service Agent* must have access to your project. This is done automatically + # when the Cloud Life Sciences API is first enabled, but if you delete this + # permission you must disable and re-enable the API to grant the Life Sciences + # Service Agent the required permissions. Authorization requires the following [ + # Google IAM](https://cloud.google.com/iam/) permission: * `lifesciences. + # workflows.run` # @param [String] parent # The project and location that this request should be executed against. # @param [Google::Apis::LifesciencesV2beta::RunPipelineRequest] run_pipeline_request_object diff --git a/generated/google/apis/oslogin_v1.rb b/generated/google/apis/oslogin_v1.rb index 8ed6f8791..049c206f8 100644 --- a/generated/google/apis/oslogin_v1.rb +++ b/generated/google/apis/oslogin_v1.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/compute/docs/oslogin/ module OsloginV1 VERSION = 'V1' - REVISION = '20200801' + REVISION = '20200810' # 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/oslogin_v1/classes.rb b/generated/google/apis/oslogin_v1/classes.rb index 07d76e4ef..efaf728bf 100644 --- a/generated/google/apis/oslogin_v1/classes.rb +++ b/generated/google/apis/oslogin_v1/classes.rb @@ -43,6 +43,11 @@ module Google class ImportSshPublicKeyResponse include Google::Apis::Core::Hashable + # Detailed information about import results. + # Corresponds to the JSON property `details` + # @return [String] + attr_accessor :details + # The user profile information used for logging in to a virtual machine on # Google Compute Engine. # Corresponds to the JSON property `loginProfile` @@ -55,6 +60,7 @@ module Google # Update properties of this object def update!(**args) + @details = args[:details] if args.key?(:details) @login_profile = args[:login_profile] if args.key?(:login_profile) end end diff --git a/generated/google/apis/oslogin_v1/representations.rb b/generated/google/apis/oslogin_v1/representations.rb index 587d14641..fabfed6e9 100644 --- a/generated/google/apis/oslogin_v1/representations.rb +++ b/generated/google/apis/oslogin_v1/representations.rb @@ -61,6 +61,7 @@ module Google class ImportSshPublicKeyResponse # @private class Representation < Google::Apis::Core::JsonRepresentation + property :details, as: 'details' property :login_profile, as: 'loginProfile', class: Google::Apis::OsloginV1::LoginProfile, decorator: Google::Apis::OsloginV1::LoginProfile::Representation end diff --git a/generated/google/apis/oslogin_v1beta.rb b/generated/google/apis/oslogin_v1beta.rb index 22b8932ba..961a87e2c 100644 --- a/generated/google/apis/oslogin_v1beta.rb +++ b/generated/google/apis/oslogin_v1beta.rb @@ -25,7 +25,7 @@ module Google # @see https://cloud.google.com/compute/docs/oslogin/ module OsloginV1beta VERSION = 'V1beta' - REVISION = '20200801' + REVISION = '20200810' # 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/oslogin_v1beta/classes.rb b/generated/google/apis/oslogin_v1beta/classes.rb index ddc54d02f..a5119f1eb 100644 --- a/generated/google/apis/oslogin_v1beta/classes.rb +++ b/generated/google/apis/oslogin_v1beta/classes.rb @@ -43,6 +43,11 @@ module Google class ImportSshPublicKeyResponse include Google::Apis::Core::Hashable + # Detailed information about import results. + # Corresponds to the JSON property `details` + # @return [String] + attr_accessor :details + # The user profile information used for logging in to a virtual machine on # Google Compute Engine. # Corresponds to the JSON property `loginProfile` @@ -55,6 +60,7 @@ module Google # Update properties of this object def update!(**args) + @details = args[:details] if args.key?(:details) @login_profile = args[:login_profile] if args.key?(:login_profile) end end diff --git a/generated/google/apis/oslogin_v1beta/representations.rb b/generated/google/apis/oslogin_v1beta/representations.rb index 3ff544a06..d07b20474 100644 --- a/generated/google/apis/oslogin_v1beta/representations.rb +++ b/generated/google/apis/oslogin_v1beta/representations.rb @@ -61,6 +61,7 @@ module Google class ImportSshPublicKeyResponse # @private class Representation < Google::Apis::Core::JsonRepresentation + property :details, as: 'details' property :login_profile, as: 'loginProfile', class: Google::Apis::OsloginV1beta::LoginProfile, decorator: Google::Apis::OsloginV1beta::LoginProfile::Representation end diff --git a/generated/google/apis/sasportal_v1alpha1.rb b/generated/google/apis/sasportal_v1alpha1.rb index a3296fe4f..f1cbece42 100644 --- a/generated/google/apis/sasportal_v1alpha1.rb +++ b/generated/google/apis/sasportal_v1alpha1.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/spectrum-access-system/ module SasportalV1alpha1 VERSION = 'V1alpha1' - REVISION = '20200801' + REVISION = '20200817' # View your email address AUTH_USERINFO_EMAIL = 'https://www.googleapis.com/auth/userinfo.email' diff --git a/generated/google/apis/sasportal_v1alpha1/classes.rb b/generated/google/apis/sasportal_v1alpha1/classes.rb index 616231fc3..f2fd51630 100644 --- a/generated/google/apis/sasportal_v1alpha1/classes.rb +++ b/generated/google/apis/sasportal_v1alpha1/classes.rb @@ -338,6 +338,11 @@ module Google # @return [Google::Apis::SasportalV1alpha1::SasPortalFrequencyRange] attr_accessor :frequency_range + # Grant Id. + # Corresponds to the JSON property `grantId` + # @return [String] + attr_accessor :grant_id + # Maximum Equivalent Isotropically Radiated Power (EIRP) permitted by the grant. # The maximum EIRP is in units of dBm/MHz. The value of maxEirp represents the # average (RMS) EIRP that would be measured by the procedure defined in FCC part @@ -370,6 +375,7 @@ module Google @channel_type = args[:channel_type] if args.key?(:channel_type) @expire_time = args[:expire_time] if args.key?(:expire_time) @frequency_range = args[:frequency_range] if args.key?(:frequency_range) + @grant_id = args[:grant_id] if args.key?(:grant_id) @max_eirp = args[:max_eirp] if args.key?(:max_eirp) @move_list = args[:move_list] if args.key?(:move_list) @state = args[:state] if args.key?(:state) diff --git a/generated/google/apis/sasportal_v1alpha1/representations.rb b/generated/google/apis/sasportal_v1alpha1/representations.rb index 3e973278a..641e3d461 100644 --- a/generated/google/apis/sasportal_v1alpha1/representations.rb +++ b/generated/google/apis/sasportal_v1alpha1/representations.rb @@ -319,6 +319,7 @@ module Google property :expire_time, as: 'expireTime' property :frequency_range, as: 'frequencyRange', class: Google::Apis::SasportalV1alpha1::SasPortalFrequencyRange, decorator: Google::Apis::SasportalV1alpha1::SasPortalFrequencyRange::Representation + property :grant_id, as: 'grantId' property :max_eirp, as: 'maxEirp' collection :move_list, as: 'moveList', class: Google::Apis::SasportalV1alpha1::SasPortalDpaMoveList, decorator: Google::Apis::SasportalV1alpha1::SasPortalDpaMoveList::Representation diff --git a/generated/google/apis/securitycenter_v1p1beta1.rb b/generated/google/apis/securitycenter_v1p1beta1.rb index 5a6300ea0..1485f74dc 100644 --- a/generated/google/apis/securitycenter_v1p1beta1.rb +++ b/generated/google/apis/securitycenter_v1p1beta1.rb @@ -26,7 +26,7 @@ module Google # @see https://console.cloud.google.com/apis/api/securitycenter.googleapis.com/overview module SecuritycenterV1p1beta1 VERSION = 'V1p1beta1' - REVISION = '20200806' + REVISION = '20200813' # View and manage your data across Google Cloud Platform services AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform' diff --git a/generated/google/apis/securitycenter_v1p1beta1/classes.rb b/generated/google/apis/securitycenter_v1p1beta1/classes.rb index 0045d0355..96f4253cc 100644 --- a/generated/google/apis/securitycenter_v1p1beta1/classes.rb +++ b/generated/google/apis/securitycenter_v1p1beta1/classes.rb @@ -1396,7 +1396,7 @@ module Google attr_accessor :finding # Information related to the Google Cloud resource that is associated with this - # finding. LINT.IfChange + # finding. # Corresponds to the JSON property `resource` # @return [Google::Apis::SecuritycenterV1p1beta1::Resource] attr_accessor :resource @@ -1741,7 +1741,7 @@ module Google end # Information related to the Google Cloud resource that is associated with this - # finding. LINT.IfChange + # finding. class Resource include Google::Apis::Core::Hashable diff --git a/generated/google/apis/securitycenter_v1p1beta1/service.rb b/generated/google/apis/securitycenter_v1p1beta1/service.rb index cf9da78e1..92fda07e8 100644 --- a/generated/google/apis/securitycenter_v1p1beta1/service.rb +++ b/generated/google/apis/securitycenter_v1p1beta1/service.rb @@ -268,9 +268,9 @@ module Google execute_or_queue_command(command, &block) end - # Runs asset discovery. The discovery is tracked with a long-running operation. / - # / This API can only be called with limited frequency for an organization. If - # it is called too frequently the caller will receive a TOO_MANY_REQUESTS error. + # Runs asset discovery. The discovery is tracked with a long-running operation. + # This API can only be called with limited frequency for an organization. If it + # is called too frequently the caller will receive a TOO_MANY_REQUESTS error. # @param [String] parent # Required. Name of the organization to run asset discovery for. Its format is " # organizations/[organization_id]". @@ -924,8 +924,8 @@ module Google execute_or_queue_command(command, &block) end - # Creates a finding. The corresponding source must exist for finding creation - # to succeed. + # Creates a finding. The corresponding source must exist for finding creation to + # succeed. # @param [String] parent # Required. Resource name of the new finding's parent. Its format should be " # organizations/[organization_id]/sources/[source_id]". diff --git a/generated/google/apis/sheets_v4.rb b/generated/google/apis/sheets_v4.rb index 67a5d2dc7..358174e3a 100644 --- a/generated/google/apis/sheets_v4.rb +++ b/generated/google/apis/sheets_v4.rb @@ -25,7 +25,7 @@ module Google # @see https://developers.google.com/sheets/ module SheetsV4 VERSION = 'V4' - REVISION = '20200707' + REVISION = '20200813' # See, edit, create, and delete all of your Google Drive files AUTH_DRIVE = 'https://www.googleapis.com/auth/drive' diff --git a/generated/google/apis/sheets_v4/classes.rb b/generated/google/apis/sheets_v4/classes.rb index 058fe04ba..5a73d018e 100644 --- a/generated/google/apis/sheets_v4/classes.rb +++ b/generated/google/apis/sheets_v4/classes.rb @@ -98,8 +98,8 @@ module Google end end - # Adds a new conditional format rule at the given index. - # All subsequent rules' indexes are incremented. + # Adds a new conditional format rule at the given index. All subsequent rules' + # indexes are incremented. class AddConditionalFormatRuleRequest include Google::Apis::Core::Hashable @@ -124,29 +124,25 @@ module Google end end - # Creates a group over the specified range. - # If the requested range is a superset of the range of an existing group G, - # then the depth of G is incremented and this new group G' has the - # depth of that group. For example, a group [C:D, depth 1] + [B:E] results in - # groups [B:E, depth 1] and [C:D, depth 2]. - # If the requested range is a subset of the range of an existing group G, - # then the depth of the new group G' becomes one greater than the depth of G. - # For example, a group [B:E, depth 1] + [C:D] results in groups [B:E, depth 1] - # and [C:D, depth 2]. - # If the requested range starts before and ends within, or starts within and - # ends after, the range of an existing group G, then the range of the existing - # group G becomes the union of the ranges, and the new group G' has + # Creates a group over the specified range. If the requested range is a superset + # of the range of an existing group G, then the depth of G is incremented and + # this new group G' has the depth of that group. For example, a group [C:D, + # depth 1] + [B:E] results in groups [B:E, depth 1] and [C:D, depth 2]. If the + # requested range is a subset of the range of an existing group G, then the + # depth of the new group G' becomes one greater than the depth of G. For example, + # a group [B:E, depth 1] + [C:D] results in groups [B:E, depth 1] and [C:D, + # depth 2]. If the requested range starts before and ends within, or starts + # within and ends after, the range of an existing group G, then the range of the + # existing group G becomes the union of the ranges, and the new group G' has # depth one greater than the depth of G and range as the intersection of the # ranges. For example, a group [B:D, depth 1] + [C:E] results in groups [B:E, # depth 1] and [C:D, depth 2]. class AddDimensionGroupRequest include Google::Apis::Core::Hashable - # A range along a single dimension on a sheet. - # All indexes are zero-based. - # Indexes are half open: the start index is inclusive - # and the end index is exclusive. - # Missing indexes indicate the range is unbounded on that side. + # A range along a single dimension on a sheet. All indexes are zero-based. + # Indexes are half open: the start index is inclusive and the end index is + # exclusive. Missing indexes indicate the range is unbounded on that side. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::DimensionRange] attr_accessor :range @@ -294,12 +290,10 @@ module Google end end - # Adds a new sheet. - # When a sheet is added at a given index, - # all subsequent sheets' indexes are incremented. - # To add an object sheet, use AddChartRequest instead and specify - # EmbeddedObjectPosition.sheetId or - # EmbeddedObjectPosition.newSheet. + # Adds a new sheet. When a sheet is added at a given index, all subsequent + # sheets' indexes are incremented. To add an object sheet, use AddChartRequest + # instead and specify EmbeddedObjectPosition.sheetId or EmbeddedObjectPosition. + # newSheet. class AddSheetRequest include Google::Apis::Core::Hashable @@ -375,15 +369,14 @@ module Google end end - # Adds new cells after the last row with data in a sheet, - # inserting new rows into the sheet if necessary. + # Adds new cells after the last row with data in a sheet, inserting new rows + # into the sheet if necessary. class AppendCellsRequest include Google::Apis::Core::Hashable - # The fields of CellData that should be updated. - # At least one field must be specified. - # The root is the CellData; 'row.values.' should not be specified. - # A single `"*"` can be used as short-hand for listing every field. + # The fields of CellData that should be updated. At least one field must be + # specified. The root is the CellData; 'row.values.' should not be specified. A + # single `"*"` can be used as short-hand for listing every field. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -450,9 +443,8 @@ module Google # @return [String] attr_accessor :spreadsheet_id - # The range (in A1 notation) of the table that values are being appended to - # (before the values were appended). - # Empty if no table was found. + # The range (in A1 notation) of the table that values are being appended to ( + # before the values were appended). Empty if no table was found. # Corresponds to the JSON property `tableRange` # @return [String] attr_accessor :table_range @@ -478,28 +470,19 @@ module Google class AutoFillRequest include Google::Apis::Core::Hashable - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range @@ -509,8 +492,8 @@ module Google # @return [Google::Apis::SheetsV4::SourceAndDestination] attr_accessor :source_and_destination - # True if we should generate data with the "alternate" series. - # This differs based on the type and amount of source data. + # True if we should generate data with the "alternate" series. This differs + # based on the type and amount of source data. # Corresponds to the JSON property `useAlternateSeries` # @return [Boolean] attr_accessor :use_alternate_series @@ -528,16 +511,14 @@ module Google end end - # Automatically resizes one or more dimensions based on the contents - # of the cells in that dimension. + # Automatically resizes one or more dimensions based on the contents of the + # cells in that dimension. class AutoResizeDimensionsRequest include Google::Apis::Core::Hashable - # A range along a single dimension on a sheet. - # All indexes are zero-based. - # Indexes are half open: the start index is inclusive - # and the end index is exclusive. - # Missing indexes indicate the range is unbounded on that side. + # A range along a single dimension on a sheet. All indexes are zero-based. + # Indexes are half open: the start index is inclusive and the end index is + # exclusive. Missing indexes indicate the range is unbounded on that side. # Corresponds to the JSON property `dimensions` # @return [Google::Apis::SheetsV4::DimensionRange] attr_accessor :dimensions @@ -562,56 +543,45 @@ module Google attr_accessor :banded_range_id # Properties referring a single dimension (either row or column). If both - # BandedRange.row_properties and BandedRange.column_properties are - # set, the fill colors are applied to cells according to the following rules: - # * header_color and footer_color take priority over band colors. - # * first_band_color takes priority over second_band_color. - # * row_properties takes priority over column_properties. - # For example, the first row color takes priority over the first column - # color, but the first column color takes priority over the second row color. - # Similarly, the row header takes priority over the column header in the - # top left cell, but the column header takes priority over the first row + # BandedRange.row_properties and BandedRange.column_properties are set, the fill + # colors are applied to cells according to the following rules: * header_color + # and footer_color take priority over band colors. * first_band_color takes + # priority over second_band_color. * row_properties takes priority over + # column_properties. For example, the first row color takes priority over the + # first column color, but the first column color takes priority over the second + # row color. Similarly, the row header takes priority over the column header in + # the top left cell, but the column header takes priority over the first row # color if the row header is not set. # Corresponds to the JSON property `columnProperties` # @return [Google::Apis::SheetsV4::BandingProperties] attr_accessor :column_properties - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range # Properties referring a single dimension (either row or column). If both - # BandedRange.row_properties and BandedRange.column_properties are - # set, the fill colors are applied to cells according to the following rules: - # * header_color and footer_color take priority over band colors. - # * first_band_color takes priority over second_band_color. - # * row_properties takes priority over column_properties. - # For example, the first row color takes priority over the first column - # color, but the first column color takes priority over the second row color. - # Similarly, the row header takes priority over the column header in the - # top left cell, but the column header takes priority over the first row + # BandedRange.row_properties and BandedRange.column_properties are set, the fill + # colors are applied to cells according to the following rules: * header_color + # and footer_color take priority over band colors. * first_band_color takes + # priority over second_band_color. * row_properties takes priority over + # column_properties. For example, the first row color takes priority over the + # first column color, but the first column color takes priority over the second + # row color. Similarly, the row header takes priority over the column header in + # the top left cell, but the column header takes priority over the first row # color if the row header is not set. # Corresponds to the JSON property `rowProperties` # @return [Google::Apis::SheetsV4::BandingProperties] @@ -631,125 +601,63 @@ module Google end # Properties referring a single dimension (either row or column). If both - # BandedRange.row_properties and BandedRange.column_properties are - # set, the fill colors are applied to cells according to the following rules: - # * header_color and footer_color take priority over band colors. - # * first_band_color takes priority over second_band_color. - # * row_properties takes priority over column_properties. - # For example, the first row color takes priority over the first column - # color, but the first column color takes priority over the second row color. - # Similarly, the row header takes priority over the column header in the - # top left cell, but the column header takes priority over the first row + # BandedRange.row_properties and BandedRange.column_properties are set, the fill + # colors are applied to cells according to the following rules: * header_color + # and footer_color take priority over band colors. * first_band_color takes + # priority over second_band_color. * row_properties takes priority over + # column_properties. For example, the first row color takes priority over the + # first column color, but the first column color takes priority over the second + # row color. Similarly, the row header takes priority over the column header in + # the top left cell, but the column header takes priority over the first row # color if the row header is not set. class BandingProperties 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 `firstBandColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :first_band_color @@ -761,110 +669,49 @@ 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(''); `; // ... # Corresponds to the JSON property `footerColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :footer_color @@ -876,110 +723,49 @@ 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(''); `; // ... # Corresponds to the JSON property `headerColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :header_color @@ -991,110 +777,49 @@ 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(''); `; // ... # Corresponds to the JSON property `secondBandColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :second_band_color @@ -1130,118 +855,56 @@ module Google # @return [String] attr_accessor :comparison_type - # Description which is appended after the baseline value. - # This field is optional. + # Description which is appended after the baseline value. This field is optional. # Corresponds to the JSON property `description` # @return [String] attr_accessor :description # 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 `negativeColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :negative_color @@ -1258,110 +921,49 @@ 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(''); `; // ... # Corresponds to the JSON property `positiveColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :positive_color @@ -1371,8 +973,8 @@ module Google # @return [Google::Apis::SheetsV4::ColorStyle] attr_accessor :positive_color_style - # The format of a run of text in a cell. - # Absent values indicate that the field isn't specified. + # The format of a run of text in a cell. Absent values indicate that the field + # isn't specified. # Corresponds to the JSON property `textFormat` # @return [Google::Apis::SheetsV4::TextFormat] attr_accessor :text_format @@ -1394,14 +996,13 @@ module Google end end - # An axis of the chart. - # A chart may not have more than one axis per - # axis position. + # An axis of the chart. A chart may not have more than one axis per axis + # position. class BasicChartAxis include Google::Apis::Core::Hashable - # The format of a run of text in a cell. - # Absent values indicate that the field isn't specified. + # The format of a run of text in a cell. Absent values indicate that the field + # isn't specified. # Corresponds to the JSON property `format` # @return [Google::Apis::SheetsV4::TextFormat] attr_accessor :format @@ -1411,8 +1012,8 @@ module Google # @return [String] attr_accessor :position - # The title of this axis. If set, this overrides any title inferred - # from headers of the data. + # The title of this axis. If set, this overrides any title inferred from headers + # of the data. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -1442,8 +1043,8 @@ module Google end end - # The domain of a chart. - # For example, if charting stock prices over time, this would be the date. + # The domain of a chart. For example, if charting stock prices over time, this + # would be the date. class BasicChartDomain include Google::Apis::Core::Hashable @@ -1469,118 +1070,57 @@ module Google end end - # A single series of data in a chart. - # For example, if charting stock prices over time, multiple series may exist, - # one for the "Open Price", "High Price", "Low Price" and "Close Price". + # A single series of data in a chart. For example, if charting stock prices over + # time, multiple series may exist, one for the "Open Price", "High Price", "Low + # Price" and "Close Price". class BasicChartSeries 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::SheetsV4::Color] attr_accessor :color @@ -1600,23 +1140,18 @@ module Google # @return [Google::Apis::SheetsV4::ChartData] attr_accessor :series - # The minor axis that will specify the range of values for this series. - # For example, if charting stocks over time, the "Volume" series - # may want to be pinned to the right with the prices pinned to the left, - # because the scale of trading volume is different than the scale of - # prices. - # It is an error to specify an axis that isn't a valid minor axis - # for the chart's type. + # The minor axis that will specify the range of values for this series. For + # example, if charting stocks over time, the "Volume" series may want to be + # pinned to the right with the prices pinned to the left, because the scale of + # trading volume is different than the scale of prices. It is an error to + # specify an axis that isn't a valid minor axis for the chart's type. # Corresponds to the JSON property `targetAxis` # @return [String] attr_accessor :target_axis - # The type of this series. Valid only if the - # chartType is - # COMBO. - # Different types will change the way the series is visualized. - # Only LINE, AREA, - # and COLUMN are supported. + # The type of this series. Valid only if the chartType is COMBO. Different types + # will change the way the series is visualized. Only LINE, AREA, and COLUMN are + # supported. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -1636,8 +1171,8 @@ module Google end end - # The specification for a basic chart. See BasicChartType for the list - # of charts this supports. + # The specification for a basic chart. See BasicChartType for the list of charts + # this supports. class BasicChartSpec include Google::Apis::Core::Hashable @@ -1651,31 +1186,28 @@ module Google # @return [String] attr_accessor :chart_type - # The behavior of tooltips and data highlighting when hovering on data and - # chart area. + # The behavior of tooltips and data highlighting when hovering on data and chart + # area. # Corresponds to the JSON property `compareMode` # @return [String] attr_accessor :compare_mode - # The domain of data this is charting. - # Only a single domain is supported. + # The domain of data this is charting. Only a single domain is supported. # Corresponds to the JSON property `domains` # @return [Array] attr_accessor :domains - # The number of rows or columns in the data that are "headers". - # If not set, Google Sheets will guess how many rows are headers based - # on the data. - # (Note that BasicChartAxis.title may override the axis title - # inferred from the header values.) + # The number of rows or columns in the data that are "headers". If not set, + # Google Sheets will guess how many rows are headers based on the data. (Note + # that BasicChartAxis.title may override the axis title inferred from the header + # values.) # Corresponds to the JSON property `headerCount` # @return [Fixnum] attr_accessor :header_count # If some values in a series are missing, gaps may appear in the chart (e.g, - # segments of lines in a line chart will be missing). To eliminate these - # gaps set this to true. - # Applies to Line, Area, and Combo charts. + # segments of lines in a line chart will be missing). To eliminate these gaps + # set this to true. Applies to Line, Area, and Combo charts. # Corresponds to the JSON property `interpolateNulls` # @return [Boolean] attr_accessor :interpolate_nulls @@ -1698,14 +1230,13 @@ module Google # @return [Array] attr_accessor :series - # The stacked type for charts that support vertical stacking. - # Applies to Area, Bar, Column, Combo, and Stepped Area charts. + # The stacked type for charts that support vertical stacking. Applies to Area, + # Bar, Column, Combo, and Stepped Area charts. # Corresponds to the JSON property `stackedType` # @return [String] attr_accessor :stacked_type - # True to make the chart 3D. - # Applies to Bar and Column charts. + # True to make the chart 3D. Applies to Bar and Column charts. # Corresponds to the JSON property `threeDimensional` # @return [Boolean] attr_accessor :three_dimensional @@ -1735,41 +1266,31 @@ module Google class BasicFilter include Google::Apis::Core::Hashable - # The criteria for showing/hiding values per column. - # The map's key is the column index, and the value is the criteria for - # that column. + # The criteria for showing/hiding values per column. The map's key is the column + # index, and the value is the criteria for that column. # Corresponds to the JSON property `criteria` # @return [Hash] attr_accessor :criteria - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range - # The sort order per column. Later specifications are used when values - # are equal in the earlier specifications. + # The sort order per column. Later specifications are used when values are equal + # in the earlier specifications. # Corresponds to the JSON property `sortSpecs` # @return [Array] attr_accessor :sort_specs @@ -1786,8 +1307,8 @@ module Google end end - # The request for clearing more than one range selected by a - # DataFilter in a spreadsheet. + # The request for clearing more than one range selected by a DataFilter in a + # spreadsheet. class BatchClearValuesByDataFilterRequest include Google::Apis::Core::Hashable @@ -1806,14 +1327,14 @@ module Google end end - # The response when clearing a range of values selected with - # DataFilters in a spreadsheet. + # The response when clearing a range of values selected with DataFilters in a + # spreadsheet. class BatchClearValuesByDataFilterResponse include Google::Apis::Core::Hashable # The ranges that were cleared, in A1 notation. If the requests are for an - # unbounded range or a ranger larger than the bounds of the sheet, this is - # the actual ranges that were cleared, bounded to the sheet's limits. + # unbounded range or a ranger larger than the bounds of the sheet, this is the + # actual ranges that were cleared, bounded to the sheet's limits. # Corresponds to the JSON property `clearedRanges` # @return [Array] attr_accessor :cleared_ranges @@ -1858,8 +1379,8 @@ module Google include Google::Apis::Core::Hashable # The ranges that were cleared, in A1 notation. If the requests are for an - # unbounded range or a ranger larger than the bounds of the sheet, this is - # the actual ranges that were cleared, bounded to the sheet's limits. + # unbounded range or a ranger larger than the bounds of the sheet, this is the + # actual ranges that were cleared, bounded to the sheet's limits. # Corresponds to the JSON property `clearedRanges` # @return [Array] attr_accessor :cleared_ranges @@ -1885,31 +1406,29 @@ module Google class BatchGetValuesByDataFilterRequest include Google::Apis::Core::Hashable - # The data filters used to match the ranges of values to retrieve. Ranges - # that match any of the specified data filters are included in the response. + # The data filters used to match the ranges of values to retrieve. Ranges that + # match any of the specified data filters are included in the response. # Corresponds to the JSON property `dataFilters` # @return [Array] attr_accessor :data_filters - # How dates, times, and durations should be represented in the output. - # This is ignored if value_render_option is - # FORMATTED_VALUE. - # The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. + # How dates, times, and durations should be represented in the output. This is + # ignored if value_render_option is FORMATTED_VALUE. The default dateTime render + # option is [DateTimeRenderOption.SERIAL_NUMBER]. # Corresponds to the JSON property `dateTimeRenderOption` # @return [String] attr_accessor :date_time_render_option - # The major dimension that results should use. - # For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, - # then a request that selects that range and sets `majorDimension=ROWS` - # returns `[[1,2],[3,4]]`, whereas a request that sets - # `majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. + # The major dimension that results should use. For example, if the spreadsheet + # data is: `A1=1,B1=2,A2=3,B2=4`, then a request that selects that range and + # sets `majorDimension=ROWS` returns `[[1,2],[3,4]]`, whereas a request that + # sets `majorDimension=COLUMNS` returns `[[1,3],[2,4]]`. # Corresponds to the JSON property `majorDimension` # @return [String] attr_accessor :major_dimension - # How values should be represented in the output. - # The default render option is ValueRenderOption.FORMATTED_VALUE. + # How values should be represented in the output. The default render option is + # ValueRenderOption.FORMATTED_VALUE. # Corresponds to the JSON property `valueRenderOption` # @return [String] attr_accessor :value_render_option @@ -1962,8 +1481,8 @@ module Google # @return [String] attr_accessor :spreadsheet_id - # The requested values. The order of the ValueRanges is the same as the - # order of the requested ranges. + # The requested values. The order of the ValueRanges is the same as the order of + # the requested ranges. # Corresponds to the JSON property `valueRanges` # @return [Array] attr_accessor :value_ranges @@ -1983,30 +1502,29 @@ module Google class BatchUpdateSpreadsheetRequest include Google::Apis::Core::Hashable - # Determines if the update response should include the spreadsheet - # resource. + # Determines if the update response should include the spreadsheet resource. # Corresponds to the JSON property `includeSpreadsheetInResponse` # @return [Boolean] attr_accessor :include_spreadsheet_in_response alias_method :include_spreadsheet_in_response?, :include_spreadsheet_in_response - # A list of updates to apply to the spreadsheet. - # Requests will be applied in the order they are specified. - # If any request is not valid, no requests will be applied. + # A list of updates to apply to the spreadsheet. Requests will be applied in the + # order they are specified. If any request is not valid, no requests will be + # applied. # Corresponds to the JSON property `requests` # @return [Array] attr_accessor :requests # True if grid data should be returned. Meaningful only if - # include_spreadsheet_in_response is 'true'. - # This parameter is ignored if a field mask was set in the request. + # include_spreadsheet_in_response is 'true'. This parameter is ignored if a + # field mask was set in the request. # Corresponds to the JSON property `responseIncludeGridData` # @return [Boolean] attr_accessor :response_include_grid_data alias_method :response_include_grid_data?, :response_include_grid_data - # Limits the ranges included in the response spreadsheet. - # Meaningful only if include_spreadsheet_in_response is 'true'. + # Limits the ranges included in the response spreadsheet. Meaningful only if + # include_spreadsheet_in_response is 'true'. # Corresponds to the JSON property `responseRanges` # @return [Array] attr_accessor :response_ranges @@ -2028,8 +1546,8 @@ module Google class BatchUpdateSpreadsheetResponse include Google::Apis::Core::Hashable - # The reply of the updates. This maps 1:1 with the updates, although - # replies to some requests may be empty. + # The reply of the updates. This maps 1:1 with the updates, although replies to + # some requests may be empty. # Corresponds to the JSON property `replies` # @return [Array] attr_accessor :replies @@ -2060,36 +1578,33 @@ module Google class BatchUpdateValuesByDataFilterRequest include Google::Apis::Core::Hashable - # The new values to apply to the spreadsheet. If more than one range is - # matched by the specified DataFilter the specified values are applied to - # all of those ranges. + # The new values to apply to the spreadsheet. If more than one range is matched + # by the specified DataFilter the specified values are applied to all of those + # ranges. # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data - # Determines if the update response should include the values - # of the cells that were updated. By default, responses - # do not include the updated values. The `updatedData` field within - # each of the BatchUpdateValuesResponse.responses contains the updated - # values. If the range to write was larger than the range actually written, - # the response includes all values in the requested range (excluding trailing - # empty rows and columns). + # Determines if the update response should include the values of the cells that + # were updated. By default, responses do not include the updated values. The ` + # updatedData` field within each of the BatchUpdateValuesResponse.responses + # contains the updated values. If the range to write was larger than the range + # actually written, the response includes all values in the requested range ( + # excluding trailing empty rows and columns). # Corresponds to the JSON property `includeValuesInResponse` # @return [Boolean] attr_accessor :include_values_in_response alias_method :include_values_in_response?, :include_values_in_response - # Determines how dates, times, and durations in the response should be - # rendered. This is ignored if response_value_render_option is - # FORMATTED_VALUE. - # The default dateTime render option is - # DateTimeRenderOption.SERIAL_NUMBER. + # Determines how dates, times, and durations in the response should be rendered. + # This is ignored if response_value_render_option is FORMATTED_VALUE. The + # default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER. # Corresponds to the JSON property `responseDateTimeRenderOption` # @return [String] attr_accessor :response_date_time_render_option - # Determines how values in the response should be rendered. - # The default render option is ValueRenderOption.FORMATTED_VALUE. + # Determines how values in the response should be rendered. The default render + # option is ValueRenderOption.FORMATTED_VALUE. # Corresponds to the JSON property `responseValueRenderOption` # @return [String] attr_accessor :response_value_render_option @@ -2132,8 +1647,7 @@ module Google # @return [Fixnum] attr_accessor :total_updated_cells - # The total number of columns where at least one cell in the column was - # updated. + # The total number of columns where at least one cell in the column was updated. # Corresponds to the JSON property `totalUpdatedColumns` # @return [Fixnum] attr_accessor :total_updated_columns @@ -2143,8 +1657,7 @@ module Google # @return [Fixnum] attr_accessor :total_updated_rows - # The total number of sheets where at least one cell in the sheet was - # updated. + # The total number of sheets where at least one cell in the sheet was updated. # Corresponds to the JSON property `totalUpdatedSheets` # @return [Fixnum] attr_accessor :total_updated_sheets @@ -2173,29 +1686,26 @@ module Google # @return [Array] attr_accessor :data - # Determines if the update response should include the values - # of the cells that were updated. By default, responses - # do not include the updated values. The `updatedData` field within - # each of the BatchUpdateValuesResponse.responses contains the updated - # values. If the range to write was larger than the range actually written, - # the response includes all values in the requested range (excluding trailing - # empty rows and columns). + # Determines if the update response should include the values of the cells that + # were updated. By default, responses do not include the updated values. The ` + # updatedData` field within each of the BatchUpdateValuesResponse.responses + # contains the updated values. If the range to write was larger than the range + # actually written, the response includes all values in the requested range ( + # excluding trailing empty rows and columns). # Corresponds to the JSON property `includeValuesInResponse` # @return [Boolean] attr_accessor :include_values_in_response alias_method :include_values_in_response?, :include_values_in_response - # Determines how dates, times, and durations in the response should be - # rendered. This is ignored if response_value_render_option is - # FORMATTED_VALUE. - # The default dateTime render option is - # DateTimeRenderOption.SERIAL_NUMBER. + # Determines how dates, times, and durations in the response should be rendered. + # This is ignored if response_value_render_option is FORMATTED_VALUE. The + # default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER. # Corresponds to the JSON property `responseDateTimeRenderOption` # @return [String] attr_accessor :response_date_time_render_option - # Determines how values in the response should be rendered. - # The default render option is ValueRenderOption.FORMATTED_VALUE. + # Determines how values in the response should be rendered. The default render + # option is ValueRenderOption.FORMATTED_VALUE. # Corresponds to the JSON property `responseValueRenderOption` # @return [String] attr_accessor :response_value_render_option @@ -2223,8 +1733,8 @@ module Google class BatchUpdateValuesResponse include Google::Apis::Core::Hashable - # One UpdateValuesResponse per requested range, in the same order as - # the requests appeared. + # One UpdateValuesResponse per requested range, in the same order as the + # requests appeared. # Corresponds to the JSON property `responses` # @return [Array] attr_accessor :responses @@ -2239,8 +1749,7 @@ module Google # @return [Fixnum] attr_accessor :total_updated_cells - # The total number of columns where at least one cell in the column was - # updated. + # The total number of columns where at least one cell in the column was updated. # Corresponds to the JSON property `totalUpdatedColumns` # @return [Fixnum] attr_accessor :total_updated_columns @@ -2250,8 +1759,7 @@ module Google # @return [Fixnum] attr_accessor :total_updated_rows - # The total number of sheets where at least one cell in the sheet was - # updated. + # The total number of sheets where at least one cell in the sheet was updated. # Corresponds to the JSON property `totalUpdatedSheets` # @return [Fixnum] attr_accessor :total_updated_sheets @@ -2271,9 +1779,8 @@ module Google end end - # A condition that can evaluate to true or false. - # BooleanConditions are used by conditional formatting, - # data validation, and the criteria in filters. + # A condition that can evaluate to true or false. BooleanConditions are used by + # conditional formatting, data validation, and the criteria in filters. class BooleanCondition include Google::Apis::Core::Hashable @@ -2282,10 +1789,9 @@ module Google # @return [String] attr_accessor :type - # The values of the condition. The number of supported values depends - # on the condition type. Some support zero values, - # others one or two values, - # and ConditionType.ONE_OF_LIST supports an arbitrary number of values. + # The values of the condition. The number of supported values depends on the + # condition type. Some support zero values, others one or two values, and + # ConditionType.ONE_OF_LIST supports an arbitrary number of values. # Corresponds to the JSON property `values` # @return [Array] attr_accessor :values @@ -2305,9 +1811,8 @@ module Google class BooleanRule include Google::Apis::Core::Hashable - # A condition that can evaluate to true or false. - # BooleanConditions are used by conditional formatting, - # data validation, and the criteria in filters. + # A condition that can evaluate to true or false. BooleanConditions are used by + # conditional formatting, data validation, and the criteria in filters. # Corresponds to the JSON property `condition` # @return [Google::Apis::SheetsV4::BooleanCondition] attr_accessor :condition @@ -2334,110 +1839,49 @@ 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(''); `; // ... # Corresponds to the JSON property `color` # @return [Google::Apis::SheetsV4::Color] attr_accessor :color @@ -2452,8 +1896,8 @@ module Google # @return [String] attr_accessor :style - # The width of the border, in pixels. - # Deprecated; the width is determined by the "style" field. + # The width of the border, in pixels. Deprecated; the width is determined by the + # "style" field. # Corresponds to the JSON property `width` # @return [Fixnum] attr_accessor :width @@ -2508,116 +1952,55 @@ module Google end end - # A bubble chart. + # A bubble chart. class BubbleChartSpec 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 `bubbleBorderColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :bubble_border_color @@ -2632,20 +2015,20 @@ module Google # @return [Google::Apis::SheetsV4::ChartData] attr_accessor :bubble_labels - # The max radius size of the bubbles, in pixels. - # If specified, the field must be a positive value. + # The max radius size of the bubbles, in pixels. If specified, the field must be + # a positive value. # Corresponds to the JSON property `bubbleMaxRadiusSize` # @return [Fixnum] attr_accessor :bubble_max_radius_size - # The minimum radius size of the bubbles, in pixels. - # If specific, the field must be a positive value. + # The minimum radius size of the bubbles, in pixels. If specific, the field must + # be a positive value. # Corresponds to the JSON property `bubbleMinRadiusSize` # @return [Fixnum] attr_accessor :bubble_min_radius_size - # The opacity of the bubbles between 0 and 1.0. - # 0 is fully transparent and 1 is fully opaque. + # The opacity of the bubbles between 0 and 1.0. 0 is fully transparent and 1 is + # fully opaque. # Corresponds to the JSON property `bubbleOpacity` # @return [Float] attr_accessor :bubble_opacity @@ -2655,8 +2038,8 @@ module Google # @return [Google::Apis::SheetsV4::ChartData] attr_accessor :bubble_sizes - # The format of a run of text in a cell. - # Absent values indicate that the field isn't specified. + # The format of a run of text in a cell. Absent values indicate that the field + # isn't specified. # Corresponds to the JSON property `bubbleTextStyle` # @return [Google::Apis::SheetsV4::TextFormat] attr_accessor :bubble_text_style @@ -2702,13 +2085,11 @@ module Google end end - # A candlestick - # chart. + # A candlestick chart. class CandlestickChartSpec include Google::Apis::Core::Hashable - # The Candlestick chart data. - # Only one CandlestickData is supported. + # The Candlestick chart data. Only one CandlestickData is supported. # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data @@ -2831,17 +2212,14 @@ module Google # @return [Google::Apis::SheetsV4::ExtendedValue] attr_accessor :effective_value - # The formatted value of the cell. - # This is the value as it's shown to the user. + # The formatted value of the cell. This is the value as it's shown to the user. # This field is read-only. # Corresponds to the JSON property `formattedValue` # @return [String] attr_accessor :formatted_value - # A hyperlink this cell points to, if any. - # This field is read-only. (To set it, use a `=HYPERLINK` formula - # in the userEnteredValue.formulaValue - # field.) + # A hyperlink this cell points to, if any. This field is read-only. (To set it, + # use a `=HYPERLINK` formula in the userEnteredValue.formulaValue field.) # Corresponds to the JSON property `hyperlink` # @return [String] attr_accessor :hyperlink @@ -2856,14 +2234,13 @@ module Google # @return [Google::Apis::SheetsV4::PivotTable] attr_accessor :pivot_table - # Runs of rich text applied to subsections of the cell. Runs are only valid - # on user entered strings, not formulas, bools, or numbers. - # Runs start at specific indexes in the text and continue until the next - # run. Properties of a run will continue unless explicitly changed - # in a subsequent run (and properties of the first run will continue - # the properties of the cell unless explicitly changed). - # When writing, the new runs will overwrite any prior runs. When writing a - # new user_entered_value, previous runs are erased. + # Runs of rich text applied to subsections of the cell. Runs are only valid on + # user entered strings, not formulas, bools, or numbers. Runs start at specific + # indexes in the text and continue until the next run. Properties of a run will + # continue unless explicitly changed in a subsequent run (and properties of the + # first run will continue the properties of the cell unless explicitly changed). + # When writing, the new runs will overwrite any prior runs. When writing a new + # user_entered_value, previous runs are erased. # Corresponds to the JSON property `textFormatRuns` # @return [Array] attr_accessor :text_format_runs @@ -2903,110 +2280,49 @@ 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(''); `; // ... # Corresponds to the JSON property `backgroundColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :background_color @@ -3036,8 +2352,8 @@ module Google # @return [Google::Apis::SheetsV4::NumberFormat] attr_accessor :number_format - # The amount of padding around the cell, in pixels. - # When updating padding, every field must be specified. + # The amount of padding around the cell, in pixels. When updating padding, every + # field must be specified. # Corresponds to the JSON property `padding` # @return [Google::Apis::SheetsV4::Padding] attr_accessor :padding @@ -3047,8 +2363,8 @@ module Google # @return [String] attr_accessor :text_direction - # The format of a run of text in a cell. - # Absent values indicate that the field isn't specified. + # The format of a run of text in a cell. Absent values indicate that the field + # isn't specified. # Corresponds to the JSON property `textFormat` # @return [Google::Apis::SheetsV4::TextFormat] attr_accessor :text_format @@ -3127,14 +2443,12 @@ module Google class ChartCustomNumberFormatOptions include Google::Apis::Core::Hashable - # Custom prefix to be prepended to the chart attribute. - # This field is optional. + # Custom prefix to be prepended to the chart attribute. This field is optional. # Corresponds to the JSON property `prefix` # @return [String] attr_accessor :prefix - # Custom suffix to be appended to the chart attribute. - # This field is optional. + # Custom suffix to be appended to the chart attribute. This field is optional. # Corresponds to the JSON property `suffix` # @return [String] attr_accessor :suffix @@ -3173,21 +2487,14 @@ module Google class ChartSourceRange include Google::Apis::Core::Hashable - # The ranges of data for a series or domain. - # Exactly one dimension must have a length of 1, - # and all sources in the list must have the same dimension - # with length 1. - # The domain (if it exists) & all series must have the same number - # of source ranges. If using more than one source range, then the source - # range at a given offset must be in order and contiguous across the domain - # and series. - # For example, these are valid configurations: - # domain sources: A1:A5 - # series1 sources: B1:B5 - # series2 sources: D6:D10 - # domain sources: A1:A5, C10:C12 - # series1 sources: B1:B5, D10:D12 - # series2 sources: C1:C5, E10:E12 + # The ranges of data for a series or domain. Exactly one dimension must have a + # length of 1, and all sources in the list must have the same dimension with + # length 1. The domain (if it exists) & all series must have the same number of + # source ranges. If using more than one source range, then the source range at a + # given offset must be in order and contiguous across the domain and series. For + # example, these are valid configurations: domain sources: A1:A5 series1 sources: + # B1:B5 series2 sources: D6:D10 domain sources: A1:A5, C10:C12 series1 sources: + # B1:B5, D10:D12 series2 sources: C1:C5, E10:E12 # Corresponds to the JSON property `sources` # @return [Array] attr_accessor :sources @@ -3206,118 +2513,57 @@ module Google class ChartSpec include Google::Apis::Core::Hashable - # The alternative text that describes the chart. This is often used - # for accessibility. + # The alternative text that describes the chart. This is often used for + # accessibility. # Corresponds to the JSON property `altText` # @return [String] attr_accessor :alt_text # 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 `backgroundColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :background_color @@ -3327,26 +2573,25 @@ module Google # @return [Google::Apis::SheetsV4::ColorStyle] attr_accessor :background_color_style - # The specification for a basic chart. See BasicChartType for the list - # of charts this supports. + # The specification for a basic chart. See BasicChartType for the list of charts + # this supports. # Corresponds to the JSON property `basicChart` # @return [Google::Apis::SheetsV4::BasicChartSpec] attr_accessor :basic_chart - # A bubble chart. + # A bubble chart. # Corresponds to the JSON property `bubbleChart` # @return [Google::Apis::SheetsV4::BubbleChartSpec] attr_accessor :bubble_chart - # A candlestick - # chart. + # A candlestick chart. # Corresponds to the JSON property `candlestickChart` # @return [Google::Apis::SheetsV4::CandlestickChartSpec] attr_accessor :candlestick_chart - # The name of the font to use by default for all chart text (e.g. title, - # axis labels, legend). If a font is specified for a specific part of the - # chart it will override this font name. + # The name of the font to use by default for all chart text (e.g. title, axis + # labels, legend). If a font is specified for a specific part of the chart it + # will override this font name. # Corresponds to the JSON property `fontName` # @return [String] attr_accessor :font_name @@ -3356,49 +2601,45 @@ module Google # @return [String] attr_accessor :hidden_dimension_strategy - # A histogram chart. - # A histogram chart groups data items into bins, displaying each bin as a - # column of stacked items. Histograms are used to display the distribution - # of a dataset. Each column of items represents a range into which those - # items fall. The number of bins can be chosen automatically or specified + # A histogram chart. A histogram chart groups data items into bins, displaying + # each bin as a column of stacked items. Histograms are used to display the + # distribution of a dataset. Each column of items represents a range into which + # those items fall. The number of bins can be chosen automatically or specified # explicitly. # Corresponds to the JSON property `histogramChart` # @return [Google::Apis::SheetsV4::HistogramChartSpec] attr_accessor :histogram_chart - # True to make a chart fill the entire space in which it's rendered with - # minimum padding. False to use the default padding. - # (Not applicable to Geo and Org charts.) + # True to make a chart fill the entire space in which it's rendered with minimum + # padding. False to use the default padding. (Not applicable to Geo and Org + # charts.) # Corresponds to the JSON property `maximized` # @return [Boolean] attr_accessor :maximized alias_method :maximized?, :maximized - # An org chart. - # Org charts require a unique set of labels in labels and may - # optionally include parent_labels and tooltips. - # parent_labels contain, for each node, the label identifying the parent - # node. tooltips contain, for each node, an optional tooltip. - # For example, to describe an OrgChart with Alice as the CEO, Bob as the - # President (reporting to Alice) and Cathy as VP of Sales (also reporting to - # Alice), have labels contain "Alice", "Bob", "Cathy", - # parent_labels contain "", "Alice", "Alice" and tooltips contain - # "CEO", "President", "VP Sales". + # An org chart. Org charts require a unique set of labels in labels and may + # optionally include parent_labels and tooltips. parent_labels contain, for each + # node, the label identifying the parent node. tooltips contain, for each node, + # an optional tooltip. For example, to describe an OrgChart with Alice as the + # CEO, Bob as the President (reporting to Alice) and Cathy as VP of Sales (also + # reporting to Alice), have labels contain "Alice", "Bob", "Cathy", + # parent_labels contain "", "Alice", "Alice" and tooltips contain "CEO", " + # President", "VP Sales". # Corresponds to the JSON property `orgChart` # @return [Google::Apis::SheetsV4::OrgChartSpec] attr_accessor :org_chart - # A pie chart. + # A pie chart. # Corresponds to the JSON property `pieChart` # @return [Google::Apis::SheetsV4::PieChartSpec] attr_accessor :pie_chart # A scorecard chart. Scorecard charts are used to highlight key performance - # indicators, known as KPIs, on the spreadsheet. A scorecard chart can - # represent things like total sales, average cost, or a top selling item. You - # can specify a single data value, or aggregate over a range of data. - # Percentage or absolute difference from a baseline value can be highlighted, - # like changes over time. + # indicators, known as KPIs, on the spreadsheet. A scorecard chart can represent + # things like total sales, average cost, or a top selling item. You can specify + # a single data value, or aggregate over a range of data. Percentage or absolute + # difference from a baseline value can be highlighted, like changes over time. # Corresponds to the JSON property `scorecardChart` # @return [Google::Apis::SheetsV4::ScorecardChartSpec] attr_accessor :scorecard_chart @@ -3408,8 +2649,8 @@ module Google # @return [String] attr_accessor :subtitle - # The format of a run of text in a cell. - # Absent values indicate that the field isn't specified. + # The format of a run of text in a cell. Absent values indicate that the field + # isn't specified. # Corresponds to the JSON property `subtitleTextFormat` # @return [Google::Apis::SheetsV4::TextFormat] attr_accessor :subtitle_text_format @@ -3424,8 +2665,8 @@ module Google # @return [String] attr_accessor :title - # The format of a run of text in a cell. - # Absent values indicate that the field isn't specified. + # The format of a run of text in a cell. Absent values indicate that the field + # isn't specified. # Corresponds to the JSON property `titleTextFormat` # @return [Google::Apis::SheetsV4::TextFormat] attr_accessor :title_text_format @@ -3435,7 +2676,7 @@ module Google # @return [Google::Apis::SheetsV4::TextPosition] attr_accessor :title_text_position - # A Treemap chart. + # A Treemap chart. # Corresponds to the JSON property `treemapChart` # @return [Google::Apis::SheetsV4::TreemapChartSpec] attr_accessor :treemap_chart @@ -3511,10 +2752,9 @@ module Google class ClearValuesResponse include Google::Apis::Core::Hashable - # The range (in A1 notation) that was cleared. - # (If the request was for an unbounded range or a ranger larger - # than the bounds of the sheet, this will be the actual range - # that was cleared, bounded to the sheet's limits.) + # The range (in A1 notation) that was cleared. (If the request was for an + # unbounded range or a ranger larger than the bounds of the sheet, this will be + # the actual range that was cleared, bounded to the sheet's limits.) # Corresponds to the JSON property `clearedRange` # @return [String] attr_accessor :cleared_range @@ -3537,122 +2777,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 @@ -3691,110 +2870,49 @@ 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(''); `; // ... # Corresponds to the JSON property `rgbColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :rgb_color @@ -3819,22 +2937,16 @@ module Google class ConditionValue include Google::Apis::Core::Hashable - # A relative date (based on the current date). - # Valid only if the type is - # DATE_BEFORE, - # DATE_AFTER, - # DATE_ON_OR_BEFORE or - # DATE_ON_OR_AFTER. - # Relative dates are not supported in data validation. - # They are supported only in conditional formatting and - # conditional filters. + # A relative date (based on the current date). Valid only if the type is + # DATE_BEFORE, DATE_AFTER, DATE_ON_OR_BEFORE or DATE_ON_OR_AFTER. Relative dates + # are not supported in data validation. They are supported only in conditional + # formatting and conditional filters. # Corresponds to the JSON property `relativeDate` # @return [String] attr_accessor :relative_date - # A value the condition is based on. - # The value is parsed as if the user typed into a cell. - # Formulas are supported (and must begin with an `=` or a '+'). + # A value the condition is based on. The value is parsed as if the user typed + # into a cell. Formulas are supported (and must begin with an `=` or a '+'). # Corresponds to the JSON property `userEnteredValue` # @return [String] attr_accessor :user_entered_value @@ -3859,16 +2971,15 @@ module Google # @return [Google::Apis::SheetsV4::BooleanRule] attr_accessor :boolean_rule - # A rule that applies a gradient color scale format, based on - # the interpolation points listed. The format of a cell will vary - # based on its contents as compared to the values of the interpolation - # points. + # A rule that applies a gradient color scale format, based on the interpolation + # points listed. The format of a cell will vary based on its contents as + # compared to the values of the interpolation points. # Corresponds to the JSON property `gradientRule` # @return [Google::Apis::SheetsV4::GradientRule] attr_accessor :gradient_rule - # The ranges that are formatted if the condition is true. - # All the ranges must be on the same grid. + # The ranges that are formatted if the condition is true. All the ranges must be + # on the same grid. # Corresponds to the JSON property `ranges` # @return [Array] attr_accessor :ranges @@ -3889,28 +3000,19 @@ module Google class CopyPasteRequest include Google::Apis::Core::Hashable - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `destination` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :destination @@ -3925,28 +3027,19 @@ module Google # @return [String] attr_accessor :paste_type - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `source` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :source @@ -3988,13 +3081,13 @@ module Google include Google::Apis::Core::Hashable # Developer metadata associated with a location or object in a spreadsheet. - # Developer metadata may be used to associate arbitrary data with various - # parts of a spreadsheet and will remain associated at those locations as they - # move around and the spreadsheet is edited. For example, if developer - # metadata is associated with row 5 and another row is then subsequently - # inserted above row 5, that original metadata will still be associated with - # the row it was first associated with (what is now row 6). If the associated - # object is deleted its metadata is deleted too. + # Developer metadata may be used to associate arbitrary data with various parts + # of a spreadsheet and will remain associated at those locations as they move + # around and the spreadsheet is edited. For example, if developer metadata is + # associated with row 5 and another row is then subsequently inserted above row + # 5, that original metadata will still be associated with the row it was first + # associated with (what is now row 6). If the associated object is deleted its + # metadata is deleted too. # Corresponds to the JSON property `developerMetadata` # @return [Google::Apis::SheetsV4::DeveloperMetadata] attr_accessor :developer_metadata @@ -4014,13 +3107,13 @@ module Google include Google::Apis::Core::Hashable # Developer metadata associated with a location or object in a spreadsheet. - # Developer metadata may be used to associate arbitrary data with various - # parts of a spreadsheet and will remain associated at those locations as they - # move around and the spreadsheet is edited. For example, if developer - # metadata is associated with row 5 and another row is then subsequently - # inserted above row 5, that original metadata will still be associated with - # the row it was first associated with (what is now row 6). If the associated - # object is deleted its metadata is deleted too. + # Developer metadata may be used to associate arbitrary data with various parts + # of a spreadsheet and will remain associated at those locations as they move + # around and the spreadsheet is edited. For example, if developer metadata is + # associated with row 5 and another row is then subsequently inserted above row + # 5, that original metadata will still be associated with the row it was first + # associated with (what is now row 6). If the associated object is deleted its + # metadata is deleted too. # Corresponds to the JSON property `developerMetadata` # @return [Google::Apis::SheetsV4::DeveloperMetadata] attr_accessor :developer_metadata @@ -4039,40 +3132,30 @@ module Google class CutPasteRequest include Google::Apis::Core::Hashable - # A coordinate in a sheet. - # All indexes are zero-based. + # A coordinate in a sheet. All indexes are zero-based. # Corresponds to the JSON property `destination` # @return [Google::Apis::SheetsV4::GridCoordinate] attr_accessor :destination - # What kind of data to paste. All the source data will be cut, regardless - # of what is pasted. + # What kind of data to paste. All the source data will be cut, regardless of + # what is pasted. # Corresponds to the JSON property `pasteType` # @return [String] attr_accessor :paste_type - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `source` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :source @@ -4089,8 +3172,7 @@ module Google end end - # Filter that describes what data should be selected or returned from a - # request. + # Filter that describes what data should be selected or returned from a request. class DataFilter include Google::Apis::Core::Hashable @@ -4099,41 +3181,32 @@ module Google # @return [String] attr_accessor :a1_range - # Selects DeveloperMetadata that matches all of the specified fields. For + # Selects DeveloperMetadata that matches all of the specified fields. For # example, if only a metadata ID is specified this considers the # DeveloperMetadata with that particular unique ID. If a metadata key is - # specified, this considers all developer metadata with that key. If a - # key, visibility, and location type are all specified, this considers all - # developer metadata with that key and visibility that are associated with a - # location of that type. In general, this - # selects all DeveloperMetadata that matches the intersection of all the - # specified fields; any field or combination of fields may be specified. + # specified, this considers all developer metadata with that key. If a key, + # visibility, and location type are all specified, this considers all developer + # metadata with that key and visibility that are associated with a location of + # that type. In general, this selects all DeveloperMetadata that matches the + # intersection of all the specified fields; any field or combination of fields + # may be specified. # Corresponds to the JSON property `developerMetadataLookup` # @return [Google::Apis::SheetsV4::DeveloperMetadataLookup] attr_accessor :developer_metadata_lookup - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `gridRange` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :grid_range @@ -4154,8 +3227,7 @@ module Google class DataFilterValueRange include Google::Apis::Core::Hashable - # Filter that describes what data should be selected or returned from a - # request. + # Filter that describes what data should be selected or returned from a request. # Corresponds to the JSON property `dataFilter` # @return [Google::Apis::SheetsV4::DataFilter] attr_accessor :data_filter @@ -4165,10 +3237,10 @@ module Google # @return [String] attr_accessor :major_dimension - # The data to be written. If the provided values exceed any of the ranges - # matched by the data filter then the request fails. If the provided values - # are less than the matched ranges only the specified values are written, - # existing values in the matched ranges remain unaffected. + # The data to be written. If the provided values exceed any of the ranges + # matched by the data filter then the request fails. If the provided values are + # less than the matched ranges only the specified values are written, existing + # values in the matched ranges remain unaffected. # Corresponds to the JSON property `values` # @return [Array>] attr_accessor :values @@ -4189,9 +3261,8 @@ module Google class DataValidationRule include Google::Apis::Core::Hashable - # A condition that can evaluate to true or false. - # BooleanConditions are used by conditional formatting, - # data validation, and the criteria in filters. + # A condition that can evaluate to true or false. BooleanConditions are used by + # conditional formatting, data validation, and the criteria in filters. # Corresponds to the JSON property `condition` # @return [Google::Apis::SheetsV4::BooleanCondition] attr_accessor :condition @@ -4201,8 +3272,8 @@ module Google # @return [String] attr_accessor :input_message - # True if the UI should be customized based on the kind of condition. - # If true, "List" conditions will show a dropdown. + # True if the UI should be customized based on the kind of condition. If true, " + # List" conditions will show a dropdown. # Corresponds to the JSON property `showCustomUi` # @return [Boolean] attr_accessor :show_custom_ui @@ -4229,25 +3300,14 @@ module Google # Allows you to organize the date-time values in a source data column into # buckets based on selected parts of their date or time values. For example, - # consider a pivot table showing sales transactions by date: - # +----------+--------------+ - # | Date | SUM of Sales | - # +----------+--------------+ - # | 1/1/2017 | $621.14 | - # | 2/3/2017 | $708.84 | - # | 5/8/2017 | $326.84 | - # ... - # +----------+--------------+ - # Applying a date-time group rule with a DateTimeRuleType of YEAR_MONTH - # results in the following pivot table. - # +--------------+--------------+ - # | Grouped Date | SUM of Sales | - # +--------------+--------------+ - # | 2017-Jan | $53,731.78 | - # | 2017-Feb | $83,475.32 | - # | 2017-Mar | $94,385.05 | - # ... - # +--------------+--------------+ + # consider a pivot table showing sales transactions by date: +----------+-------- + # ------+ | Date | SUM of Sales | +----------+--------------+ | 1/1/2017 | $621. + # 14 | | 2/3/2017 | $708.84 | | 5/8/2017 | $326.84 | ... +----------+------------ + # --+ Applying a date-time group rule with a DateTimeRuleType of YEAR_MONTH + # results in the following pivot table. +--------------+--------------+ | + # Grouped Date | SUM of Sales | +--------------+--------------+ | 2017-Jan | $53, + # 731.78 | | 2017-Feb | $83,475.32 | | 2017-Mar | $94,385.05 | ... +------------- + # -+--------------+ class DateTimeRule include Google::Apis::Core::Hashable @@ -4285,8 +3345,8 @@ module Google end end - # Deletes a conditional format rule at the given index. - # All subsequent rules' indexes are decremented. + # Deletes a conditional format rule at the given index. All subsequent rules' + # indexes are decremented. class DeleteConditionalFormatRuleRequest include Google::Apis::Core::Hashable @@ -4334,8 +3394,7 @@ module Google class DeleteDeveloperMetadataRequest include Google::Apis::Core::Hashable - # Filter that describes what data should be selected or returned from a - # request. + # Filter that describes what data should be selected or returned from a request. # Corresponds to the JSON property `dataFilter` # @return [Google::Apis::SheetsV4::DataFilter] attr_accessor :data_filter @@ -4370,18 +3429,15 @@ module Google end # Deletes a group over the specified range by decrementing the depth of the - # dimensions in the range. - # For example, assume the sheet has a depth-1 group over B:E and a depth-2 - # group over C:D. Deleting a group over D:E leaves the sheet with a - # depth-1 group over B:D and a depth-2 group over C:C. + # dimensions in the range. For example, assume the sheet has a depth-1 group + # over B:E and a depth-2 group over C:D. Deleting a group over D:E leaves the + # sheet with a depth-1 group over B:D and a depth-2 group over C:C. class DeleteDimensionGroupRequest include Google::Apis::Core::Hashable - # A range along a single dimension on a sheet. - # All indexes are zero-based. - # Indexes are half open: the start index is inclusive - # and the end index is exclusive. - # Missing indexes indicate the range is unbounded on that side. + # A range along a single dimension on a sheet. All indexes are zero-based. + # Indexes are half open: the start index is inclusive and the end index is + # exclusive. Missing indexes indicate the range is unbounded on that side. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::DimensionRange] attr_accessor :range @@ -4419,11 +3475,9 @@ module Google class DeleteDimensionRequest include Google::Apis::Core::Hashable - # A range along a single dimension on a sheet. - # All indexes are zero-based. - # Indexes are half open: the start index is inclusive - # and the end index is exclusive. - # Missing indexes indicate the range is unbounded on that side. + # A range along a single dimension on a sheet. All indexes are zero-based. + # Indexes are half open: the start index is inclusive and the end index is + # exclusive. Missing indexes indicate the range is unbounded on that side. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::DimensionRange] attr_accessor :range @@ -4441,12 +3495,11 @@ module Google # Removes rows within this range that contain values in the specified columns # that are duplicates of values in any previous row. Rows with identical values # but different letter cases, formatting, or formulas are considered to be - # duplicates. - # This request also removes duplicate rows hidden from view (for example, due - # to a filter). When removing duplicates, the first instance of each duplicate - # row scanning from the top downwards is kept in the resulting range. Content - # outside of the specified range isn't removed, and rows considered duplicates - # do not have to be adjacent to each other in the range. + # duplicates. This request also removes duplicate rows hidden from view (for + # example, due to a filter). When removing duplicates, the first instance of + # each duplicate row scanning from the top downwards is kept in the resulting + # range. Content outside of the specified range isn't removed, and rows + # considered duplicates do not have to be adjacent to each other in the range. class DeleteDuplicatesRequest include Google::Apis::Core::Hashable @@ -4456,28 +3509,19 @@ module Google # @return [Array] attr_accessor :comparison_columns - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range @@ -4592,36 +3636,26 @@ module Google class DeleteRangeRequest include Google::Apis::Core::Hashable - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range - # The dimension from which deleted cells will be replaced with. - # If ROWS, existing cells will be shifted upward to - # replace the deleted cells. If COLUMNS, existing cells - # will be shifted left to replace the deleted cells. + # The dimension from which deleted cells will be replaced with. If ROWS, + # existing cells will be shifted upward to replace the deleted cells. If COLUMNS, + # existing cells will be shifted left to replace the deleted cells. # Corresponds to the JSON property `shiftDimension` # @return [String] attr_accessor :shift_dimension @@ -4657,13 +3691,13 @@ module Google end # Developer metadata associated with a location or object in a spreadsheet. - # Developer metadata may be used to associate arbitrary data with various - # parts of a spreadsheet and will remain associated at those locations as they - # move around and the spreadsheet is edited. For example, if developer - # metadata is associated with row 5 and another row is then subsequently - # inserted above row 5, that original metadata will still be associated with - # the row it was first associated with (what is now row 6). If the associated - # object is deleted its metadata is deleted too. + # Developer metadata may be used to associate arbitrary data with various parts + # of a spreadsheet and will remain associated at those locations as they move + # around and the spreadsheet is edited. For example, if developer metadata is + # associated with row 5 and another row is then subsequently inserted above row + # 5, that original metadata will still be associated with the row it was first + # associated with (what is now row 6). If the associated object is deleted its + # metadata is deleted too. class DeveloperMetadata include Google::Apis::Core::Hashable @@ -4673,14 +3707,14 @@ module Google attr_accessor :location # The spreadsheet-scoped unique ID that identifies the metadata. IDs may be - # specified when metadata is created, otherwise one will be randomly - # generated and assigned. Must be positive. + # specified when metadata is created, otherwise one will be randomly generated + # and assigned. Must be positive. # Corresponds to the JSON property `metadataId` # @return [Fixnum] attr_accessor :metadata_id # The metadata key. There may be multiple metadata in a spreadsheet with the - # same key. Developer metadata must always have a key specified. + # same key. Developer metadata must always have a key specified. # Corresponds to the JSON property `metadataKey` # @return [String] attr_accessor :metadata_key @@ -4690,7 +3724,7 @@ module Google # @return [String] attr_accessor :metadata_value - # The metadata visibility. Developer metadata must always have a visibility + # The metadata visibility. Developer metadata must always have a visibility # specified. # Corresponds to the JSON property `visibility` # @return [String] @@ -4714,16 +3748,14 @@ module Google class DeveloperMetadataLocation include Google::Apis::Core::Hashable - # A range along a single dimension on a sheet. - # All indexes are zero-based. - # Indexes are half open: the start index is inclusive - # and the end index is exclusive. - # Missing indexes indicate the range is unbounded on that side. + # A range along a single dimension on a sheet. All indexes are zero-based. + # Indexes are half open: the start index is inclusive and the end index is + # exclusive. Missing indexes indicate the range is unbounded on that side. # Corresponds to the JSON property `dimensionRange` # @return [Google::Apis::SheetsV4::DimensionRange] attr_accessor :dimension_range - # The type of location this object represents. This field is read-only. + # The type of location this object represents. This field is read-only. # Corresponds to the JSON property `locationType` # @return [String] attr_accessor :location_type @@ -4752,43 +3784,38 @@ module Google end end - # Selects DeveloperMetadata that matches all of the specified fields. For + # Selects DeveloperMetadata that matches all of the specified fields. For # example, if only a metadata ID is specified this considers the # DeveloperMetadata with that particular unique ID. If a metadata key is - # specified, this considers all developer metadata with that key. If a - # key, visibility, and location type are all specified, this considers all - # developer metadata with that key and visibility that are associated with a - # location of that type. In general, this - # selects all DeveloperMetadata that matches the intersection of all the - # specified fields; any field or combination of fields may be specified. + # specified, this considers all developer metadata with that key. If a key, + # visibility, and location type are all specified, this considers all developer + # metadata with that key and visibility that are associated with a location of + # that type. In general, this selects all DeveloperMetadata that matches the + # intersection of all the specified fields; any field or combination of fields + # may be specified. class DeveloperMetadataLookup include Google::Apis::Core::Hashable - # Determines how this lookup matches the location. If this field is - # specified as EXACT, only developer metadata associated on the exact - # location specified is matched. If this field is specified to INTERSECTING, - # developer metadata associated on intersecting locations is also - # matched. If left unspecified, this field assumes a default value of - # INTERSECTING. - # If this field is specified, a metadataLocation - # must also be specified. + # Determines how this lookup matches the location. If this field is specified as + # EXACT, only developer metadata associated on the exact location specified is + # matched. If this field is specified to INTERSECTING, developer metadata + # associated on intersecting locations is also matched. If left unspecified, + # this field assumes a default value of INTERSECTING. If this field is specified, + # a metadataLocation must also be specified. # Corresponds to the JSON property `locationMatchingStrategy` # @return [String] attr_accessor :location_matching_strategy - # Limits the selected developer metadata to those entries which are - # associated with locations of the specified type. For example, when this - # field is specified as ROW this lookup - # only considers developer metadata associated on rows. If the field is left - # unspecified, all location types are considered. This field cannot be - # specified as SPREADSHEET when - # the locationMatchingStrategy - # is specified as INTERSECTING or when the - # metadataLocation is specified as a - # non-spreadsheet location: spreadsheet metadata cannot intersect any other - # developer metadata location. This field also must be left unspecified when - # the locationMatchingStrategy - # is specified as EXACT. + # Limits the selected developer metadata to those entries which are associated + # with locations of the specified type. For example, when this field is + # specified as ROW this lookup only considers developer metadata associated on + # rows. If the field is left unspecified, all location types are considered. + # This field cannot be specified as SPREADSHEET when the + # locationMatchingStrategy is specified as INTERSECTING or when the + # metadataLocation is specified as a non-spreadsheet location: spreadsheet + # metadata cannot intersect any other developer metadata location. This field + # also must be left unspecified when the locationMatchingStrategy is specified + # as EXACT. # Corresponds to the JSON property `locationType` # @return [String] attr_accessor :location_type @@ -4817,8 +3844,8 @@ module Google attr_accessor :metadata_value # Limits the selected developer metadata to that which has a matching - # DeveloperMetadata.visibility. If left unspecified, all developer - # metadata visibile to the requesting project is considered. + # DeveloperMetadata.visibility. If left unspecified, all developer metadata + # visibile to the requesting project is considered. # Corresponds to the JSON property `visibility` # @return [String] attr_accessor :visibility @@ -4846,28 +3873,25 @@ module Google include Google::Apis::Core::Hashable # This field is true if this group is collapsed. A collapsed group remains - # collapsed if an overlapping group at a shallower depth is expanded. - # A true value does not imply that all dimensions within the group are - # hidden, since a dimension's visibility can change independently from this - # group property. However, when this property is updated, all dimensions - # within it are set to hidden if this field is true, or set to visible if - # this field is false. + # collapsed if an overlapping group at a shallower depth is expanded. A true + # value does not imply that all dimensions within the group are hidden, since a + # dimension's visibility can change independently from this group property. + # However, when this property is updated, all dimensions within it are set to + # hidden if this field is true, or set to visible if this field is false. # Corresponds to the JSON property `collapsed` # @return [Boolean] attr_accessor :collapsed alias_method :collapsed?, :collapsed - # The depth of the group, representing how many groups have a range that - # wholly contains the range of this group. + # The depth of the group, representing how many groups have a range that wholly + # contains the range of this group. # Corresponds to the JSON property `depth` # @return [Fixnum] attr_accessor :depth - # A range along a single dimension on a sheet. - # All indexes are zero-based. - # Indexes are half open: the start index is inclusive - # and the end index is exclusive. - # Missing indexes indicate the range is unbounded on that side. + # A range along a single dimension on a sheet. All indexes are zero-based. + # Indexes are half open: the start index is inclusive and the end index is + # exclusive. Missing indexes indicate the range is unbounded on that side. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::DimensionRange] attr_accessor :range @@ -4893,8 +3917,7 @@ module Google # @return [Array] attr_accessor :developer_metadata - # True if this dimension is being filtered. - # This field is read-only. + # True if this dimension is being filtered. This field is read-only. # Corresponds to the JSON property `hiddenByFilter` # @return [Boolean] attr_accessor :hidden_by_filter @@ -4924,11 +3947,9 @@ module Google end end - # A range along a single dimension on a sheet. - # All indexes are zero-based. - # Indexes are half open: the start index is inclusive - # and the end index is exclusive. - # Missing indexes indicate the range is unbounded on that side. + # A range along a single dimension on a sheet. All indexes are zero-based. + # Indexes are half open: the start index is inclusive and the end index is + # exclusive. Missing indexes indicate the range is unbounded on that side. class DimensionRange include Google::Apis::Core::Hashable @@ -5007,20 +4028,19 @@ module Google class DuplicateSheetRequest include Google::Apis::Core::Hashable - # The zero-based index where the new sheet should be inserted. - # The index of all sheets after this are incremented. + # The zero-based index where the new sheet should be inserted. The index of all + # sheets after this are incremented. # Corresponds to the JSON property `insertSheetIndex` # @return [Fixnum] attr_accessor :insert_sheet_index - # If set, the ID of the new sheet. If not set, an ID is chosen. - # If set, the ID must not conflict with any existing sheet ID. - # If set, it must be non-negative. + # If set, the ID of the new sheet. If not set, an ID is chosen. If set, the ID + # must not conflict with any existing sheet ID. If set, it must be non-negative. # Corresponds to the JSON property `newSheetId` # @return [Fixnum] attr_accessor :new_sheet_id - # The name of the new sheet. If empty, a new name is chosen for you. + # The name of the new sheet. If empty, a new name is chosen for you. # Corresponds to the JSON property `newSheetName` # @return [String] attr_accessor :new_sheet_name @@ -5066,8 +4086,8 @@ module Google class Editors include Google::Apis::Core::Hashable - # True if anyone in the document's domain has edit access to the protected - # range. Domain protection is only supported on documents within a domain. + # True if anyone in the document's domain has edit access to the protected range. + # Domain protection is only supported on documents within a domain. # Corresponds to the JSON property `domainUsersCanEdit` # @return [Boolean] attr_accessor :domain_users_can_edit @@ -5130,8 +4150,8 @@ module Google class EmbeddedObjectPosition include Google::Apis::Core::Hashable - # If true, the embedded object is put on a new sheet whose ID - # is chosen for you. Used only when writing. + # If true, the embedded object is put on a new sheet whose ID is chosen for you. + # Used only when writing. # Corresponds to the JSON property `newSheet` # @return [Boolean] attr_accessor :new_sheet @@ -5142,8 +4162,8 @@ module Google # @return [Google::Apis::SheetsV4::OverlayPosition] attr_accessor :overlay_position - # The sheet this is on. Set only if the embedded object - # is on its own sheet. Must be non-negative. + # The sheet this is on. Set only if the embedded object is on its own sheet. + # Must be non-negative. # Corresponds to the JSON property `sheetId` # @return [Fixnum] attr_accessor :sheet_id @@ -5164,8 +4184,7 @@ module Google class ErrorValue include Google::Apis::Core::Hashable - # A message with more information about the error - # (in the spreadsheet's locale). + # A message with more information about the error (in the spreadsheet's locale). # Corresponds to the JSON property `message` # @return [String] attr_accessor :message @@ -5206,17 +4225,15 @@ module Google # @return [String] attr_accessor :formula_value - # Represents a double value. - # Note: Dates, Times and DateTimes are represented as doubles in - # "serial number" format. + # Represents a double value. Note: Dates, Times and DateTimes are represented as + # doubles in "serial number" format. # Corresponds to the JSON property `numberValue` # @return [Float] attr_accessor :number_value - # Represents a string value. - # Leading single quotes are not included. For example, if the user typed - # `'123` into the UI, this would be represented as a `stringValue` of - # `"123"`. + # Represents a string value. Leading single quotes are not included. For example, + # if the user typed `'123` into the UI, this would be represented as a ` + # stringValue` of `"123"`. # Corresponds to the JSON property `stringValue` # @return [String] attr_accessor :string_value @@ -5239,9 +4256,8 @@ module Google class FilterCriteria include Google::Apis::Core::Hashable - # A condition that can evaluate to true or false. - # BooleanConditions are used by conditional formatting, - # data validation, and the criteria in filters. + # A condition that can evaluate to true or false. BooleanConditions are used by + # conditional formatting, data validation, and the criteria in filters. # Corresponds to the JSON property `condition` # @return [Google::Apis::SheetsV4::BooleanCondition] attr_accessor :condition @@ -5253,110 +4269,49 @@ 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(''); `; // ... # Corresponds to the JSON property `visibleBackgroundColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :visible_background_color @@ -5368,110 +4323,49 @@ 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(''); `; // ... # Corresponds to the JSON property `visibleForegroundColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :visible_foreground_color @@ -5500,9 +4394,8 @@ module Google class FilterView include Google::Apis::Core::Hashable - # The criteria for showing/hiding values per column. - # The map's key is the column index, and the value is the criteria for - # that column. + # The criteria for showing/hiding values per column. The map's key is the column + # index, and the value is the criteria for that column. # Corresponds to the JSON property `criteria` # @return [Hash] attr_accessor :criteria @@ -5512,41 +4405,31 @@ module Google # @return [Fixnum] attr_accessor :filter_view_id - # The named range this filter view is backed by, if any. - # When writing, only one of range or named_range_id - # may be set. + # The named range this filter view is backed by, if any. When writing, only one + # of range or named_range_id may be set. # Corresponds to the JSON property `namedRangeId` # @return [String] attr_accessor :named_range_id - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range - # The sort order per column. Later specifications are used when values - # are equal in the earlier specifications. + # The sort order per column. Later specifications are used when values are equal + # in the earlier specifications. # Corresponds to the JSON property `sortSpecs` # @return [Array] attr_accessor :sort_specs @@ -5586,8 +4469,8 @@ module Google # @return [String] attr_accessor :find - # True if the search should include cells with formulas. - # False to skip cells with formulas. + # True if the search should include cells with formulas. False to skip cells + # with formulas. # Corresponds to the JSON property `includeFormulas` # @return [Boolean] attr_accessor :include_formulas @@ -5605,28 +4488,19 @@ module Google attr_accessor :match_entire_cell alias_method :match_entire_cell?, :match_entire_cell - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range @@ -5636,14 +4510,13 @@ module Google # @return [String] attr_accessor :replacement - # True if the find value is a regex. - # The regular expression and replacement should follow Java regex rules - # at https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html. - # The replacement string is allowed to refer to capturing groups. - # For example, if one cell has the contents `"Google Sheets"` and another - # has `"Google Docs"`, then searching for `"o.* (.*)"` with a replacement of - # `"$1 Rocks"` would change the contents of the cells to - # `"GSheets Rocks"` and `"GDocs Rocks"` respectively. + # True if the find value is a regex. The regular expression and replacement + # should follow Java regex rules at https://docs.oracle.com/javase/8/docs/api/ + # java/util/regex/Pattern.html. The replacement string is allowed to refer to + # capturing groups. For example, if one cell has the contents `"Google Sheets"` + # and another has `"Google Docs"`, then searching for `"o.* (.*)"` with a + # replacement of `"$1 Rocks"` would change the contents of the cells to `" + # GSheets Rocks"` and `"GDocs Rocks"` respectively. # Corresponds to the JSON property `searchByRegex` # @return [Boolean] attr_accessor :search_by_regex @@ -5681,9 +4554,9 @@ module Google # @return [Fixnum] attr_accessor :formulas_changed - # The number of occurrences (possibly multiple within a cell) changed. - # For example, if replacing `"e"` with `"o"` in `"Google Sheets"`, this would - # be `"3"` because `"Google Sheets"` -> `"Googlo Shoots"`. + # The number of occurrences (possibly multiple within a cell) changed. For + # example, if replacing `"e"` with `"o"` in `"Google Sheets"`, this would be `"3" + # ` because `"Google Sheets"` -> `"Googlo Shoots"`. # Corresponds to the JSON property `occurrencesChanged` # @return [Fixnum] attr_accessor :occurrences_changed @@ -5721,14 +4594,13 @@ module Google class GetSpreadsheetByDataFilterRequest include Google::Apis::Core::Hashable - # The DataFilters used to select which ranges to retrieve from - # the spreadsheet. + # The DataFilters used to select which ranges to retrieve from the spreadsheet. # Corresponds to the JSON property `dataFilters` # @return [Array] attr_accessor :data_filters - # True if grid data should be returned. - # This parameter is ignored if a field mask was set in the request. + # True if grid data should be returned. This parameter is ignored if a field + # mask was set in the request. # Corresponds to the JSON property `includeGridData` # @return [Boolean] attr_accessor :include_grid_data @@ -5745,30 +4617,26 @@ module Google end end - # A rule that applies a gradient color scale format, based on - # the interpolation points listed. The format of a cell will vary - # based on its contents as compared to the values of the interpolation - # points. + # A rule that applies a gradient color scale format, based on the interpolation + # points listed. The format of a cell will vary based on its contents as + # compared to the values of the interpolation points. class GradientRule include Google::Apis::Core::Hashable - # A single interpolation point on a gradient conditional format. - # These pin the gradient color scale according to the color, - # type and value chosen. + # A single interpolation point on a gradient conditional format. These pin the + # gradient color scale according to the color, type and value chosen. # Corresponds to the JSON property `maxpoint` # @return [Google::Apis::SheetsV4::InterpolationPoint] attr_accessor :maxpoint - # A single interpolation point on a gradient conditional format. - # These pin the gradient color scale according to the color, - # type and value chosen. + # A single interpolation point on a gradient conditional format. These pin the + # gradient color scale according to the color, type and value chosen. # Corresponds to the JSON property `midpoint` # @return [Google::Apis::SheetsV4::InterpolationPoint] attr_accessor :midpoint - # A single interpolation point on a gradient conditional format. - # These pin the gradient color scale according to the color, - # type and value chosen. + # A single interpolation point on a gradient conditional format. These pin the + # gradient color scale according to the color, type and value chosen. # Corresponds to the JSON property `minpoint` # @return [Google::Apis::SheetsV4::InterpolationPoint] attr_accessor :minpoint @@ -5785,8 +4653,7 @@ module Google end end - # A coordinate in a sheet. - # All indexes are zero-based. + # A coordinate in a sheet. All indexes are zero-based. class GridCoordinate include Google::Apis::Core::Hashable @@ -5821,22 +4688,20 @@ module Google class GridData include Google::Apis::Core::Hashable - # Metadata about the requested columns in the grid, starting with the column - # in start_column. + # Metadata about the requested columns in the grid, starting with the column in + # start_column. # Corresponds to the JSON property `columnMetadata` # @return [Array] attr_accessor :column_metadata - # The data in the grid, one entry per row, - # starting with the row in startRow. - # The values in RowData will correspond to columns starting - # at start_column. + # The data in the grid, one entry per row, starting with the row in startRow. + # The values in RowData will correspond to columns starting at start_column. # Corresponds to the JSON property `rowData` # @return [Array] attr_accessor :row_data - # Metadata about the requested rows in the grid, starting with the row - # in start_row. + # Metadata about the requested rows in the grid, starting with the row in + # start_row. # Corresponds to the JSON property `rowMetadata` # @return [Array] attr_accessor :row_metadata @@ -5923,28 +4788,19 @@ module Google end end - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. class GridRange include Google::Apis::Core::Hashable @@ -5987,20 +4843,18 @@ module Google end end - # A histogram chart. - # A histogram chart groups data items into bins, displaying each bin as a - # column of stacked items. Histograms are used to display the distribution - # of a dataset. Each column of items represents a range into which those - # items fall. The number of bins can be chosen automatically or specified + # A histogram chart. A histogram chart groups data items into bins, displaying + # each bin as a column of stacked items. Histograms are used to display the + # distribution of a dataset. Each column of items represents a range into which + # those items fall. The number of bins can be chosen automatically or specified # explicitly. class HistogramChartSpec include Google::Apis::Core::Hashable - # By default the bucket size (the range of values stacked in a single - # column) is chosen automatically, but it may be overridden here. - # E.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc. - # Cannot be negative. - # This field is optional. + # By default the bucket size (the range of values stacked in a single column) is + # chosen automatically, but it may be overridden here. E.g., A bucket size of 1. + # 5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc. Cannot be negative. This + # field is optional. # Corresponds to the JSON property `bucketSize` # @return [Float] attr_accessor :bucket_size @@ -6010,19 +4864,18 @@ module Google # @return [String] attr_accessor :legend_position - # The outlier percentile is used to ensure that outliers do not adversely - # affect the calculation of bucket sizes. For example, setting an outlier - # percentile of 0.05 indicates that the top and bottom 5% of values when - # calculating buckets. The values are still included in the chart, they will - # be added to the first or last buckets instead of their own buckets. - # Must be between 0.0 and 0.5. + # The outlier percentile is used to ensure that outliers do not adversely affect + # the calculation of bucket sizes. For example, setting an outlier percentile of + # 0.05 indicates that the top and bottom 5% of values when calculating buckets. + # The values are still included in the chart, they will be added to the first or + # last buckets instead of their own buckets. Must be between 0.0 and 0.5. # Corresponds to the JSON property `outlierPercentile` # @return [Float] attr_accessor :outlier_percentile # The series for a histogram may be either a single series of values to be - # bucketed or multiple series, each of the same length, containing the name - # of the series followed by the values to be bucketed for that series. + # bucketed or multiple series, each of the same length, containing the name of + # the series followed by the values to be bucketed for that series. # Corresponds to the JSON property `series` # @return [Array] attr_accessor :series @@ -6048,44 +4901,28 @@ module Google end end - # Allows you to organize the numeric values in a source data column into - # buckets of a constant size. All values from HistogramRule.start to - # HistogramRule.end are placed into groups of size - # HistogramRule.interval. In addition, all values below - # HistogramRule.start are placed in one group, and all values above - # HistogramRule.end are placed in another. Only - # HistogramRule.interval is required, though if HistogramRule.start - # and HistogramRule.end are both provided, HistogramRule.start must - # be less than HistogramRule.end. For example, a pivot table showing - # average purchase amount by age that has 50+ rows: - # +-----+-------------------+ - # | Age | AVERAGE of Amount | - # +-----+-------------------+ - # | 16 | $27.13 | - # | 17 | $5.24 | - # | 18 | $20.15 | - # ... - # +-----+-------------------+ - # could be turned into a pivot table that looks like the one below by - # applying a histogram group rule with a HistogramRule.start of 25, - # an HistogramRule.interval of 20, and an HistogramRule.end - # of 65. - # +-------------+-------------------+ - # | Grouped Age | AVERAGE of Amount | - # +-------------+-------------------+ - # | < 25 | $19.34 | - # | 25-45 | $31.43 | - # | 45-65 | $35.87 | - # | > 65 | $27.55 | - # +-------------+-------------------+ - # | Grand Total | $29.12 | - # +-------------+-------------------+ + # Allows you to organize the numeric values in a source data column into buckets + # of a constant size. All values from HistogramRule.start to HistogramRule.end + # are placed into groups of size HistogramRule.interval. In addition, all values + # below HistogramRule.start are placed in one group, and all values above + # HistogramRule.end are placed in another. Only HistogramRule.interval is + # required, though if HistogramRule.start and HistogramRule.end are both + # provided, HistogramRule.start must be less than HistogramRule.end. For example, + # a pivot table showing average purchase amount by age that has 50+ rows: +----- + # +-------------------+ | Age | AVERAGE of Amount | +-----+-------------------+ | + # 16 | $27.13 | | 17 | $5.24 | | 18 | $20.15 | ... +-----+-------------------+ + # could be turned into a pivot table that looks like the one below by applying a + # histogram group rule with a HistogramRule.start of 25, an HistogramRule. + # interval of 20, and an HistogramRule.end of 65. +-------------+---------------- + # ---+ | Grouped Age | AVERAGE of Amount | +-------------+-------------------+ | + # < 25 | $19.34 | | 25-45 | $31.43 | | 45-65 | $35.87 | | > 65 | $27.55 | +------ + # -------+-------------------+ | Grand Total | $29.12 | +-------------+---------- + # ---------+ class HistogramRule include Google::Apis::Core::Hashable - # The maximum value at which items are placed into buckets - # of constant size. Values above end are lumped into a single bucket. - # This field is optional. + # The maximum value at which items are placed into buckets of constant size. + # Values above end are lumped into a single bucket. This field is optional. # Corresponds to the JSON property `end` # @return [Float] attr_accessor :end @@ -6095,9 +4932,8 @@ module Google # @return [Float] attr_accessor :interval - # The minimum value at which items are placed into buckets - # of constant size. Values below start are lumped into a single bucket. - # This field is optional. + # The minimum value at which items are placed into buckets of constant size. + # Values below start are lumped into a single bucket. This field is optional. # Corresponds to the JSON property `start` # @return [Float] attr_accessor :start @@ -6120,110 +4956,49 @@ 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(''); `; // ... # Corresponds to the JSON property `barColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :bar_color @@ -6254,27 +5029,23 @@ module Google class InsertDimensionRequest include Google::Apis::Core::Hashable - # Whether dimension properties should be extended from the dimensions - # before or after the newly inserted dimensions. - # True to inherit from the dimensions before (in which case the start - # index must be greater than 0), and false to inherit from the dimensions - # after. - # For example, if row index 0 has red background and row index 1 - # has a green background, then inserting 2 rows at index 1 can inherit - # either the green or red background. If `inheritFromBefore` is true, - # the two new rows will be red (because the row before the insertion point - # was red), whereas if `inheritFromBefore` is false, the two new rows will + # Whether dimension properties should be extended from the dimensions before or + # after the newly inserted dimensions. True to inherit from the dimensions + # before (in which case the start index must be greater than 0), and false to + # inherit from the dimensions after. For example, if row index 0 has red + # background and row index 1 has a green background, then inserting 2 rows at + # index 1 can inherit either the green or red background. If `inheritFromBefore` + # is true, the two new rows will be red (because the row before the insertion + # point was red), whereas if `inheritFromBefore` is false, the two new rows will # be green (because the row after the insertion point was green). # Corresponds to the JSON property `inheritFromBefore` # @return [Boolean] attr_accessor :inherit_from_before alias_method :inherit_from_before?, :inherit_from_before - # A range along a single dimension on a sheet. - # All indexes are zero-based. - # Indexes are half open: the start index is inclusive - # and the end index is exclusive. - # Missing indexes indicate the range is unbounded on that side. + # A range along a single dimension on a sheet. All indexes are zero-based. + # Indexes are half open: the start index is inclusive and the end index is + # exclusive. Missing indexes indicate the range is unbounded on that side. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::DimensionRange] attr_accessor :range @@ -6294,35 +5065,25 @@ module Google class InsertRangeRequest include Google::Apis::Core::Hashable - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range - # The dimension which will be shifted when inserting cells. - # If ROWS, existing cells will be shifted down. - # If COLUMNS, existing cells will be shifted right. + # The dimension which will be shifted when inserting cells. If ROWS, existing + # cells will be shifted down. If COLUMNS, existing cells will be shifted right. # Corresponds to the JSON property `shiftDimension` # @return [String] attr_accessor :shift_dimension @@ -6338,118 +5099,56 @@ module Google end end - # A single interpolation point on a gradient conditional format. - # These pin the gradient color scale according to the color, - # type and value chosen. + # A single interpolation point on a gradient conditional format. These pin the + # gradient color scale according to the color, type and value chosen. class InterpolationPoint 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::SheetsV4::Color] attr_accessor :color @@ -6464,9 +5163,8 @@ module Google # @return [String] attr_accessor :type - # The value this interpolation point uses. May be a formula. - # Unused if type is MIN or - # MAX. + # The value this interpolation point uses. May be a formula. Unused if type is + # MIN or MAX. # Corresponds to the JSON property `value` # @return [String] attr_accessor :value @@ -6489,8 +5187,8 @@ module Google class IterativeCalculationSettings include Google::Apis::Core::Hashable - # When iterative calculation is enabled and successive results differ by - # less than this threshold value, the calculation rounds stop. + # When iterative calculation is enabled and successive results differ by less + # than this threshold value, the calculation rounds stop. # Corresponds to the JSON property `convergenceThreshold` # @return [Float] attr_accessor :convergence_threshold @@ -6521,8 +5219,8 @@ module Google # @return [Google::Apis::SheetsV4::TextPosition] attr_accessor :position - # The format of a run of text in a cell. - # Absent values indicate that the field isn't specified. + # The format of a run of text in a cell. Absent values indicate that the field + # isn't specified. # Corresponds to the JSON property `textFormat` # @return [Google::Apis::SheetsV4::TextFormat] attr_accessor :text_format @@ -6565,33 +5263,21 @@ module Google # Allows you to manually organize the values in a source data column into # buckets with names of your choosing. For example, a pivot table that - # aggregates population by state: - # +-------+-------------------+ - # | State | SUM of Population | - # +-------+-------------------+ - # | AK | 0.7 | - # | AL | 4.8 | - # | AR | 2.9 | - # ... - # +-------+-------------------+ - # could be turned into a pivot table that aggregates population by time zone - # by providing a list of groups (for example, groupName = 'Central', - # items = ['AL', 'AR', 'IA', ...]) to a manual group rule. - # Note that a similar effect could be achieved by adding a time zone column - # to the source data and adjusting the pivot table. - # +-----------+-------------------+ - # | Time Zone | SUM of Population | - # +-----------+-------------------+ - # | Central | 106.3 | - # | Eastern | 151.9 | - # | Mountain | 17.4 | - # ... - # +-----------+-------------------+ + # aggregates population by state: +-------+-------------------+ | State | SUM of + # Population | +-------+-------------------+ | AK | 0.7 | | AL | 4.8 | | AR | 2. + # 9 | ... +-------+-------------------+ could be turned into a pivot table that + # aggregates population by time zone by providing a list of groups (for example, + # groupName = 'Central', items = ['AL', 'AR', 'IA', ...]) to a manual group rule. + # Note that a similar effect could be achieved by adding a time zone column to + # the source data and adjusting the pivot table. +-----------+------------------- + # + | Time Zone | SUM of Population | +-----------+-------------------+ | + # Central | 106.3 | | Eastern | 151.9 | | Mountain | 17.4 | ... +-----------+---- + # ---------------+ class ManualRule include Google::Apis::Core::Hashable - # The list of group names and the corresponding items from the source data - # that map to each group name. + # The list of group names and the corresponding items from the source data that + # map to each group name. # Corresponds to the JSON property `groups` # @return [Array] attr_accessor :groups @@ -6606,8 +5292,8 @@ module Google end end - # A group name and a list of items from the source data that should be placed - # in the group with this name. + # A group name and a list of items from the source data that should be placed in + # the group with this name. class ManualRuleGroup include Google::Apis::Core::Hashable @@ -6616,10 +5302,10 @@ module Google # @return [Google::Apis::SheetsV4::ExtendedValue] attr_accessor :group_name - # The items in the source data that should be placed into this group. Each - # item may be a string, number, or boolean. Items may appear in at most one - # group within a given ManualRule. Items that do not appear in any - # group will appear on their own. + # The items in the source data that should be placed into this group. Each item + # may be a string, number, or boolean. Items may appear in at most one group + # within a given ManualRule. Items that do not appear in any group will appear + # on their own. # Corresponds to the JSON property `items` # @return [Array] attr_accessor :items @@ -6646,13 +5332,13 @@ module Google attr_accessor :data_filters # Developer metadata associated with a location or object in a spreadsheet. - # Developer metadata may be used to associate arbitrary data with various - # parts of a spreadsheet and will remain associated at those locations as they - # move around and the spreadsheet is edited. For example, if developer - # metadata is associated with row 5 and another row is then subsequently - # inserted above row 5, that original metadata will still be associated with - # the row it was first associated with (what is now row 6). If the associated - # object is deleted its metadata is deleted too. + # Developer metadata may be used to associate arbitrary data with various parts + # of a spreadsheet and will remain associated at those locations as they move + # around and the spreadsheet is edited. For example, if developer metadata is + # associated with row 5 and another row is then subsequently inserted above row + # 5, that original metadata will still be associated with the row it was first + # associated with (what is now row 6). If the associated object is deleted its + # metadata is deleted too. # Corresponds to the JSON property `developerMetadata` # @return [Google::Apis::SheetsV4::DeveloperMetadata] attr_accessor :developer_metadata @@ -6672,8 +5358,7 @@ module Google class MatchedValueRange include Google::Apis::Core::Hashable - # The DataFilters from the request that matched the range of - # values. + # The DataFilters from the request that matched the range of values. # Corresponds to the JSON property `dataFilters` # @return [Array] attr_accessor :data_filters @@ -6703,28 +5388,19 @@ module Google # @return [String] attr_accessor :merge_type - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range @@ -6744,26 +5420,22 @@ module Google class MoveDimensionRequest include Google::Apis::Core::Hashable - # The zero-based start index of where to move the source data to, - # based on the coordinates *before* the source data is removed - # from the grid. Existing data will be shifted down or right - # (depending on the dimension) to make room for the moved dimensions. - # The source dimensions are removed from the grid, so the - # the data may end up in a different index than specified. - # For example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move - # `"1"` and `"2"` to between `"3"` and `"4"`, the source would be - # `ROWS [1..3)`,and the destination index would be `"4"` - # (the zero-based index of row 5). - # The end result would be `A1..A5` of `0, 3, 1, 2, 4`. + # The zero-based start index of where to move the source data to, based on the + # coordinates *before* the source data is removed from the grid. Existing data + # will be shifted down or right (depending on the dimension) to make room for + # the moved dimensions. The source dimensions are removed from the grid, so the + # the data may end up in a different index than specified. For example, given ` + # A1..A5` of `0, 1, 2, 3, 4` and wanting to move `"1"` and `"2"` to between `"3"` + # and `"4"`, the source would be `ROWS [1..3)`,and the destination index would + # be `"4"` (the zero-based index of row 5). The end result would be `A1..A5` of ` + # 0, 3, 1, 2, 4`. # Corresponds to the JSON property `destinationIndex` # @return [Fixnum] attr_accessor :destination_index - # A range along a single dimension on a sheet. - # All indexes are zero-based. - # Indexes are half open: the start index is inclusive - # and the end index is exclusive. - # Missing indexes indicate the range is unbounded on that side. + # A range along a single dimension on a sheet. All indexes are zero-based. + # Indexes are half open: the start index is inclusive and the end index is + # exclusive. Missing indexes indicate the range is unbounded on that side. # Corresponds to the JSON property `source` # @return [Google::Apis::SheetsV4::DimensionRange] attr_accessor :source @@ -6793,28 +5465,19 @@ module Google # @return [String] attr_accessor :named_range_id - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range @@ -6835,16 +5498,15 @@ module Google class NumberFormat include Google::Apis::Core::Hashable - # Pattern string used for formatting. If not set, a default pattern based on - # the user's locale will be used if necessary for the given type. - # See the [Date and Number Formats guide](/sheets/api/guides/formats) for - # more information about the supported patterns. + # Pattern string used for formatting. If not set, a default pattern based on the + # user's locale will be used if necessary for the given type. See the [Date and + # Number Formats guide](/sheets/api/guides/formats) for more information about + # the supported patterns. # Corresponds to the JSON property `pattern` # @return [String] attr_accessor :pattern - # The type of the number format. - # When writing, this field must be set. + # The type of the number format. When writing, this field must be set. # Corresponds to the JSON property `type` # @return [String] attr_accessor :type @@ -6860,16 +5522,14 @@ module Google end end - # An org chart. - # Org charts require a unique set of labels in labels and may - # optionally include parent_labels and tooltips. - # parent_labels contain, for each node, the label identifying the parent - # node. tooltips contain, for each node, an optional tooltip. - # For example, to describe an OrgChart with Alice as the CEO, Bob as the - # President (reporting to Alice) and Cathy as VP of Sales (also reporting to - # Alice), have labels contain "Alice", "Bob", "Cathy", - # parent_labels contain "", "Alice", "Alice" and tooltips contain - # "CEO", "President", "VP Sales". + # An org chart. Org charts require a unique set of labels in labels and may + # optionally include parent_labels and tooltips. parent_labels contain, for each + # node, the label identifying the parent node. tooltips contain, for each node, + # an optional tooltip. For example, to describe an OrgChart with Alice as the + # CEO, Bob as the President (reporting to Alice) and Cathy as VP of Sales (also + # reporting to Alice), have labels contain "Alice", "Bob", "Cathy", + # parent_labels contain "", "Alice", "Alice" and tooltips contain "CEO", " + # President", "VP Sales". class OrgChartSpec include Google::Apis::Core::Hashable @@ -6880,110 +5540,49 @@ 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(''); `; // ... # Corresponds to the JSON property `nodeColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :node_color @@ -7005,110 +5604,49 @@ 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(''); `; // ... # Corresponds to the JSON property `selectedNodeColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :selected_node_color @@ -7144,8 +5682,7 @@ module Google class OverlayPosition include Google::Apis::Core::Hashable - # A coordinate in a sheet. - # All indexes are zero-based. + # A coordinate in a sheet. All indexes are zero-based. # Corresponds to the JSON property `anchorCell` # @return [Google::Apis::SheetsV4::GridCoordinate] attr_accessor :anchor_cell @@ -7155,14 +5692,13 @@ module Google # @return [Fixnum] attr_accessor :height_pixels - # The horizontal offset, in pixels, that the object is offset - # from the anchor cell. + # The horizontal offset, in pixels, that the object is offset from the anchor + # cell. # Corresponds to the JSON property `offsetXPixels` # @return [Fixnum] attr_accessor :offset_x_pixels - # The vertical offset, in pixels, that the object is offset - # from the anchor cell. + # The vertical offset, in pixels, that the object is offset from the anchor cell. # Corresponds to the JSON property `offsetYPixels` # @return [Fixnum] attr_accessor :offset_y_pixels @@ -7186,8 +5722,8 @@ module Google end end - # The amount of padding around the cell, in pixels. - # When updating padding, every field must be specified. + # The amount of padding around the cell, in pixels. When updating padding, every + # field must be specified. class Padding include Google::Apis::Core::Hashable @@ -7228,8 +5764,7 @@ module Google class PasteDataRequest include Google::Apis::Core::Hashable - # A coordinate in a sheet. - # All indexes are zero-based. + # A coordinate in a sheet. All indexes are zero-based. # Corresponds to the JSON property `coordinate` # @return [Google::Apis::SheetsV4::GridCoordinate] attr_accessor :coordinate @@ -7269,7 +5804,7 @@ module Google end end - # A pie chart. + # A pie chart. class PieChartSpec include Google::Apis::Core::Hashable @@ -7317,7 +5852,7 @@ module Google class PivotFilterCriteria include Google::Apis::Core::Hashable - # Values that should be included. Values not listed here are excluded. + # Values that should be included. Values not listed here are excluded. # Corresponds to the JSON property `visibleValues` # @return [Array] attr_accessor :visible_values @@ -7336,50 +5871,37 @@ module Google class PivotGroup include Google::Apis::Core::Hashable - # An optional setting on a PivotGroup that defines buckets for the values - # in the source data column rather than breaking out each individual value. - # Only one PivotGroup with a group rule may be added for each column in - # the source data, though on any given column you may add both a - # PivotGroup that has a rule and a PivotGroup that does not. + # An optional setting on a PivotGroup that defines buckets for the values in the + # source data column rather than breaking out each individual value. Only one + # PivotGroup with a group rule may be added for each column in the source data, + # though on any given column you may add both a PivotGroup that has a rule and a + # PivotGroup that does not. # Corresponds to the JSON property `groupRule` # @return [Google::Apis::SheetsV4::PivotGroupRule] attr_accessor :group_rule # The labels to use for the row/column groups which can be customized. For - # example, in the following pivot table, the row label is `Region` (which - # could be renamed to `State`) and the column label is `Product` (which - # could be renamed `Item`). Pivot tables created before December 2017 do - # not have header labels. If you'd like to add header labels to an existing - # pivot table, please delete the existing pivot table and then create a new - # pivot table with same parameters. - # +--------------+---------+-------+ - # | SUM of Units | Product | | - # | Region | Pen | Paper | - # +--------------+---------+-------+ - # | New York | 345 | 98 | - # | Oregon | 234 | 123 | - # | Tennessee | 531 | 415 | - # +--------------+---------+-------+ - # | Grand Total | 1110 | 636 | - # +--------------+---------+-------+ + # example, in the following pivot table, the row label is `Region` (which could + # be renamed to `State`) and the column label is `Product` (which could be + # renamed `Item`). Pivot tables created before December 2017 do not have header + # labels. If you'd like to add header labels to an existing pivot table, please + # delete the existing pivot table and then create a new pivot table with same + # parameters. +--------------+---------+-------+ | SUM of Units | Product | | | + # Region | Pen | Paper | +--------------+---------+-------+ | New York | 345 | + # 98 | | Oregon | 234 | 123 | | Tennessee | 531 | 415 | +--------------+--------- + # +-------+ | Grand Total | 1110 | 636 | +--------------+---------+-------+ # Corresponds to the JSON property `label` # @return [String] attr_accessor :label - # True if the headings in this pivot group should be repeated. - # This is only valid for row groupings and is ignored by columns. - # By default, we minimize repitition of headings by not showing higher - # level headings where they are the same. For example, even though the - # third row below corresponds to "Q1 Mar", "Q1" is not shown because - # it is redundant with previous rows. Setting repeat_headings to true - # would cause "Q1" to be repeated for "Feb" and "Mar". - # +--------------+ - # | Q1 | Jan | - # | | Feb | - # | | Mar | - # +--------+-----+ - # | Q1 Total | - # +--------------+ + # True if the headings in this pivot group should be repeated. This is only + # valid for row groupings and is ignored by columns. By default, we minimize + # repitition of headings by not showing higher level headings where they are the + # same. For example, even though the third row below corresponds to "Q1 Mar", " + # Q1" is not shown because it is redundant with previous rows. Setting + # repeat_headings to true would cause "Q1" to be repeated for "Feb" and "Mar". +- + # -------------+ | Q1 | Jan | | | Feb | | | Mar | +--------+-----+ | Q1 Total | + + # --------------+ # Corresponds to the JSON property `repeatHeadings` # @return [Boolean] attr_accessor :repeat_headings @@ -7396,10 +5918,9 @@ module Google # @return [String] attr_accessor :sort_order - # The column offset of the source range that this grouping is based on. - # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` - # means this group refers to column `C`, whereas the offset `1` would - # refer to column `D`. + # The column offset of the source range that this grouping is based on. For + # example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this + # group refers to column `C`, whereas the offset `1` would refer to column `D`. # Corresponds to the JSON property `sourceColumnOffset` # @return [Fixnum] attr_accessor :source_column_offset @@ -7431,99 +5952,61 @@ module Google end end - # An optional setting on a PivotGroup that defines buckets for the values - # in the source data column rather than breaking out each individual value. - # Only one PivotGroup with a group rule may be added for each column in - # the source data, though on any given column you may add both a - # PivotGroup that has a rule and a PivotGroup that does not. + # An optional setting on a PivotGroup that defines buckets for the values in the + # source data column rather than breaking out each individual value. Only one + # PivotGroup with a group rule may be added for each column in the source data, + # though on any given column you may add both a PivotGroup that has a rule and a + # PivotGroup that does not. class PivotGroupRule include Google::Apis::Core::Hashable # Allows you to organize the date-time values in a source data column into # buckets based on selected parts of their date or time values. For example, - # consider a pivot table showing sales transactions by date: - # +----------+--------------+ - # | Date | SUM of Sales | - # +----------+--------------+ - # | 1/1/2017 | $621.14 | - # | 2/3/2017 | $708.84 | - # | 5/8/2017 | $326.84 | - # ... - # +----------+--------------+ - # Applying a date-time group rule with a DateTimeRuleType of YEAR_MONTH - # results in the following pivot table. - # +--------------+--------------+ - # | Grouped Date | SUM of Sales | - # +--------------+--------------+ - # | 2017-Jan | $53,731.78 | - # | 2017-Feb | $83,475.32 | - # | 2017-Mar | $94,385.05 | - # ... - # +--------------+--------------+ + # consider a pivot table showing sales transactions by date: +----------+-------- + # ------+ | Date | SUM of Sales | +----------+--------------+ | 1/1/2017 | $621. + # 14 | | 2/3/2017 | $708.84 | | 5/8/2017 | $326.84 | ... +----------+------------ + # --+ Applying a date-time group rule with a DateTimeRuleType of YEAR_MONTH + # results in the following pivot table. +--------------+--------------+ | + # Grouped Date | SUM of Sales | +--------------+--------------+ | 2017-Jan | $53, + # 731.78 | | 2017-Feb | $83,475.32 | | 2017-Mar | $94,385.05 | ... +------------- + # -+--------------+ # Corresponds to the JSON property `dateTimeRule` # @return [Google::Apis::SheetsV4::DateTimeRule] attr_accessor :date_time_rule - # Allows you to organize the numeric values in a source data column into - # buckets of a constant size. All values from HistogramRule.start to - # HistogramRule.end are placed into groups of size - # HistogramRule.interval. In addition, all values below - # HistogramRule.start are placed in one group, and all values above - # HistogramRule.end are placed in another. Only - # HistogramRule.interval is required, though if HistogramRule.start - # and HistogramRule.end are both provided, HistogramRule.start must - # be less than HistogramRule.end. For example, a pivot table showing - # average purchase amount by age that has 50+ rows: - # +-----+-------------------+ - # | Age | AVERAGE of Amount | - # +-----+-------------------+ - # | 16 | $27.13 | - # | 17 | $5.24 | - # | 18 | $20.15 | - # ... - # +-----+-------------------+ - # could be turned into a pivot table that looks like the one below by - # applying a histogram group rule with a HistogramRule.start of 25, - # an HistogramRule.interval of 20, and an HistogramRule.end - # of 65. - # +-------------+-------------------+ - # | Grouped Age | AVERAGE of Amount | - # +-------------+-------------------+ - # | < 25 | $19.34 | - # | 25-45 | $31.43 | - # | 45-65 | $35.87 | - # | > 65 | $27.55 | - # +-------------+-------------------+ - # | Grand Total | $29.12 | - # +-------------+-------------------+ + # Allows you to organize the numeric values in a source data column into buckets + # of a constant size. All values from HistogramRule.start to HistogramRule.end + # are placed into groups of size HistogramRule.interval. In addition, all values + # below HistogramRule.start are placed in one group, and all values above + # HistogramRule.end are placed in another. Only HistogramRule.interval is + # required, though if HistogramRule.start and HistogramRule.end are both + # provided, HistogramRule.start must be less than HistogramRule.end. For example, + # a pivot table showing average purchase amount by age that has 50+ rows: +----- + # +-------------------+ | Age | AVERAGE of Amount | +-----+-------------------+ | + # 16 | $27.13 | | 17 | $5.24 | | 18 | $20.15 | ... +-----+-------------------+ + # could be turned into a pivot table that looks like the one below by applying a + # histogram group rule with a HistogramRule.start of 25, an HistogramRule. + # interval of 20, and an HistogramRule.end of 65. +-------------+---------------- + # ---+ | Grouped Age | AVERAGE of Amount | +-------------+-------------------+ | + # < 25 | $19.34 | | 25-45 | $31.43 | | 45-65 | $35.87 | | > 65 | $27.55 | +------ + # -------+-------------------+ | Grand Total | $29.12 | +-------------+---------- + # ---------+ # Corresponds to the JSON property `histogramRule` # @return [Google::Apis::SheetsV4::HistogramRule] attr_accessor :histogram_rule # Allows you to manually organize the values in a source data column into # buckets with names of your choosing. For example, a pivot table that - # aggregates population by state: - # +-------+-------------------+ - # | State | SUM of Population | - # +-------+-------------------+ - # | AK | 0.7 | - # | AL | 4.8 | - # | AR | 2.9 | - # ... - # +-------+-------------------+ - # could be turned into a pivot table that aggregates population by time zone - # by providing a list of groups (for example, groupName = 'Central', - # items = ['AL', 'AR', 'IA', ...]) to a manual group rule. - # Note that a similar effect could be achieved by adding a time zone column - # to the source data and adjusting the pivot table. - # +-----------+-------------------+ - # | Time Zone | SUM of Population | - # +-----------+-------------------+ - # | Central | 106.3 | - # | Eastern | 151.9 | - # | Mountain | 17.4 | - # ... - # +-----------+-------------------+ + # aggregates population by state: +-------+-------------------+ | State | SUM of + # Population | +-------+-------------------+ | AK | 0.7 | | AL | 4.8 | | AR | 2. + # 9 | ... +-------+-------------------+ could be turned into a pivot table that + # aggregates population by time zone by providing a list of groups (for example, + # groupName = 'Central', items = ['AL', 'AR', 'IA', ...]) to a manual group rule. + # Note that a similar effect could be achieved by adding a time zone column to + # the source data and adjusting the pivot table. +-----------+------------------- + # + | Time Zone | SUM of Population | +-----------+-------------------+ | + # Central | 106.3 | | Eastern | 151.9 | | Mountain | 17.4 | ... +-----------+---- + # ---------------+ # Corresponds to the JSON property `manualRule` # @return [Google::Apis::SheetsV4::ManualRule] attr_accessor :manual_rule @@ -7544,20 +6027,19 @@ module Google class PivotGroupSortValueBucket include Google::Apis::Core::Hashable - # Determines the bucket from which values are chosen to sort. - # For example, in a pivot table with one row group & two column groups, - # the row group can list up to two values. The first value corresponds - # to a value within the first column group, and the second value - # corresponds to a value in the second column group. If no values - # are listed, this would indicate that the row should be sorted according - # to the "Grand Total" over the column groups. If a single value is listed, - # this would correspond to using the "Total" of that bucket. + # Determines the bucket from which values are chosen to sort. For example, in a + # pivot table with one row group & two column groups, the row group can list up + # to two values. The first value corresponds to a value within the first column + # group, and the second value corresponds to a value in the second column group. + # If no values are listed, this would indicate that the row should be sorted + # according to the "Grand Total" over the column groups. If a single value is + # listed, this would correspond to using the "Total" of that bucket. # Corresponds to the JSON property `buckets` # @return [Array] attr_accessor :buckets - # The offset in the PivotTable.values list which the values in this - # grouping should be sorted by. + # The offset in the PivotTable.values list which the values in this grouping + # should be sorted by. # Corresponds to the JSON property `valuesIndex` # @return [Fixnum] attr_accessor :values_index @@ -7608,12 +6090,12 @@ module Google # @return [Array] attr_accessor :columns - # An optional mapping of filters per source column offset. - # The filters are applied before aggregating data into the pivot table. - # The map's key is the column offset of the source range that you want to - # filter, and the value is the criteria for that column. - # For example, if the source was `C10:E15`, a key of `0` will have the filter - # for column `C`, whereas the key `1` is for column `D`. + # An optional mapping of filters per source column offset. The filters are + # applied before aggregating data into the pivot table. The map's key is the + # column offset of the source range that you want to filter, and the value is + # the criteria for that column. For example, if the source was `C10:E15`, a key + # of `0` will have the filter for column `C`, whereas the key `1` is for column ` + # D`. # Corresponds to the JSON property `criteria` # @return [Hash] attr_accessor :criteria @@ -7623,34 +6105,25 @@ module Google # @return [Array] attr_accessor :rows - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `source` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :source - # Whether values should be listed horizontally (as columns) - # or vertically (as rows). + # Whether values should be listed horizontally (as columns) or vertically (as + # rows). # Corresponds to the JSON property `valueLayout` # @return [String] attr_accessor :value_layout @@ -7679,18 +6152,17 @@ module Google class PivotValue include Google::Apis::Core::Hashable - # If specified, indicates that pivot values should be displayed as - # the result of a calculation with another pivot value. For example, if - # calculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the - # pivot values are displayed as the percentage of the grand total. In - # the Sheets UI, this is referred to as "Show As" in the value section of a - # pivot table. + # If specified, indicates that pivot values should be displayed as the result of + # a calculation with another pivot value. For example, if + # calculated_display_type is specified as PERCENT_OF_GRAND_TOTAL, all the pivot + # values are displayed as the percentage of the grand total. In the Sheets UI, + # this is referred to as "Show As" in the value section of a pivot table. # Corresponds to the JSON property `calculatedDisplayType` # @return [String] attr_accessor :calculated_display_type - # A custom formula to calculate the value. The formula must start - # with an `=` character. + # A custom formula to calculate the value. The formula must start with an `=` + # character. # Corresponds to the JSON property `formula` # @return [String] attr_accessor :formula @@ -7700,20 +6172,16 @@ module Google # @return [String] attr_accessor :name - # The column offset of the source range that this value reads from. - # For example, if the source was `C10:E15`, a `sourceColumnOffset` of `0` - # means this value refers to column `C`, whereas the offset `1` would - # refer to column `D`. + # The column offset of the source range that this value reads from. For example, + # if the source was `C10:E15`, a `sourceColumnOffset` of `0` means this value + # refers to column `C`, whereas the offset `1` would refer to column `D`. # Corresponds to the JSON property `sourceColumnOffset` # @return [Fixnum] attr_accessor :source_column_offset - # A function to summarize the value. - # If formula is set, the only supported values are - # SUM and - # CUSTOM. - # If sourceColumnOffset is set, then `CUSTOM` - # is not supported. + # A function to summarize the value. If formula is set, the only supported + # values are SUM and CUSTOM. If sourceColumnOffset is set, then `CUSTOM` is not + # supported. # Corresponds to the JSON property `summarizeFunction` # @return [String] attr_accessor :summarize_function @@ -7746,67 +6214,54 @@ module Google # @return [Google::Apis::SheetsV4::Editors] attr_accessor :editors - # The named range this protected range is backed by, if any. - # When writing, only one of range or named_range_id - # may be set. + # The named range this protected range is backed by, if any. When writing, only + # one of range or named_range_id may be set. # Corresponds to the JSON property `namedRangeId` # @return [String] attr_accessor :named_range_id - # The ID of the protected range. - # This field is read-only. + # The ID of the protected range. This field is read-only. # Corresponds to the JSON property `protectedRangeId` # @return [Fixnum] attr_accessor :protected_range_id - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range - # True if the user who requested this protected range can edit the - # protected area. - # This field is read-only. + # True if the user who requested this protected range can edit the protected + # area. This field is read-only. # Corresponds to the JSON property `requestingUserCanEdit` # @return [Boolean] attr_accessor :requesting_user_can_edit alias_method :requesting_user_can_edit?, :requesting_user_can_edit - # The list of unprotected ranges within a protected sheet. - # Unprotected ranges are only supported on protected sheets. + # The list of unprotected ranges within a protected sheet. Unprotected ranges + # are only supported on protected sheets. # Corresponds to the JSON property `unprotectedRanges` # @return [Array] attr_accessor :unprotected_ranges - # True if this protected range will show a warning when editing. - # Warning-based protection means that every user can edit data in the - # protected range, except editing will prompt a warning asking the user - # to confirm the edit. - # When writing: if this field is true, then editors is ignored. - # Additionally, if this field is changed from true to false and the - # `editors` field is not set (nor included in the field mask), then - # the editors will be set to all the editors in the document. + # True if this protected range will show a warning when editing. Warning-based + # protection means that every user can edit data in the protected range, except + # editing will prompt a warning asking the user to confirm the edit. When + # writing: if this field is true, then editors is ignored. Additionally, if this + # field is changed from true to false and the `editors` field is not set (nor + # included in the field mask), then the editors will be set to all the editors + # in the document. # Corresponds to the JSON property `warningOnly` # @return [Boolean] attr_accessor :warning_only @@ -7833,28 +6288,19 @@ module Google class RandomizeRangeRequest include Google::Apis::Core::Hashable - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range @@ -7869,17 +6315,14 @@ module Google end end - # Updates all cells in the range to the values in the given Cell object. - # Only the fields listed in the fields field are updated; others are - # unchanged. - # If writing a cell with a formula, the formula's ranges will automatically - # increment for each field in the range. - # For example, if writing a cell with formula `=A1` into range B2:C4, - # B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`, - # C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. - # To keep the formula's ranges static, use the `$` indicator. - # For example, use the formula `=$A$1` to prevent both the row and the - # column from incrementing. + # Updates all cells in the range to the values in the given Cell object. Only + # the fields listed in the fields field are updated; others are unchanged. If + # writing a cell with a formula, the formula's ranges will automatically + # increment for each field in the range. For example, if writing a cell with + # formula `=A1` into range B2:C4, B2 would be `=A1`, B3 would be `=A2`, B4 would + # be `=A3`, C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. To keep the + # formula's ranges static, use the `$` indicator. For example, use the formula `= + # $A$1` to prevent both the row and the column from incrementing. class RepeatCellRequest include Google::Apis::Core::Hashable @@ -7888,35 +6331,26 @@ module Google # @return [Google::Apis::SheetsV4::CellData] attr_accessor :cell - # The fields that should be updated. At least one field must be specified. - # The root `cell` is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. + # The fields that should be updated. At least one field must be specified. The + # root `cell` is implied and should not be specified. A single `"*"` can be used + # as short-hand for listing every field. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range @@ -7947,24 +6381,22 @@ module Google # @return [Google::Apis::SheetsV4::AddChartRequest] attr_accessor :add_chart - # Adds a new conditional format rule at the given index. - # All subsequent rules' indexes are incremented. + # Adds a new conditional format rule at the given index. All subsequent rules' + # indexes are incremented. # Corresponds to the JSON property `addConditionalFormatRule` # @return [Google::Apis::SheetsV4::AddConditionalFormatRuleRequest] attr_accessor :add_conditional_format_rule - # Creates a group over the specified range. - # If the requested range is a superset of the range of an existing group G, - # then the depth of G is incremented and this new group G' has the - # depth of that group. For example, a group [C:D, depth 1] + [B:E] results in - # groups [B:E, depth 1] and [C:D, depth 2]. - # If the requested range is a subset of the range of an existing group G, - # then the depth of the new group G' becomes one greater than the depth of G. - # For example, a group [B:E, depth 1] + [C:D] results in groups [B:E, depth 1] - # and [C:D, depth 2]. - # If the requested range starts before and ends within, or starts within and - # ends after, the range of an existing group G, then the range of the existing - # group G becomes the union of the ranges, and the new group G' has + # Creates a group over the specified range. If the requested range is a superset + # of the range of an existing group G, then the depth of G is incremented and + # this new group G' has the depth of that group. For example, a group [C:D, + # depth 1] + [B:E] results in groups [B:E, depth 1] and [C:D, depth 2]. If the + # requested range is a subset of the range of an existing group G, then the + # depth of the new group G' becomes one greater than the depth of G. For example, + # a group [B:E, depth 1] + [C:D] results in groups [B:E, depth 1] and [C:D, + # depth 2]. If the requested range starts before and ends within, or starts + # within and ends after, the range of an existing group G, then the range of the + # existing group G becomes the union of the ranges, and the new group G' has # depth one greater than the depth of G and range as the intersection of the # ranges. For example, a group [B:D, depth 1] + [C:E] results in groups [B:E, # depth 1] and [C:D, depth 2]. @@ -7987,12 +6419,10 @@ module Google # @return [Google::Apis::SheetsV4::AddProtectedRangeRequest] attr_accessor :add_protected_range - # Adds a new sheet. - # When a sheet is added at a given index, - # all subsequent sheets' indexes are incremented. - # To add an object sheet, use AddChartRequest instead and specify - # EmbeddedObjectPosition.sheetId or - # EmbeddedObjectPosition.newSheet. + # Adds a new sheet. When a sheet is added at a given index, all subsequent + # sheets' indexes are incremented. To add an object sheet, use AddChartRequest + # instead and specify EmbeddedObjectPosition.sheetId or EmbeddedObjectPosition. + # newSheet. # Corresponds to the JSON property `addSheet` # @return [Google::Apis::SheetsV4::AddSheetRequest] attr_accessor :add_sheet @@ -8002,8 +6432,8 @@ module Google # @return [Google::Apis::SheetsV4::AddSlicerRequest] attr_accessor :add_slicer - # Adds new cells after the last row with data in a sheet, - # inserting new rows into the sheet if necessary. + # Adds new cells after the last row with data in a sheet, inserting new rows + # into the sheet if necessary. # Corresponds to the JSON property `appendCells` # @return [Google::Apis::SheetsV4::AppendCellsRequest] attr_accessor :append_cells @@ -8018,8 +6448,8 @@ module Google # @return [Google::Apis::SheetsV4::AutoFillRequest] attr_accessor :auto_fill - # Automatically resizes one or more dimensions based on the contents - # of the cells in that dimension. + # Automatically resizes one or more dimensions based on the contents of the + # cells in that dimension. # Corresponds to the JSON property `autoResizeDimensions` # @return [Google::Apis::SheetsV4::AutoResizeDimensionsRequest] attr_accessor :auto_resize_dimensions @@ -8049,8 +6479,8 @@ module Google # @return [Google::Apis::SheetsV4::DeleteBandingRequest] attr_accessor :delete_banding - # Deletes a conditional format rule at the given index. - # All subsequent rules' indexes are decremented. + # Deletes a conditional format rule at the given index. All subsequent rules' + # indexes are decremented. # Corresponds to the JSON property `deleteConditionalFormatRule` # @return [Google::Apis::SheetsV4::DeleteConditionalFormatRuleRequest] attr_accessor :delete_conditional_format_rule @@ -8066,10 +6496,9 @@ module Google attr_accessor :delete_dimension # Deletes a group over the specified range by decrementing the depth of the - # dimensions in the range. - # For example, assume the sheet has a depth-1 group over B:E and a depth-2 - # group over C:D. Deleting a group over D:E leaves the sheet with a - # depth-1 group over B:D and a depth-2 group over C:C. + # dimensions in the range. For example, assume the sheet has a depth-1 group + # over B:E and a depth-2 group over C:D. Deleting a group over D:E leaves the + # sheet with a depth-1 group over B:D and a depth-2 group over C:C. # Corresponds to the JSON property `deleteDimensionGroup` # @return [Google::Apis::SheetsV4::DeleteDimensionGroupRequest] attr_accessor :delete_dimension_group @@ -8077,12 +6506,11 @@ module Google # Removes rows within this range that contain values in the specified columns # that are duplicates of values in any previous row. Rows with identical values # but different letter cases, formatting, or formulas are considered to be - # duplicates. - # This request also removes duplicate rows hidden from view (for example, due - # to a filter). When removing duplicates, the first instance of each duplicate - # row scanning from the top downwards is kept in the resulting range. Content - # outside of the specified range isn't removed, and rows considered duplicates - # do not have to be adjacent to each other in the range. + # duplicates. This request also removes duplicate rows hidden from view (for + # example, due to a filter). When removing duplicates, the first instance of + # each duplicate row scanning from the top downwards is kept in the resulting + # range. Content outside of the specified range isn't removed, and rows + # considered duplicates do not have to be adjacent to each other in the range. # Corresponds to the JSON property `deleteDuplicates` # @return [Google::Apis::SheetsV4::DeleteDuplicatesRequest] attr_accessor :delete_duplicates @@ -8162,17 +6590,14 @@ module Google # @return [Google::Apis::SheetsV4::RandomizeRangeRequest] attr_accessor :randomize_range - # Updates all cells in the range to the values in the given Cell object. - # Only the fields listed in the fields field are updated; others are - # unchanged. - # If writing a cell with a formula, the formula's ranges will automatically - # increment for each field in the range. - # For example, if writing a cell with formula `=A1` into range B2:C4, - # B2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`, - # C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. - # To keep the formula's ranges static, use the `$` indicator. - # For example, use the formula `=$A$1` to prevent both the row and the - # column from incrementing. + # Updates all cells in the range to the values in the given Cell object. Only + # the fields listed in the fields field are updated; others are unchanged. If + # writing a cell with a formula, the formula's ranges will automatically + # increment for each field in the range. For example, if writing a cell with + # formula `=A1` into range B2:C4, B2 would be `=A1`, B3 would be `=A2`, B4 would + # be `=A3`, C2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`. To keep the + # formula's ranges static, use the `$` indicator. For example, use the formula `= + # $A$1` to prevent both the row and the column from incrementing. # Corresponds to the JSON property `repeatCell` # @return [Google::Apis::SheetsV4::RepeatCellRequest] attr_accessor :repeat_cell @@ -8182,8 +6607,8 @@ module Google # @return [Google::Apis::SheetsV4::SetBasicFilterRequest] attr_accessor :set_basic_filter - # Sets a data validation rule to every cell in the range. - # To clear validation in a range, call this with no rule specified. + # Sets a data validation rule to every cell in the range. To clear validation in + # a range, call this with no rule specified. # Corresponds to the JSON property `setDataValidation` # @return [Google::Apis::SheetsV4::SetDataValidationRequest] attr_accessor :set_data_validation @@ -8193,18 +6618,18 @@ module Google # @return [Google::Apis::SheetsV4::SortRangeRequest] attr_accessor :sort_range - # Splits a column of text into multiple columns, - # based on a delimiter in each cell. + # Splits a column of text into multiple columns, based on a delimiter in each + # cell. # Corresponds to the JSON property `textToColumns` # @return [Google::Apis::SheetsV4::TextToColumnsRequest] attr_accessor :text_to_columns - # Trims the whitespace (such as spaces, tabs, or new lines) in every cell in - # the specified range. This request removes all whitespace from the start and - # end of each cell's text, and reduces any subsequence of remaining whitespace + # Trims the whitespace (such as spaces, tabs, or new lines) in every cell in the + # specified range. This request removes all whitespace from the start and end of + # each cell's text, and reduces any subsequence of remaining whitespace # characters to a single space. If the resulting trimmed text starts with a '+' - # or '=' character, the text remains as a string value and isn't interpreted - # as a formula. + # or '=' character, the text remains as a string value and isn't interpreted as + # a formula. # Corresponds to the JSON property `trimWhitespace` # @return [Google::Apis::SheetsV4::TrimWhitespaceRequest] attr_accessor :trim_whitespace @@ -8219,15 +6644,12 @@ module Google # @return [Google::Apis::SheetsV4::UpdateBandingRequest] attr_accessor :update_banding - # Updates the borders of a range. - # If a field is not set in the request, that means the border remains as-is. - # For example, with two subsequent UpdateBordersRequest: - # 1. range: A1:A5 `` top: RED, bottom: WHITE `` - # 2. range: A1:A5 `` left: BLUE `` - # That would result in A1:A5 having a borders of - # `` top: RED, bottom: WHITE, left: BLUE ``. - # If you want to clear a border, explicitly set the style to - # NONE. + # Updates the borders of a range. If a field is not set in the request, that + # means the border remains as-is. For example, with two subsequent + # UpdateBordersRequest: 1. range: A1:A5 `` top: RED, bottom: WHITE `` 2. range: + # A1:A5 `` left: BLUE `` That would result in A1:A5 having a borders of `` top: + # RED, bottom: WHITE, left: BLUE ``. If you want to clear a border, explicitly + # set the style to NONE. # Corresponds to the JSON property `updateBorders` # @return [Google::Apis::SheetsV4::UpdateBordersRequest] attr_accessor :update_borders @@ -8237,25 +6659,23 @@ module Google # @return [Google::Apis::SheetsV4::UpdateCellsRequest] attr_accessor :update_cells - # Updates a chart's specifications. - # (This does not move or resize a chart. To move or resize a chart, use - # UpdateEmbeddedObjectPositionRequest.) + # Updates a chart's specifications. (This does not move or resize a chart. To + # move or resize a chart, use UpdateEmbeddedObjectPositionRequest.) # Corresponds to the JSON property `updateChartSpec` # @return [Google::Apis::SheetsV4::UpdateChartSpecRequest] attr_accessor :update_chart_spec - # Updates a conditional format rule at the given index, - # or moves a conditional format rule to another index. + # Updates a conditional format rule at the given index, or moves a conditional + # format rule to another index. # Corresponds to the JSON property `updateConditionalFormatRule` # @return [Google::Apis::SheetsV4::UpdateConditionalFormatRuleRequest] attr_accessor :update_conditional_format_rule - # A request to update properties of developer metadata. - # Updates the properties of the developer metadata selected by the filters to - # the values provided in the DeveloperMetadata resource. Callers must - # specify the properties they wish to update in the fields parameter, as well - # as specify at least one DataFilter matching the metadata they wish to - # update. + # A request to update properties of developer metadata. Updates the properties + # of the developer metadata selected by the filters to the values provided in + # the DeveloperMetadata resource. Callers must specify the properties they wish + # to update in the fields parameter, as well as specify at least one DataFilter + # matching the metadata they wish to update. # Corresponds to the JSON property `updateDeveloperMetadata` # @return [Google::Apis::SheetsV4::UpdateDeveloperMetadataRequest] attr_accessor :update_developer_metadata @@ -8270,8 +6690,8 @@ module Google # @return [Google::Apis::SheetsV4::UpdateDimensionPropertiesRequest] attr_accessor :update_dimension_properties - # Update an embedded object's position (such as a moving or resizing a - # chart or image). + # Update an embedded object's position (such as a moving or resizing a chart or + # image). # Corresponds to the JSON property `updateEmbeddedObjectPosition` # @return [Google::Apis::SheetsV4::UpdateEmbeddedObjectPositionRequest] attr_accessor :update_embedded_object_position @@ -8281,27 +6701,23 @@ module Google # @return [Google::Apis::SheetsV4::UpdateFilterViewRequest] attr_accessor :update_filter_view - # Updates properties of the named range with the specified - # namedRangeId. + # Updates properties of the named range with the specified namedRangeId. # Corresponds to the JSON property `updateNamedRange` # @return [Google::Apis::SheetsV4::UpdateNamedRangeRequest] attr_accessor :update_named_range - # Updates an existing protected range with the specified - # protectedRangeId. + # Updates an existing protected range with the specified protectedRangeId. # Corresponds to the JSON property `updateProtectedRange` # @return [Google::Apis::SheetsV4::UpdateProtectedRangeRequest] attr_accessor :update_protected_range - # Updates properties of the sheet with the specified - # sheetId. + # Updates properties of the sheet with the specified sheetId. # Corresponds to the JSON property `updateSheetProperties` # @return [Google::Apis::SheetsV4::UpdateSheetPropertiesRequest] attr_accessor :update_sheet_properties - # Updates a slicer's specifications. - # (This does not move or resize a slicer. To move or resize a slicer use - # UpdateEmbeddedObjectPositionRequest. + # Updates a slicer's specifications. (This does not move or resize a slicer. To + # move or resize a slicer use UpdateEmbeddedObjectPositionRequest. # Corresponds to the JSON property `updateSlicerSpec` # @return [Google::Apis::SheetsV4::UpdateSlicerSpecRequest] attr_accessor :update_slicer_spec @@ -8533,16 +6949,15 @@ module Google end # A scorecard chart. Scorecard charts are used to highlight key performance - # indicators, known as KPIs, on the spreadsheet. A scorecard chart can - # represent things like total sales, average cost, or a top selling item. You - # can specify a single data value, or aggregate over a range of data. - # Percentage or absolute difference from a baseline value can be highlighted, - # like changes over time. + # indicators, known as KPIs, on the spreadsheet. A scorecard chart can represent + # things like total sales, average cost, or a top selling item. You can specify + # a single data value, or aggregate over a range of data. Percentage or absolute + # difference from a baseline value can be highlighted, like changes over time. class ScorecardChartSpec include Google::Apis::Core::Hashable - # The aggregation type for key and baseline chart data in scorecard chart. - # This field is optional. + # The aggregation type for key and baseline chart data in scorecard chart. This + # field is optional. # Corresponds to the JSON property `aggregateType` # @return [String] attr_accessor :aggregate_type @@ -8572,15 +6987,13 @@ module Google # @return [Google::Apis::SheetsV4::KeyValueFormat] attr_accessor :key_value_format - # The number format source used in the scorecard chart. - # This field is optional. + # The number format source used in the scorecard chart. This field is optional. # Corresponds to the JSON property `numberFormatSource` # @return [String] attr_accessor :number_format_source - # Value to scale scorecard key and baseline value. For example, a factor of - # 10 can be used to divide all values in the chart by 10. - # This field is optional. + # Value to scale scorecard key and baseline value. For example, a factor of 10 + # can be used to divide all values in the chart by 10. This field is optional. # Corresponds to the JSON property `scaleFactor` # @return [Float] attr_accessor :scale_factor @@ -8608,7 +7021,7 @@ module Google include Google::Apis::Core::Hashable # The data filters describing the criteria used to determine which - # DeveloperMetadata entries to return. DeveloperMetadata matching any of the + # DeveloperMetadata entries to return. DeveloperMetadata matching any of the # specified filters are included in the response. # Corresponds to the JSON property `dataFilters` # @return [Array] @@ -8662,33 +7075,24 @@ module Google end end - # Sets a data validation rule to every cell in the range. - # To clear validation in a range, call this with no rule specified. + # Sets a data validation rule to every cell in the range. To clear validation in + # a range, call this with no rule specified. class SetDataValidationRequest include Google::Apis::Core::Hashable - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range @@ -8728,8 +7132,8 @@ module Google # @return [Array] attr_accessor :charts - # All column groups on this sheet, ordered by increasing range start index, - # then by group depth. + # All column groups on this sheet, ordered by increasing range start index, then + # by group depth. # Corresponds to the JSON property `columnGroups` # @return [Array] attr_accessor :column_groups @@ -8739,14 +7143,12 @@ module Google # @return [Array] attr_accessor :conditional_formats - # Data in the grid, if this is a grid sheet. - # The number of GridData objects returned is dependent on the number of - # ranges requested on this sheet. For example, if this is representing - # `Sheet1`, and the spreadsheet was requested with ranges - # `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a - # startRow/startColumn of `0`, - # while the second one will have `startRow 14` (zero-based row 15), - # and `startColumn 3` (zero-based column D). + # Data in the grid, if this is a grid sheet. The number of GridData objects + # returned is dependent on the number of ranges requested on this sheet. For + # example, if this is representing `Sheet1`, and the spreadsheet was requested + # with ranges `Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will + # have a startRow/startColumn of `0`, while the second one will have `startRow + # 14` (zero-based row 15), and `startColumn 3` (zero-based column D). # Corresponds to the JSON property `data` # @return [Array] attr_accessor :data @@ -8776,8 +7178,8 @@ module Google # @return [Array] attr_accessor :protected_ranges - # All row groups on this sheet, ordered by increasing range start index, then - # by group depth. + # All row groups on this sheet, ordered by increasing range start index, then by + # group depth. # Corresponds to the JSON property `rowGroups` # @return [Array] attr_accessor :row_groups @@ -8824,16 +7226,14 @@ module Google attr_accessor :hidden alias_method :hidden?, :hidden - # The index of the sheet within the spreadsheet. - # When adding or updating sheet properties, if this field - # is excluded then the sheet is added or moved to the end - # of the sheet list. When updating sheet indices or inserting - # sheets, movement is considered in "before the move" indexes. - # For example, if there were 3 sheets (S1, S2, S3) in order to - # move S1 ahead of S2 the index would have to be set to 2. A sheet - # index update request is ignored if the requested index is - # identical to the sheets current index or if the requested new - # index is equal to the current sheet index + 1. + # The index of the sheet within the spreadsheet. When adding or updating sheet + # properties, if this field is excluded then the sheet is added or moved to the + # end of the sheet list. When updating sheet indices or inserting sheets, + # movement is considered in "before the move" indexes. For example, if there + # were 3 sheets (S1, S2, S3) in order to move S1 ahead of S2 the index would + # have to be set to 2. A sheet index update request is ignored if the requested + # index is identical to the sheets current index or if the requested new index + # is equal to the current sheet index + 1. # Corresponds to the JSON property `index` # @return [Fixnum] attr_accessor :index @@ -8844,124 +7244,62 @@ module Google attr_accessor :right_to_left alias_method :right_to_left?, :right_to_left - # The ID of the sheet. Must be non-negative. - # This field cannot be changed once set. + # The ID of the sheet. Must be non-negative. This field cannot be changed once + # set. # Corresponds to the JSON property `sheetId` # @return [Fixnum] attr_accessor :sheet_id - # The type of sheet. Defaults to GRID. - # This field cannot be changed once set. + # The type of sheet. Defaults to GRID. This field cannot be changed once set. # Corresponds to the JSON property `sheetType` # @return [String] attr_accessor :sheet_type # 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 `tabColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :tab_color @@ -9029,8 +7367,7 @@ module Google class SlicerSpec include Google::Apis::Core::Hashable - # True if the filter should apply to pivot tables. - # If not set, default to `True`. + # True if the filter should apply to pivot tables. If not set, default to `True`. # Corresponds to the JSON property `applyToPivotTables` # @return [Boolean] attr_accessor :apply_to_pivot_tables @@ -9038,110 +7375,49 @@ 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(''); `; // ... # Corresponds to the JSON property `backgroundColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :background_color @@ -9156,28 +7432,19 @@ module Google # @return [Fixnum] attr_accessor :column_index - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `dataRange` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :data_range @@ -9187,14 +7454,14 @@ module Google # @return [Google::Apis::SheetsV4::FilterCriteria] attr_accessor :filter_criteria - # The horizontal alignment of title in the slicer. - # If unspecified, defaults to `LEFT` + # The horizontal alignment of title in the slicer. If unspecified, defaults to ` + # LEFT` # Corresponds to the JSON property `horizontalAlignment` # @return [String] attr_accessor :horizontal_alignment - # The format of a run of text in a cell. - # Absent values indicate that the field isn't specified. + # The format of a run of text in a cell. Absent values indicate that the field + # isn't specified. # Corresponds to the JSON property `textFormat` # @return [Google::Apis::SheetsV4::TextFormat] attr_accessor :text_format @@ -9226,34 +7493,25 @@ module Google class SortRangeRequest include Google::Apis::Core::Hashable - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range - # The sort order per column. Later specifications are used when values - # are equal in the earlier specifications. + # The sort order per column. Later specifications are used when values are equal + # in the earlier specifications. # Corresponds to the JSON property `sortSpecs` # @return [Array] attr_accessor :sort_specs @@ -9275,110 +7533,49 @@ 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(''); `; // ... # Corresponds to the JSON property `backgroundColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :background_color @@ -9395,110 +7592,49 @@ 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(''); `; // ... # Corresponds to the JSON property `foregroundColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :foreground_color @@ -9537,36 +7673,26 @@ module Google # @return [String] attr_accessor :dimension - # The number of rows or columns that data should be filled into. - # Positive numbers expand beyond the last row or last column - # of the source. Negative numbers expand before the first row - # or first column of the source. + # The number of rows or columns that data should be filled into. Positive + # numbers expand beyond the last row or last column of the source. Negative + # numbers expand before the first row or first column of the source. # Corresponds to the JSON property `fillLength` # @return [Fixnum] attr_accessor :fill_length - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `source` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :source @@ -9607,14 +7733,12 @@ module Google # @return [Array] attr_accessor :sheets - # The ID of the spreadsheet. - # This field is read-only. + # The ID of the spreadsheet. This field is read-only. # Corresponds to the JSON property `spreadsheetId` # @return [String] attr_accessor :spreadsheet_id - # The url of the spreadsheet. - # This field is read-only. + # The url of the spreadsheet. This field is read-only. # Corresponds to the JSON property `spreadsheetUrl` # @return [String] attr_accessor :spreadsheet_url @@ -9654,11 +7778,11 @@ module Google # @return [Google::Apis::SheetsV4::IterativeCalculationSettings] attr_accessor :iterative_calculation_settings - # The locale of the spreadsheet in one of the following formats: - # * an ISO 639-1 language code such as `en` - # * an ISO 639-2 language code such as `fil`, if no 639-1 code exists - # * a combination of the ISO language code and country code, such as `en_US` - # Note: when updating this field, not all locales/languages are supported. + # The locale of the spreadsheet in one of the following formats: * an ISO 639-1 + # language code such as `en` * an ISO 639-2 language code such as `fil`, if no + # 639-1 code exists * a combination of the ISO language code and country code, + # such as `en_US` Note: when updating this field, not all locales/languages are + # supported. # Corresponds to the JSON property `locale` # @return [String] attr_accessor :locale @@ -9668,9 +7792,9 @@ module Google # @return [Google::Apis::SheetsV4::SpreadsheetTheme] attr_accessor :spreadsheet_theme - # The time zone of the spreadsheet, in CLDR format such as - # `America/New_York`. If the time zone isn't recognized, this may - # be a custom time zone such as `GMT-07:00`. + # The time zone of the spreadsheet, in CLDR format such as `America/New_York`. + # If the time zone isn't recognized, this may be a custom time zone such as `GMT- + # 07:00`. # Corresponds to the JSON property `timeZone` # @return [String] attr_accessor :time_zone @@ -9705,8 +7829,8 @@ module Google # @return [String] attr_accessor :primary_font_family - # The spreadsheet theme color pairs. To update you must provide all theme - # color pairs. + # The spreadsheet theme color pairs. To update you must provide all theme color + # pairs. # Corresponds to the JSON property `themeColors` # @return [Array] attr_accessor :theme_colors @@ -9722,8 +7846,8 @@ module Google end end - # The format of a run of text in a cell. - # Absent values indicate that the field isn't specified. + # The format of a run of text in a cell. Absent values indicate that the field + # isn't specified. class TextFormat include Google::Apis::Core::Hashable @@ -9745,110 +7869,49 @@ 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(''); `; // ... # Corresponds to the JSON property `foregroundColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :foreground_color @@ -9893,14 +7956,13 @@ module Google end end - # A run of a text format. The format of this run continues until the start - # index of the next run. - # When updating, all fields must be set. + # A run of a text format. The format of this run continues until the start index + # of the next run. When updating, all fields must be set. class TextFormatRun include Google::Apis::Core::Hashable - # The format of a run of text in a cell. - # Absent values indicate that the field isn't specified. + # The format of a run of text in a cell. Absent values indicate that the field + # isn't specified. # Corresponds to the JSON property `format` # @return [Google::Apis::SheetsV4::TextFormat] attr_accessor :format @@ -9945,25 +8007,16 @@ module Google include Google::Apis::Core::Hashable # The angle between the standard orientation and the desired orientation. - # Measured in degrees. Valid values are between -90 and 90. Positive - # angles are angled upwards, negative are angled downwards. - # Note: For LTR text direction positive angles are in the - # counterclockwise direction, whereas for RTL they are in the clockwise - # direction + # Measured in degrees. Valid values are between -90 and 90. Positive angles are + # angled upwards, negative are angled downwards. Note: For LTR text direction + # positive angles are in the counterclockwise direction, whereas for RTL they + # are in the clockwise direction # Corresponds to the JSON property `angle` # @return [Fixnum] attr_accessor :angle # If true, text reads top to bottom, but the orientation of individual - # characters is unchanged. - # For example: - # | V | - # | e | - # | r | - # | t | - # | i | - # | c | - # | a | + # characters is unchanged. For example: | V | | e | | r | | t | | i | | c | | a | # | l | # Corresponds to the JSON property `vertical` # @return [Boolean] @@ -9981,13 +8034,12 @@ module Google end end - # Splits a column of text into multiple columns, - # based on a delimiter in each cell. + # Splits a column of text into multiple columns, based on a delimiter in each + # cell. class TextToColumnsRequest include Google::Apis::Core::Hashable - # The delimiter to use. Used only if delimiterType is - # CUSTOM. + # The delimiter to use. Used only if delimiterType is CUSTOM. # Corresponds to the JSON property `delimiter` # @return [String] attr_accessor :delimiter @@ -9997,28 +8049,19 @@ module Google # @return [String] attr_accessor :delimiter_type - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `source` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :source @@ -10067,110 +8110,49 @@ 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(''); `; // ... # Corresponds to the JSON property `maxValueColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :max_value_color @@ -10182,110 +8164,49 @@ 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(''); `; // ... # Corresponds to the JSON property `midValueColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :mid_value_color @@ -10297,110 +8218,49 @@ 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(''); `; // ... # Corresponds to the JSON property `minValueColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :min_value_color @@ -10412,110 +8272,49 @@ 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(''); `; // ... # Corresponds to the JSON property `noDataColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :no_data_color @@ -10542,7 +8341,7 @@ module Google end end - # A Treemap chart. + # A Treemap chart. class TreemapChartSpec include Google::Apis::Core::Hashable @@ -10558,110 +8357,49 @@ 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(''); `; // ... # Corresponds to the JSON property `headerColor` # @return [Google::Apis::SheetsV4::Color] attr_accessor :header_color @@ -10677,9 +8415,9 @@ module Google attr_accessor :hide_tooltips alias_method :hide_tooltips?, :hide_tooltips - # The number of additional data levels beyond the labeled levels to be shown - # on the treemap chart. These levels are not interactive and are shown - # without their labels. Defaults to 0 if not specified. + # The number of additional data levels beyond the labeled levels to be shown on + # the treemap chart. These levels are not interactive and are shown without + # their labels. Defaults to 0 if not specified. # Corresponds to the JSON property `hintedLevels` # @return [Fixnum] attr_accessor :hinted_levels @@ -10690,24 +8428,23 @@ module Google attr_accessor :labels # The number of data levels to show on the treemap chart. These levels are - # interactive and are shown with their labels. Defaults to 2 if not - # specified. + # interactive and are shown with their labels. Defaults to 2 if not specified. # Corresponds to the JSON property `levels` # @return [Fixnum] attr_accessor :levels - # The maximum possible data value. Cells with values greater than this will - # have the same color as cells with this value. If not specified, defaults - # to the actual maximum value from color_data, or the maximum value from - # size_data if color_data is not specified. + # The maximum possible data value. Cells with values greater than this will have + # the same color as cells with this value. If not specified, defaults to the + # actual maximum value from color_data, or the maximum value from size_data if + # color_data is not specified. # Corresponds to the JSON property `maxValue` # @return [Float] attr_accessor :max_value - # The minimum possible data value. Cells with values less than this will - # have the same color as cells with this value. If not specified, defaults - # to the actual minimum value from color_data, or the minimum value from - # size_data if color_data is not specified. + # The minimum possible data value. Cells with values less than this will have + # the same color as cells with this value. If not specified, defaults to the + # actual minimum value from color_data, or the minimum value from size_data if + # color_data is not specified. # Corresponds to the JSON property `minValue` # @return [Float] attr_accessor :min_value @@ -10722,8 +8459,8 @@ module Google # @return [Google::Apis::SheetsV4::ChartData] attr_accessor :size_data - # The format of a run of text in a cell. - # Absent values indicate that the field isn't specified. + # The format of a run of text in a cell. Absent values indicate that the field + # isn't specified. # Corresponds to the JSON property `textFormat` # @return [Google::Apis::SheetsV4::TextFormat] attr_accessor :text_format @@ -10750,37 +8487,28 @@ module Google end end - # Trims the whitespace (such as spaces, tabs, or new lines) in every cell in - # the specified range. This request removes all whitespace from the start and - # end of each cell's text, and reduces any subsequence of remaining whitespace + # Trims the whitespace (such as spaces, tabs, or new lines) in every cell in the + # specified range. This request removes all whitespace from the start and end of + # each cell's text, and reduces any subsequence of remaining whitespace # characters to a single space. If the resulting trimmed text starts with a '+' - # or '=' character, the text remains as a string value and isn't interpreted - # as a formula. + # or '=' character, the text remains as a string value and isn't interpreted as + # a formula. class TrimWhitespaceRequest include Google::Apis::Core::Hashable - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range @@ -10818,28 +8546,19 @@ module Google class UnmergeCellsRequest include Google::Apis::Core::Hashable - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range @@ -10863,9 +8582,9 @@ module Google # @return [Google::Apis::SheetsV4::BandedRange] attr_accessor :banded_range - # The fields that should be updated. At least one field must be specified. - # The root `bandedRange` is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. + # The fields that should be updated. At least one field must be specified. The + # root `bandedRange` is implied and should not be specified. A single `"*"` can + # be used as short-hand for listing every field. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -10881,15 +8600,12 @@ module Google end end - # Updates the borders of a range. - # If a field is not set in the request, that means the border remains as-is. - # For example, with two subsequent UpdateBordersRequest: - # 1. range: A1:A5 `` top: RED, bottom: WHITE `` - # 2. range: A1:A5 `` left: BLUE `` - # That would result in A1:A5 having a borders of - # `` top: RED, bottom: WHITE, left: BLUE ``. - # If you want to clear a border, explicitly set the style to - # NONE. + # Updates the borders of a range. If a field is not set in the request, that + # means the border remains as-is. For example, with two subsequent + # UpdateBordersRequest: 1. range: A1:A5 `` top: RED, bottom: WHITE `` 2. range: + # A1:A5 `` left: BLUE `` That would result in A1:A5 having a borders of `` top: + # RED, bottom: WHITE, left: BLUE ``. If you want to clear a border, explicitly + # set the style to NONE. class UpdateBordersRequest include Google::Apis::Core::Hashable @@ -10913,28 +8629,19 @@ module Google # @return [Google::Apis::SheetsV4::Border] attr_accessor :left - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range @@ -10969,36 +8676,26 @@ module Google class UpdateCellsRequest include Google::Apis::Core::Hashable - # The fields of CellData that should be updated. - # At least one field must be specified. - # The root is the CellData; 'row.values.' should not be specified. - # A single `"*"` can be used as short-hand for listing every field. + # The fields of CellData that should be updated. At least one field must be + # specified. The root is the CellData; 'row.values.' should not be specified. A + # single `"*"` can be used as short-hand for listing every field. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields - # A range on a sheet. - # All indexes are zero-based. - # Indexes are half open, i.e. the start index is inclusive - # and the end index is exclusive -- [start_index, end_index). - # Missing indexes indicate the range is unbounded on that side. - # For example, if `"Sheet1"` is sheet ID 0, then: - # `Sheet1!A1:A1 == sheet_id: 0, - # start_row_index: 0, end_row_index: 1, - # start_column_index: 0, end_column_index: 1` - # `Sheet1!A3:B4 == sheet_id: 0, - # start_row_index: 2, end_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A:B == sheet_id: 0, - # start_column_index: 0, end_column_index: 2` - # `Sheet1!A5:B == sheet_id: 0, - # start_row_index: 4, - # start_column_index: 0, end_column_index: 2` - # `Sheet1 == sheet_id:0` - # The start index must always be less than or equal to the end index. - # If the start index equals the end index, then the range is empty. - # Empty ranges are typically not meaningful and are usually rendered in the - # UI as `#REF!`. + # A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. + # the start index is inclusive and the end index is exclusive -- [start_index, + # end_index). Missing indexes indicate the range is unbounded on that side. For + # example, if `"Sheet1"` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, + # start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: + # 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, + # start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, + # start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, + # start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == + # sheet_id:0` The start index must always be less than or equal to the end index. + # If the start index equals the end index, then the range is empty. Empty + # ranges are typically not meaningful and are usually rendered in the UI as `# + # REF!`. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::GridRange] attr_accessor :range @@ -11008,8 +8705,7 @@ module Google # @return [Array] attr_accessor :rows - # A coordinate in a sheet. - # All indexes are zero-based. + # A coordinate in a sheet. All indexes are zero-based. # Corresponds to the JSON property `start` # @return [Google::Apis::SheetsV4::GridCoordinate] attr_accessor :start @@ -11027,9 +8723,8 @@ module Google end end - # Updates a chart's specifications. - # (This does not move or resize a chart. To move or resize a chart, use - # UpdateEmbeddedObjectPositionRequest.) + # Updates a chart's specifications. (This does not move or resize a chart. To + # move or resize a chart, use UpdateEmbeddedObjectPositionRequest.) class UpdateChartSpecRequest include Google::Apis::Core::Hashable @@ -11054,8 +8749,8 @@ module Google end end - # Updates a conditional format rule at the given index, - # or moves a conditional format rule to another index. + # Updates a conditional format rule at the given index, or moves a conditional + # format rule to another index. class UpdateConditionalFormatRuleRequest include Google::Apis::Core::Hashable @@ -11074,8 +8769,7 @@ module Google # @return [Google::Apis::SheetsV4::ConditionalFormatRule] attr_accessor :rule - # The sheet of the rule to move. Required if new_index is set, - # unused otherwise. + # The sheet of the rule to move. Required if new_index is set, unused otherwise. # Corresponds to the JSON property `sheetId` # @return [Fixnum] attr_accessor :sheet_id @@ -11107,8 +8801,8 @@ module Google # @return [Google::Apis::SheetsV4::ConditionalFormatRule] attr_accessor :new_rule - # The old index of the rule. Not set if a rule was replaced - # (because it is the same as new_index). + # The old index of the rule. Not set if a rule was replaced (because it is the + # same as new_index). # Corresponds to the JSON property `oldIndex` # @return [Fixnum] attr_accessor :old_index @@ -11131,12 +8825,11 @@ module Google end end - # A request to update properties of developer metadata. - # Updates the properties of the developer metadata selected by the filters to - # the values provided in the DeveloperMetadata resource. Callers must - # specify the properties they wish to update in the fields parameter, as well - # as specify at least one DataFilter matching the metadata they wish to - # update. + # A request to update properties of developer metadata. Updates the properties + # of the developer metadata selected by the filters to the values provided in + # the DeveloperMetadata resource. Callers must specify the properties they wish + # to update in the fields parameter, as well as specify at least one DataFilter + # matching the metadata they wish to update. class UpdateDeveloperMetadataRequest include Google::Apis::Core::Hashable @@ -11146,20 +8839,20 @@ module Google attr_accessor :data_filters # Developer metadata associated with a location or object in a spreadsheet. - # Developer metadata may be used to associate arbitrary data with various - # parts of a spreadsheet and will remain associated at those locations as they - # move around and the spreadsheet is edited. For example, if developer - # metadata is associated with row 5 and another row is then subsequently - # inserted above row 5, that original metadata will still be associated with - # the row it was first associated with (what is now row 6). If the associated - # object is deleted its metadata is deleted too. + # Developer metadata may be used to associate arbitrary data with various parts + # of a spreadsheet and will remain associated at those locations as they move + # around and the spreadsheet is edited. For example, if developer metadata is + # associated with row 5 and another row is then subsequently inserted above row + # 5, that original metadata will still be associated with the row it was first + # associated with (what is now row 6). If the associated object is deleted its + # metadata is deleted too. # Corresponds to the JSON property `developerMetadata` # @return [Google::Apis::SheetsV4::DeveloperMetadata] attr_accessor :developer_metadata - # The fields that should be updated. At least one field must be specified. - # The root `developerMetadata` is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. + # The fields that should be updated. At least one field must be specified. The + # root `developerMetadata` is implied and should not be specified. A single `"*"` + # can be used as short-hand for listing every field. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -11206,9 +8899,9 @@ module Google # @return [Google::Apis::SheetsV4::DimensionGroup] attr_accessor :dimension_group - # The fields that should be updated. At least one field must be specified. - # The root `dimensionGroup` is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. + # The fields that should be updated. At least one field must be specified. The + # root `dimensionGroup` is implied and should not be specified. A single `"*"` + # can be used as short-hand for listing every field. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -11228,9 +8921,9 @@ module Google class UpdateDimensionPropertiesRequest include Google::Apis::Core::Hashable - # The fields that should be updated. At least one field must be specified. - # The root `properties` is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. + # The fields that should be updated. At least one field must be specified. The + # root `properties` is implied and should not be specified. A single `"*"` can + # be used as short-hand for listing every field. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -11240,11 +8933,9 @@ module Google # @return [Google::Apis::SheetsV4::DimensionProperties] attr_accessor :properties - # A range along a single dimension on a sheet. - # All indexes are zero-based. - # Indexes are half open: the start index is inclusive - # and the end index is exclusive. - # Missing indexes indicate the range is unbounded on that side. + # A range along a single dimension on a sheet. All indexes are zero-based. + # Indexes are half open: the start index is inclusive and the end index is + # exclusive. Missing indexes indicate the range is unbounded on that side. # Corresponds to the JSON property `range` # @return [Google::Apis::SheetsV4::DimensionRange] attr_accessor :range @@ -11261,18 +8952,16 @@ module Google end end - # Update an embedded object's position (such as a moving or resizing a - # chart or image). + # Update an embedded object's position (such as a moving or resizing a chart or + # image). class UpdateEmbeddedObjectPositionRequest include Google::Apis::Core::Hashable - # The fields of OverlayPosition - # that should be updated when setting a new position. Used only if - # newPosition.overlayPosition - # is set, in which case at least one field must - # be specified. The root `newPosition.overlayPosition` is implied and - # should not be specified. - # A single `"*"` can be used as short-hand for listing every field. + # The fields of OverlayPosition that should be updated when setting a new + # position. Used only if newPosition.overlayPosition is set, in which case at + # least one field must be specified. The root `newPosition.overlayPosition` is + # implied and should not be specified. A single `"*"` can be used as short-hand + # for listing every field. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -11322,9 +9011,9 @@ module Google class UpdateFilterViewRequest include Google::Apis::Core::Hashable - # The fields that should be updated. At least one field must be specified. - # The root `filter` is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. + # The fields that should be updated. At least one field must be specified. The + # root `filter` is implied and should not be specified. A single `"*"` can be + # used as short-hand for listing every field. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -11345,14 +9034,13 @@ module Google end end - # Updates properties of the named range with the specified - # namedRangeId. + # Updates properties of the named range with the specified namedRangeId. class UpdateNamedRangeRequest include Google::Apis::Core::Hashable - # The fields that should be updated. At least one field must be specified. - # The root `namedRange` is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. + # The fields that should be updated. At least one field must be specified. The + # root `namedRange` is implied and should not be specified. A single `"*"` can + # be used as short-hand for listing every field. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -11373,14 +9061,13 @@ module Google end end - # Updates an existing protected range with the specified - # protectedRangeId. + # Updates an existing protected range with the specified protectedRangeId. class UpdateProtectedRangeRequest include Google::Apis::Core::Hashable - # The fields that should be updated. At least one field must be specified. - # The root `protectedRange` is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. + # The fields that should be updated. At least one field must be specified. The + # root `protectedRange` is implied and should not be specified. A single `"*"` + # can be used as short-hand for listing every field. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -11401,14 +9088,13 @@ module Google end end - # Updates properties of the sheet with the specified - # sheetId. + # Updates properties of the sheet with the specified sheetId. class UpdateSheetPropertiesRequest include Google::Apis::Core::Hashable - # The fields that should be updated. At least one field must be specified. - # The root `properties` is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. + # The fields that should be updated. At least one field must be specified. The + # root `properties` is implied and should not be specified. A single `"*"` can + # be used as short-hand for listing every field. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -11429,15 +9115,14 @@ module Google end end - # Updates a slicer's specifications. - # (This does not move or resize a slicer. To move or resize a slicer use - # UpdateEmbeddedObjectPositionRequest. + # Updates a slicer's specifications. (This does not move or resize a slicer. To + # move or resize a slicer use UpdateEmbeddedObjectPositionRequest. class UpdateSlicerSpecRequest include Google::Apis::Core::Hashable - # The fields that should be updated. At least one field must be specified. - # The root `SlicerSpec` is implied and should not be specified. A single "*"` - # can be used as short-hand for listing every field. + # The fields that should be updated. At least one field must be specified. The + # root `SlicerSpec` is implied and should not be specified. A single "*"` can be + # used as short-hand for listing every field. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -11468,9 +9153,9 @@ module Google class UpdateSpreadsheetPropertiesRequest include Google::Apis::Core::Hashable - # The fields that should be updated. At least one field must be specified. - # The root 'properties' is implied and should not be specified. - # A single `"*"` can be used as short-hand for listing every field. + # The fields that should be updated. At least one field must be specified. The + # root 'properties' is implied and should not be specified. A single `"*"` can + # be used as short-hand for listing every field. # Corresponds to the JSON property `fields` # @return [String] attr_accessor :fields @@ -11491,13 +9176,11 @@ module Google end end - # The response when updating a range of values by a data filter in a - # spreadsheet. + # The response when updating a range of values by a data filter in a spreadsheet. class UpdateValuesByDataFilterResponse include Google::Apis::Core::Hashable - # Filter that describes what data should be selected or returned from a - # request. + # Filter that describes what data should be selected or returned from a request. # Corresponds to the JSON property `dataFilter` # @return [Google::Apis::SheetsV4::DataFilter] attr_accessor :data_filter @@ -11595,37 +9278,31 @@ module Google class ValueRange include Google::Apis::Core::Hashable - # The major dimension of the values. - # For output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, - # then requesting `range=A1:B2,majorDimension=ROWS` will return - # `[[1,2],[3,4]]`, - # whereas requesting `range=A1:B2,majorDimension=COLUMNS` will return - # `[[1,3],[2,4]]`. - # For input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]` - # will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS` - # then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. + # The major dimension of the values. For output, if the spreadsheet data is: `A1= + # 1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension=ROWS` will + # return `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension=COLUMNS` + # will return `[[1,3],[2,4]]`. For input, with `range=A1:B2,majorDimension=ROWS` + # then `[[1,2],[3,4]]` will set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2, + # majorDimension=COLUMNS` then `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`. # When writing, if this field is not set, it defaults to ROWS. # Corresponds to the JSON property `majorDimension` # @return [String] attr_accessor :major_dimension - # The range the values cover, in A1 notation. - # For output, this range indicates the entire requested range, - # even though the values will exclude trailing rows and columns. - # When appending values, this field represents the range to search for a - # table, after which values will be appended. + # The range the values cover, in A1 notation. For output, this range indicates + # the entire requested range, even though the values will exclude trailing rows + # and columns. When appending values, this field represents the range to search + # for a table, after which values will be appended. # Corresponds to the JSON property `range` # @return [String] attr_accessor :range - # The data that was read or to be written. This is an array of arrays, - # the outer array representing all the data and each inner array - # representing a major dimension. Each item in the inner array - # corresponds with one cell. - # For output, empty trailing rows and columns will not be included. - # For input, supported value types are: bool, string, and double. - # Null values will be skipped. - # To set a cell to an empty value, set the string value to an empty string. + # The data that was read or to be written. This is an array of arrays, the outer + # array representing all the data and each inner array representing a major + # dimension. Each item in the inner array corresponds with one cell. For output, + # empty trailing rows and columns will not be included. For input, supported + # value types are: bool, string, and double. Null values will be skipped. To set + # a cell to an empty value, set the string value to an empty string. # Corresponds to the JSON property `values` # @return [Array>] attr_accessor :values @@ -11648,110 +9325,49 @@ 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(''); `; // ... # Corresponds to the JSON property `color` # @return [Google::Apis::SheetsV4::Color] attr_accessor :color @@ -11782,8 +9398,8 @@ module Google class WaterfallChartCustomSubtotal include Google::Apis::Core::Hashable - # True if the data point at subtotal_index is the subtotal. If false, - # the subtotal will be computed and appear after the data point. + # True if the data point at subtotal_index is the subtotal. If false, the + # subtotal will be computed and appear after the data point. # Corresponds to the JSON property `dataIsSubtotal` # @return [Boolean] attr_accessor :data_is_subtotal @@ -11794,14 +9410,13 @@ module Google # @return [String] attr_accessor :label - # The 0-based index of a data point within the series. If - # data_is_subtotal is true, the data point at this index is the - # subtotal. Otherwise, the subtotal appears after the data point with - # this index. A series can have multiple subtotals at arbitrary indices, - # but subtotals do not affect the indices of the data points. For - # example, if a series has three data points, their indices will always - # be 0, 1, and 2, regardless of how many subtotals exist on the series or - # what data points they are associated with. + # The 0-based index of a data point within the series. If data_is_subtotal is + # true, the data point at this index is the subtotal. Otherwise, the subtotal + # appears after the data point with this index. A series can have multiple + # subtotals at arbitrary indices, but subtotals do not affect the indices of the + # data points. For example, if a series has three data points, their indices + # will always be 0, 1, and 2, regardless of how many subtotals exist on the + # series or what data points they are associated with. # Corresponds to the JSON property `subtotalIndex` # @return [Fixnum] attr_accessor :subtotal_index @@ -11848,9 +9463,9 @@ module Google class WaterfallChartSeries include Google::Apis::Core::Hashable - # Custom subtotal columns appearing in this series. The order in which - # subtotals are defined is not significant. Only one subtotal may be - # defined for each data point. + # Custom subtotal columns appearing in this series. The order in which subtotals + # are defined is not significant. Only one subtotal may be defined for each data + # point. # Corresponds to the JSON property `customSubtotals` # @return [Array] attr_accessor :custom_subtotals @@ -11860,9 +9475,9 @@ module Google # @return [Google::Apis::SheetsV4::ChartData] attr_accessor :data - # True to hide the subtotal column from the end of the series. By default, - # a subtotal column will appear at the end of each series. Setting this - # field to true will hide that subtotal column for this series. + # True to hide the subtotal column from the end of the series. By default, a + # subtotal column will appear at the end of each series. Setting this field to + # true will hide that subtotal column for this series. # Corresponds to the JSON property `hideTrailingSubtotal` # @return [Boolean] attr_accessor :hide_trailing_subtotal diff --git a/generated/google/apis/sheets_v4/service.rb b/generated/google/apis/sheets_v4/service.rb index 8060aea41..cd0505931 100644 --- a/generated/google/apis/sheets_v4/service.rb +++ b/generated/google/apis/sheets_v4/service.rb @@ -47,22 +47,18 @@ module Google @batch_path = 'batch' end - # Applies one or more updates to the spreadsheet. - # Each request is validated before - # being applied. If any request is not valid then the entire request will - # fail and nothing will be applied. - # Some requests have replies to - # give you some information about how - # they are applied. The replies will mirror the requests. For example, - # if you applied 4 updates and the 3rd one had a reply, then the - # response will have 2 empty replies, the actual reply, and another empty - # reply, in that order. - # Due to the collaborative nature of spreadsheets, it is not guaranteed that - # the spreadsheet will reflect exactly your changes after this completes, - # however it is guaranteed that the updates in the request will be + # Applies one or more updates to the spreadsheet. Each request is validated + # before being applied. If any request is not valid then the entire request will + # fail and nothing will be applied. Some requests have replies to give you some + # information about how they are applied. The replies will mirror the requests. + # For example, if you applied 4 updates and the 3rd one had a reply, then the + # response will have 2 empty replies, the actual reply, and another empty reply, + # in that order. Due to the collaborative nature of spreadsheets, it is not + # guaranteed that the spreadsheet will reflect exactly your changes after this + # completes, however it is guaranteed that the updates in the request will be # applied together atomically. Your changes may be altered with respect to - # collaborator changes. If there are no collaborators, the spreadsheet - # should reflect your changes. + # collaborator changes. If there are no collaborators, the spreadsheet should + # reflect your changes. # @param [String] spreadsheet_id # The spreadsheet to apply the updates to. # @param [Google::Apis::SheetsV4::BatchUpdateSpreadsheetRequest] batch_update_spreadsheet_request_object @@ -125,27 +121,21 @@ module Google execute_or_queue_command(command, &block) end - # Returns the spreadsheet at the given ID. - # The caller must specify the spreadsheet ID. - # By default, data within grids will not be returned. - # You can include grid data one of two ways: - # * Specify a field mask listing your desired fields using the `fields` URL - # parameter in HTTP - # * Set the includeGridData - # URL parameter to true. If a field mask is set, the `includeGridData` - # parameter is ignored - # For large spreadsheets, it is recommended to retrieve only the specific - # fields of the spreadsheet that you want. - # To retrieve only subsets of the spreadsheet, use the - # ranges URL parameter. - # Multiple ranges can be specified. Limiting the range will - # return only the portions of the spreadsheet that intersect the requested - # ranges. Ranges are specified using A1 notation. + # Returns the spreadsheet at the given ID. The caller must specify the + # spreadsheet ID. By default, data within grids will not be returned. You can + # include grid data one of two ways: * Specify a field mask listing your desired + # fields using the `fields` URL parameter in HTTP * Set the includeGridData URL + # parameter to true. If a field mask is set, the `includeGridData` parameter is + # ignored For large spreadsheets, it is recommended to retrieve only the + # specific fields of the spreadsheet that you want. To retrieve only subsets of + # the spreadsheet, use the ranges URL parameter. Multiple ranges can be + # specified. Limiting the range will return only the portions of the spreadsheet + # that intersect the requested ranges. Ranges are specified using A1 notation. # @param [String] spreadsheet_id # The spreadsheet to request. # @param [Boolean] include_grid_data - # True if grid data should be returned. - # This parameter is ignored if a field mask was set in the request. + # True if grid data should be returned. This parameter is ignored if a field + # mask was set in the request. # @param [Array, String] ranges # The ranges to retrieve from the spreadsheet. # @param [String] fields @@ -177,23 +167,18 @@ module Google execute_or_queue_command(command, &block) end - # Returns the spreadsheet at the given ID. - # The caller must specify the spreadsheet ID. - # This method differs from GetSpreadsheet in that it allows selecting - # which subsets of spreadsheet data to return by specifying a - # dataFilters parameter. - # Multiple DataFilters can be specified. Specifying one or - # more data filters will return the portions of the spreadsheet that - # intersect ranges matched by any of the filters. - # By default, data within grids will not be returned. - # You can include grid data one of two ways: - # * Specify a field mask listing your desired fields using the `fields` URL - # parameter in HTTP - # * Set the includeGridData - # parameter to true. If a field mask is set, the `includeGridData` - # parameter is ignored - # For large spreadsheets, it is recommended to retrieve only the specific - # fields of the spreadsheet that you want. + # Returns the spreadsheet at the given ID. The caller must specify the + # spreadsheet ID. This method differs from GetSpreadsheet in that it allows + # selecting which subsets of spreadsheet data to return by specifying a + # dataFilters parameter. Multiple DataFilters can be specified. Specifying one + # or more data filters will return the portions of the spreadsheet that + # intersect ranges matched by any of the filters. By default, data within grids + # will not be returned. You can include grid data one of two ways: * Specify a + # field mask listing your desired fields using the `fields` URL parameter in + # HTTP * Set the includeGridData parameter to true. If a field mask is set, the ` + # includeGridData` parameter is ignored For large spreadsheets, it is + # recommended to retrieve only the specific fields of the spreadsheet that you + # want. # @param [String] spreadsheet_id # The spreadsheet to request. # @param [Google::Apis::SheetsV4::GetSpreadsheetByDataFilterRequest] get_spreadsheet_by_data_filter_request_object @@ -226,9 +211,8 @@ module Google execute_or_queue_command(command, &block) end - # Returns the developer metadata with the specified ID. - # The caller must specify the spreadsheet ID and the developer metadata's - # unique metadataId. + # Returns the developer metadata with the specified ID. The caller must specify + # the spreadsheet ID and the developer metadata's unique metadataId. # @param [String] spreadsheet_id # The ID of the spreadsheet to retrieve metadata from. # @param [Fixnum] metadata_id @@ -261,11 +245,11 @@ module Google execute_or_queue_command(command, &block) end - # Returns all developer metadata matching the specified DataFilter. - # If the provided DataFilter represents a DeveloperMetadataLookup object, - # this will return all DeveloperMetadata entries selected by it. If the - # DataFilter represents a location in a spreadsheet, this will return all - # developer metadata associated with locations intersecting that region. + # Returns all developer metadata matching the specified DataFilter. If the + # provided DataFilter represents a DeveloperMetadataLookup object, this will + # return all DeveloperMetadata entries selected by it. If the DataFilter + # represents a location in a spreadsheet, this will return all developer + # metadata associated with locations intersecting that region. # @param [String] spreadsheet_id # The ID of the spreadsheet to retrieve metadata from. # @param [Google::Apis::SheetsV4::SearchDeveloperMetadataRequest] search_developer_metadata_request_object @@ -298,8 +282,8 @@ module Google execute_or_queue_command(command, &block) end - # Copies a single sheet from a spreadsheet to another spreadsheet. - # Returns the properties of the newly created sheet. + # Copies a single sheet from a spreadsheet to another spreadsheet. Returns the + # properties of the newly created sheet. # @param [String] spreadsheet_id # The ID of the spreadsheet containing the sheet to copy. # @param [Fixnum] sheet_id @@ -336,38 +320,32 @@ module Google end # Appends values to a spreadsheet. The input range is used to search for - # existing data and find a "table" within that range. Values will be - # appended to the next row of the table, starting with the first column of - # the table. See the - # [guide](/sheets/api/guides/values#appending_values) - # and - # [sample code](/sheets/api/samples/writing#append_values) - # for specific details of how tables are detected and data is appended. - # The caller must specify the spreadsheet ID, range, and - # a valueInputOption. The `valueInputOption` only - # controls how the input data will be added to the sheet (column-wise or - # row-wise), it does not influence what cell the data starts being written - # to. + # existing data and find a "table" within that range. Values will be appended to + # the next row of the table, starting with the first column of the table. See + # the [guide](/sheets/api/guides/values#appending_values) and [sample code](/ + # sheets/api/samples/writing#append_values) for specific details of how tables + # are detected and data is appended. The caller must specify the spreadsheet ID, + # range, and a valueInputOption. The `valueInputOption` only controls how the + # input data will be added to the sheet (column-wise or row-wise), it does not + # influence what cell the data starts being written to. # @param [String] spreadsheet_id # The ID of the spreadsheet to update. # @param [String] range - # The A1 notation of a range to search for a logical table of data. - # Values are appended after the last row of the table. + # The A1 notation of a range to search for a logical table of data. Values are + # appended after the last row of the table. # @param [Google::Apis::SheetsV4::ValueRange] value_range_object # @param [Boolean] include_values_in_response - # Determines if the update response should include the values - # of the cells that were appended. By default, responses - # do not include the updated values. + # Determines if the update response should include the values of the cells that + # were appended. By default, responses do not include the updated values. # @param [String] insert_data_option # How the input data should be inserted. # @param [String] response_date_time_render_option - # Determines how dates, times, and durations in the response should be - # rendered. This is ignored if response_value_render_option is - # FORMATTED_VALUE. - # The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. + # Determines how dates, times, and durations in the response should be rendered. + # This is ignored if response_value_render_option is FORMATTED_VALUE. The + # default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. # @param [String] response_value_render_option - # Determines how values in the response should be rendered. - # The default render option is ValueRenderOption.FORMATTED_VALUE. + # Determines how values in the response should be rendered. The default render + # option is ValueRenderOption.FORMATTED_VALUE. # @param [String] value_input_option # How the input data should be interpreted. # @param [String] fields @@ -405,10 +383,10 @@ module Google execute_or_queue_command(command, &block) end - # Clears one or more ranges of values from a spreadsheet. - # The caller must specify the spreadsheet ID and one or more ranges. - # Only values are cleared -- all other properties of the cell (such as - # formatting, data validation, etc..) are kept. + # Clears one or more ranges of values from a spreadsheet. The caller must + # specify the spreadsheet ID and one or more ranges. Only values are cleared -- + # all other properties of the cell (such as formatting, data validation, etc..) + # are kept. # @param [String] spreadsheet_id # The ID of the spreadsheet to update. # @param [Google::Apis::SheetsV4::BatchClearValuesRequest] batch_clear_values_request_object @@ -441,11 +419,11 @@ module Google execute_or_queue_command(command, &block) end - # Clears one or more ranges of values from a spreadsheet. - # The caller must specify the spreadsheet ID and one or more - # DataFilters. Ranges matching any of the specified data - # filters will be cleared. Only values are cleared -- all other properties - # of the cell (such as formatting, data validation, etc..) are kept. + # Clears one or more ranges of values from a spreadsheet. The caller must + # specify the spreadsheet ID and one or more DataFilters. Ranges matching any of + # the specified data filters will be cleared. Only values are cleared -- all + # other properties of the cell (such as formatting, data validation, etc..) are + # kept. # @param [String] spreadsheet_id # The ID of the spreadsheet to update. # @param [Google::Apis::SheetsV4::BatchClearValuesByDataFilterRequest] batch_clear_values_by_data_filter_request_object @@ -478,26 +456,24 @@ module Google execute_or_queue_command(command, &block) end - # Returns one or more ranges of values from a spreadsheet. - # The caller must specify the spreadsheet ID and one or more ranges. + # Returns one or more ranges of values from a spreadsheet. The caller must + # specify the spreadsheet ID and one or more ranges. # @param [String] spreadsheet_id # The ID of the spreadsheet to retrieve data from. # @param [String] date_time_render_option - # How dates, times, and durations should be represented in the output. - # This is ignored if value_render_option is - # FORMATTED_VALUE. - # The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. + # How dates, times, and durations should be represented in the output. This is + # ignored if value_render_option is FORMATTED_VALUE. The default dateTime render + # option is [DateTimeRenderOption.SERIAL_NUMBER]. # @param [String] major_dimension - # The major dimension that results should use. - # For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, - # then requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`, - # whereas requesting `range=A1:B2,majorDimension=COLUMNS` returns - # `[[1,3],[2,4]]`. + # The major dimension that results should use. For example, if the spreadsheet + # data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension= + # ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension= + # COLUMNS` returns `[[1,3],[2,4]]`. # @param [Array, String] ranges # The A1 notation of the values to retrieve. # @param [String] value_render_option - # How values should be represented in the output. - # The default render option is ValueRenderOption.FORMATTED_VALUE. + # How values should be represented in the output. The default render option is + # ValueRenderOption.FORMATTED_VALUE. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -530,9 +506,8 @@ module Google end # Returns one or more ranges of values that match the specified data filters. - # The caller must specify the spreadsheet ID and one or more - # DataFilters. Ranges that match any of the data filters in - # the request will be returned. + # The caller must specify the spreadsheet ID and one or more DataFilters. Ranges + # that match any of the data filters in the request will be returned. # @param [String] spreadsheet_id # The ID of the spreadsheet to retrieve data from. # @param [Google::Apis::SheetsV4::BatchGetValuesByDataFilterRequest] batch_get_values_by_data_filter_request_object @@ -565,10 +540,8 @@ module Google execute_or_queue_command(command, &block) end - # Sets values in one or more ranges of a spreadsheet. - # The caller must specify the spreadsheet ID, - # a valueInputOption, and one or more - # ValueRanges. + # Sets values in one or more ranges of a spreadsheet. The caller must specify + # the spreadsheet ID, a valueInputOption, and one or more ValueRanges. # @param [String] spreadsheet_id # The ID of the spreadsheet to update. # @param [Google::Apis::SheetsV4::BatchUpdateValuesRequest] batch_update_values_request_object @@ -601,10 +574,8 @@ module Google execute_or_queue_command(command, &block) end - # Sets values in one or more ranges of a spreadsheet. - # The caller must specify the spreadsheet ID, - # a valueInputOption, and one or more - # DataFilterValueRanges. + # Sets values in one or more ranges of a spreadsheet. The caller must specify + # the spreadsheet ID, a valueInputOption, and one or more DataFilterValueRanges. # @param [String] spreadsheet_id # The ID of the spreadsheet to update. # @param [Google::Apis::SheetsV4::BatchUpdateValuesByDataFilterRequest] batch_update_values_by_data_filter_request_object @@ -637,10 +608,9 @@ module Google execute_or_queue_command(command, &block) end - # Clears values from a spreadsheet. - # The caller must specify the spreadsheet ID and range. - # Only values are cleared -- all other properties of the cell (such as - # formatting, data validation, etc..) are kept. + # Clears values from a spreadsheet. The caller must specify the spreadsheet ID + # and range. Only values are cleared -- all other properties of the cell (such + # as formatting, data validation, etc..) are kept. # @param [String] spreadsheet_id # The ID of the spreadsheet to update. # @param [String] range @@ -676,26 +646,24 @@ module Google execute_or_queue_command(command, &block) end - # Returns a range of values from a spreadsheet. - # The caller must specify the spreadsheet ID and a range. + # Returns a range of values from a spreadsheet. The caller must specify the + # spreadsheet ID and a range. # @param [String] spreadsheet_id # The ID of the spreadsheet to retrieve data from. # @param [String] range # The A1 notation of the values to retrieve. # @param [String] date_time_render_option - # How dates, times, and durations should be represented in the output. - # This is ignored if value_render_option is - # FORMATTED_VALUE. - # The default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]. + # How dates, times, and durations should be represented in the output. This is + # ignored if value_render_option is FORMATTED_VALUE. The default dateTime render + # option is [DateTimeRenderOption.SERIAL_NUMBER]. # @param [String] major_dimension - # The major dimension that results should use. - # For example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`, then - # requesting `range=A1:B2,majorDimension=ROWS` returns `[[1,2],[3,4]]`, - # whereas requesting `range=A1:B2,majorDimension=COLUMNS` returns - # `[[1,3],[2,4]]`. + # The major dimension that results should use. For example, if the spreadsheet + # data is: `A1=1,B1=2,A2=3,B2=4`, then requesting `range=A1:B2,majorDimension= + # ROWS` returns `[[1,2],[3,4]]`, whereas requesting `range=A1:B2,majorDimension= + # COLUMNS` returns `[[1,3],[2,4]]`. # @param [String] value_render_option - # How values should be represented in the output. - # The default render option is ValueRenderOption.FORMATTED_VALUE. + # How values should be represented in the output. The default render option is + # ValueRenderOption.FORMATTED_VALUE. # @param [String] fields # Selector specifying which fields to include in a partial response. # @param [String] quota_user @@ -727,30 +695,26 @@ module Google execute_or_queue_command(command, &block) end - # Sets values in a range of a spreadsheet. - # The caller must specify the spreadsheet ID, range, and - # a valueInputOption. + # Sets values in a range of a spreadsheet. The caller must specify the + # spreadsheet ID, range, and a valueInputOption. # @param [String] spreadsheet_id # The ID of the spreadsheet to update. # @param [String] range # The A1 notation of the values to update. # @param [Google::Apis::SheetsV4::ValueRange] value_range_object # @param [Boolean] include_values_in_response - # Determines if the update response should include the values - # of the cells that were updated. By default, responses - # do not include the updated values. - # If the range to write was larger than the range actually written, the - # response includes all values in the requested range (excluding trailing - # empty rows and columns). + # Determines if the update response should include the values of the cells that + # were updated. By default, responses do not include the updated values. If the + # range to write was larger than the range actually written, the response + # includes all values in the requested range (excluding trailing empty rows and + # columns). # @param [String] response_date_time_render_option - # Determines how dates, times, and durations in the response should be - # rendered. This is ignored if response_value_render_option is - # FORMATTED_VALUE. - # The default dateTime render option is - # DateTimeRenderOption.SERIAL_NUMBER. + # Determines how dates, times, and durations in the response should be rendered. + # This is ignored if response_value_render_option is FORMATTED_VALUE. The + # default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER. # @param [String] response_value_render_option - # Determines how values in the response should be rendered. - # The default render option is ValueRenderOption.FORMATTED_VALUE. + # Determines how values in the response should be rendered. The default render + # option is ValueRenderOption.FORMATTED_VALUE. # @param [String] value_input_option # How the input data should be interpreted. # @param [String] fields