Module: Google::Apis::CloudsearchV1

Defined in:
lib/google/apis/cloudsearch_v1.rb,
lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/service.rb,
lib/google/apis/cloudsearch_v1/gem_version.rb,
lib/google/apis/cloudsearch_v1/representations.rb

Overview

Cloud Search API

Cloud Search provides cloud-based search capabilities over Google Workspace data. The Cloud Search API allows indexing of non-Google Workspace data into Cloud Search.

See Also:

Defined Under Namespace

Classes: AbuseReportingConfig, AckInfo, AclFixRequest, AclFixStatus, AclInfo, ActionParameter, AddOnFrameStartingState, AddOnStartingState, AddonComposeUiActionMarkup, AffectedMembership, AllAuthenticatedUsersProto, Annotation, AnnotationInfo, AppId, AppsDynamiteSharedActivityFeedAnnotationData, AppsDynamiteSharedActivityFeedAnnotationDataUserInfo, AppsDynamiteSharedAppProfile, AppsDynamiteSharedAssistantAnnotationData, AppsDynamiteSharedAssistantDebugContext, AppsDynamiteSharedAssistantFeedbackContext, AppsDynamiteSharedAssistantFeedbackContextFeedbackChip, AppsDynamiteSharedAssistantSessionContext, AppsDynamiteSharedAssistantSuggestion, AppsDynamiteSharedAssistantUnfulfillableRequest, AppsDynamiteSharedAvatarInfo, AppsDynamiteSharedBackendUploadMetadata, AppsDynamiteSharedBackendUploadMetadataMigratedFromHangoutsMetadata, AppsDynamiteSharedBackendUploadMetadataMigratedFromHangoutsMetadataPhotoId, AppsDynamiteSharedCalendarEventAnnotationData, AppsDynamiteSharedCalendarEventAnnotationDataCalendarEvent, AppsDynamiteSharedCalendarEventAnnotationDataCalendarEventTime, AppsDynamiteSharedCalendarEventAnnotationDataEventCreation, AppsDynamiteSharedCallAnnotationData, AppsDynamiteSharedCallMetadata, AppsDynamiteSharedCardClickSuggestion, AppsDynamiteSharedChatItem, AppsDynamiteSharedChatItemActivityInfo, AppsDynamiteSharedChatItemActivityInfoFeedItemNudge, AppsDynamiteSharedChatItemActivityInfoFeedItemReactions, AppsDynamiteSharedChatItemActivityInfoFeedItemThreadReply, AppsDynamiteSharedChatItemActivityInfoFeedItemUserMention, AppsDynamiteSharedChatItemGroupInfo, AppsDynamiteSharedContentReportType, AppsDynamiteSharedCustomEmoji, AppsDynamiteSharedDimension, AppsDynamiteSharedDlpMetricsMetadata, AppsDynamiteSharedDocument, AppsDynamiteSharedEmoji, AppsDynamiteSharedFindDocumentSuggestion, AppsDynamiteSharedGroupDetails, AppsDynamiteSharedGroupVisibility, AppsDynamiteSharedJustification, AppsDynamiteSharedJustificationPerson, AppsDynamiteSharedMeetMetadata, AppsDynamiteSharedMessageComponentSearchInfo, AppsDynamiteSharedMessageInfo, AppsDynamiteSharedMessageIntegrationPayload, AppsDynamiteSharedMessageSearchInfo, AppsDynamiteSharedOrganizationInfo, AppsDynamiteSharedOrganizationInfoConsumerInfo, AppsDynamiteSharedOrganizationInfoCustomerInfo, AppsDynamiteSharedOriginAppSuggestion, AppsDynamiteSharedPhoneNumber, AppsDynamiteSharedReaction, AppsDynamiteSharedRetentionSettings, AppsDynamiteSharedSegmentedMembershipCount, AppsDynamiteSharedSegmentedMembershipCounts, AppsDynamiteSharedSpaceInfo, AppsDynamiteSharedTasksAnnotationData, AppsDynamiteSharedTasksAnnotationDataAssigneeChange, AppsDynamiteSharedTasksAnnotationDataCompletionChange, AppsDynamiteSharedTasksAnnotationDataCreation, AppsDynamiteSharedTasksAnnotationDataDeletionChange, AppsDynamiteSharedTasksAnnotationDataTaskProperties, AppsDynamiteSharedTasksAnnotationDataUserDefinedMessage, AppsDynamiteSharedTasksMessageIntegrationPayload, AppsDynamiteSharedTextSegment, AppsDynamiteSharedTextSegmentsWithDescription, AppsDynamiteSharedTextWithDescription, AppsDynamiteSharedUserBlockRelationship, AppsDynamiteSharedVideoReference, AppsDynamiteStorageAction, AppsDynamiteStorageActionActionParameter, AppsDynamiteStorageBorderStyle, AppsDynamiteStorageButton, AppsDynamiteStorageButtonList, AppsDynamiteStorageCard, AppsDynamiteStorageCardCardAction, AppsDynamiteStorageCardCardHeader, AppsDynamiteStorageCardSection, AppsDynamiteStorageColumns, AppsDynamiteStorageColumnsColumn, AppsDynamiteStorageColumnsColumnWidgets, AppsDynamiteStorageDateTimePicker, AppsDynamiteStorageDecoratedText, AppsDynamiteStorageDecoratedTextSwitchControl, AppsDynamiteStorageDivider, AppsDynamiteStorageGrid, AppsDynamiteStorageGridGridItem, AppsDynamiteStorageIcon, AppsDynamiteStorageImage, AppsDynamiteStorageImageComponent, AppsDynamiteStorageImageCropStyle, AppsDynamiteStorageMaterialIcon, AppsDynamiteStorageOnClick, AppsDynamiteStorageOpenLink, AppsDynamiteStorageOpenLinkAppUri, AppsDynamiteStorageOpenLinkAppUriIntent, AppsDynamiteStorageOpenLinkAppUriIntentExtraData, AppsDynamiteStorageSelectionInput, AppsDynamiteStorageSelectionInputSelectionItem, AppsDynamiteStorageSuggestions, AppsDynamiteStorageSuggestionsSuggestionItem, AppsDynamiteStorageTextInput, AppsDynamiteStorageTextParagraph, AppsDynamiteStorageWidget, AppsDynamiteV1ApiCompatV1Action, AppsDynamiteV1ApiCompatV1ActionConfirm, AppsDynamiteV1ApiCompatV1Attachment, AppsDynamiteV1ApiCompatV1Field, AppsExtensionsMarkupCalendarClientActionMarkupAddAttachmentsActionMarkup, AppsExtensionsMarkupCalendarClientActionMarkupAddAttachmentsActionMarkupAddonAttachment, AppsExtensionsMarkupCalendarClientActionMarkupConferenceDataMarkup, AppsExtensionsMarkupCalendarClientActionMarkupConferenceDataMarkupEntryPointMarkup, AppsExtensionsMarkupCalendarClientActionMarkupConferenceDataMarkupError, AppsExtensionsMarkupCalendarClientActionMarkupConferenceDataMarkupParameter, AppsExtensionsMarkupCalendarClientActionMarkupEditAttendeesActionMarkup, AppsExtensionsMarkupCalendarClientActionMarkupEditConferenceDataActionMarkup, Attachment, Attribute, AttributeRemoved, AttributeSet, Attributes, AuditLoggingSettings, AuthorizedItemId, AutoComplete, AutoCompleteItem, BabelMessageProps, BabelPlaceholderMetadata, BooleanOperatorOptions, BooleanPropertyOptions, BorderStyle, BotInfo, BotResponse, BroadcastAccess, BroadcastSessionInfo, BroadcastStats, Button, CalendarClientActionMarkup, CallInfo, CallSettings, CapTokenHolderProto, Card, CardAction, CardCapabilityMetadata, CardHeader, CaribouAttributeValue, ChatClientActionMarkup, ChatConserverDynamitePlaceholderMetadata, ChatConserverDynamitePlaceholderMetadataAttachmentMetadata, ChatConserverDynamitePlaceholderMetadataBotMessageMetadata, ChatConserverDynamitePlaceholderMetadataCalendarEventMetadata, ChatConserverDynamitePlaceholderMetadataDeleteMetadata, ChatConserverDynamitePlaceholderMetadataEditMetadata, ChatConserverDynamitePlaceholderMetadataTasksMetadata, ChatConserverDynamitePlaceholderMetadataVideoCallMetadata, ChatConserverMessageContent, ChatContentExtension, ChatProto, CheckAccessResponse, CircleProto, ClientContext, CloudPrincipalProto, CloudSearchService, ClusterInfo, CoActivity, Collaboration, Color, CommunalLabelTag, CompositeFilter, ConsentedAppUnfurlMetadata, ContactGroupProto, ContentReport, ContentReportJustification, ContentReportSummary, ContextAttribute, ContextualAddOnMarkup, CseInfo, CustomEmojiMetadata, CustomFunctionReturnValueMarkup, CustomerId, CustomerIndexStats, CustomerQueryStats, CustomerSearchApplicationStats, CustomerSessionStats, CustomerSettings, CustomerUserStats, DataLossPreventionMetadata, DataSource, DataSourceIndexStats, DataSourceRestriction, Date, DateOperatorOptions, DatePropertyOptions, DateTimePicker, DateValues, DebugOptions, DeepLinkData, DeleteMetadata, DeleteQueueItemsRequest, DeliveryMedium, DisplayedProperty, Divider, DlpAction, DlpMessageScanRecord, DlpScanSummary, DmId, DocumentInfo, DoubleOperatorOptions, DoublePropertyOptions, DoubleValues, DriveClientActionMarkup, DriveFollowUpRestrict, DriveLocationRestrict, DriveMetadata, DriveMimeTypeRestrict, DriveTimeSpanRestrict, DynamiteMessagesScoringInfo, DynamiteSpacesScoringInfo, EditMetadata, EditorClientActionMarkup, EmailAddress, EmailOwnerProto, EmbedClientItem, EnumOperatorOptions, EnumPropertyOptions, EnumValuePair, EnumValues, ErrorInfo, ErrorMessage, EventAnnotation, EventProto, FacetBucket, FacetOptions, FacetResult, FieldViolation, Filter, FilterCreated, FilterDeleted, FilterOptions, FilterUpdate, FixedFooter, Folder, FolderAttribute, FormAction, FormatMetadata, Formatting, FreshnessOptions, FuseboxItem, FuseboxItemThreadMatchInfo, FuseboxPrefUpdatePreState, GSuitePrincipal, GaiaGroupProto, GaiaUserProto, GatewayAccess, GatewaySipAccess, GetCustomerIndexStatsResponse, GetCustomerQueryStatsResponse, GetCustomerSearchApplicationStatsResponse, GetCustomerSessionStatsResponse, GetCustomerUserStatsResponse, GetDataSourceIndexStatsResponse, GetSearchApplicationQueryStatsResponse, GetSearchApplicationSessionStatsResponse, GetSearchApplicationUserStatsResponse, GmailClientActionMarkup, GoogleChatV1ContextualAddOnMarkup, GoogleChatV1ContextualAddOnMarkupCard, GoogleChatV1ContextualAddOnMarkupCardCardAction, GoogleChatV1ContextualAddOnMarkupCardCardHeader, GoogleChatV1ContextualAddOnMarkupCardSection, GoogleChatV1WidgetMarkup, GoogleChatV1WidgetMarkupButton, GoogleChatV1WidgetMarkupFormAction, GoogleChatV1WidgetMarkupFormActionActionParameter, GoogleChatV1WidgetMarkupImage, GoogleChatV1WidgetMarkupImageButton, GoogleChatV1WidgetMarkupKeyValue, GoogleChatV1WidgetMarkupOnClick, GoogleChatV1WidgetMarkupOpenLink, GoogleChatV1WidgetMarkupTextButton, GoogleChatV1WidgetMarkupTextParagraph, GoogleDocsMetadata, GoogleDocsResultInfo, Grid, GridItem, GroupDetailsUpdatedMetadata, GroupId, GroupLinkSharingModificationEvent, GroupRetentionSettingsUpdatedMetaData, GsuiteIntegrationMetadata, HangoutEvent, HangoutVideoEventMetadata, HashtagData, History, HistoryRecord, HostAppActionMarkup, HostProto, HtmlOperatorOptions, HtmlPropertyOptions, HtmlValues, IconImage, Id, Image, ImageButton, ImageComponent, ImageCropStyle, ImageKeyValue, ImapSessionContext, ImapSyncDelete, ImapUidsReassign, ImapUpdate, ImapsyncFolderAttributeFolderMessage, ImapsyncFolderAttributeFolderMessageFlags, IncomingWebhookChangedMetadata, IndexItemOptions, IndexItemRequest, InitializeCustomerRequest, InsertContent, IntegerFacetingOptions, IntegerOperatorOptions, IntegerPropertyOptions, IntegerValues, IntegrationConfigMutation, IntegrationConfigUpdatedMetadata, Interaction, InteractionData, InviteAcceptedEvent, InviteeInfo, Item, ItemAcl, ItemContent, ItemCountByStatus, ItemMetadata, ItemParts, ItemStatus, ItemStructuredData, ItemThread, JobsettedServerSpec, KeyValue, LabelAdded, LabelCreated, LabelDeleted, LabelRemoved, LabelRenamed, LabelUpdate, LabelUpdated, Labels, LanguageConfig, LdapGroupProto, LdapUserProto, LegacyUploadMetadata, LinkData, ListDataSourceResponse, ListItemNamesForUnmappedIdentityResponse, ListItemsResponse, ListOperationsResponse, ListQuerySourcesResponse, ListSearchApplicationsResponse, ListUnmappedIdentitiesResponse, MatchInfo, MatchRange, MdbGroupProto, MdbUserProto, Media, MeetingSpace, Member, MemberId, MembershipChangeEvent, MembershipChangedMetadata, Menu, MenuItem, Message, MessageAdded, MessageAttributes, MessageDeleted, MessageId, MessageInfo, MessageParentId, MessageProps, MessageReference, MessageSet, Metadata, Metaline, MultiKey, Name, NamedProperty, OAuthConsumerProto, ObjectDefinition, ObjectDisplayOptions, ObjectOptions, ObjectPropertyOptions, ObjectValues, OnClick, OpenCreatedDraftActionMarkup, OpenLink, Operation, OsVersion, OtrChatMessageEvent, OtrModificationEvent, PackagingServiceClient, PaygateInfo, PeopleSuggestion, Person, PersonalLabelTag, PhoneAccess, PhoneNumber, Photo, PinnedItemId, PollItemsRequest, PollItemsResponse, PossiblyTrimmedModel, PostiniUserProto, PreState, PrefDeleted, PrefUpdate, PrefWritten, Presenter, Principal, PrincipalProto, PrivateMessageInfo, ProcessingError, PropertyDefinition, PropertyDisplayOptions, Provenance, PushItem, PushItemRequest, QueryActivity, QueryCountByStatus, QueryInterpretation, QueryInterpretationConfig, QueryInterpretationOptions, QueryItem, QueryOperator, QuerySource, QuerySuggestion, QuotedMessageMetadata, Rank, RbacRoleProto, RbacSubjectProto, ReactionInfo, ReadReceiptsSettingsUpdatedMetadata, Recipient, RecordingEvent, RecordingInfo, RecordingSessionInfo, Reference, References, RemoveActivityRequest, RemoveActivityResponse, RenameEvent, RepositoryError, RequestFileScope, RequestFileScopeForActiveDocument, RequestOptions, RequiredMessageFeaturesMetadata, ResetSearchApplicationRequest, ResourceRoleProto, ResponseDebugInfo, RestrictItem, ResultCounts, ResultDebugInfo, ResultDisplayField, ResultDisplayLine, ResultDisplayMetadata, RetrievalImportance, RoomRenameMetadata, RoomUpdatedMetadata, Roster, RosterId, RpcOptions, SafeHtmlProto, SafeUrlProto, Schema, ScoringConfig, SearchApplication, SearchApplicationQueryStats, SearchApplicationSessionStats, SearchApplicationUserStats, SearchItemsByViewUrlRequest, SearchItemsByViewUrlResponse, SearchLinkData, SearchQualityMetadata, SearchRequest, SearchResponse, SearchResult, Section, Segment, SelectionControl, SelectionItem, SessionContext, SessionEvent, SessionStateInfo, Settings, ShareScope, SheetsClientActionMarkup, SigningKeyPossessorProto, SimpleSecretHolderProto, SimpleSecretLabelProto, SlashCommandMetadata, Snippet, SocialCommonAttachmentAttachment, SocialGraphNodeProto, SortOptions, Source, SourceConfig, SourceCrowdingConfig, SourceMessageInfo, SourceResultCount, SourceScoringConfig, SpaceId, SpellResult, SquareProto, StartUploadItemRequest, Status, StoredParticipantId, StreamViewerStats, StreamingSessionInfo, StructuredDataObject, StructuredResult, SuggestRequest, SuggestResponse, SuggestResult, SupportUrls, SwitchWidget, TaskActionMarkup, TextButton, TextField, TextKeyValue, TextOperatorOptions, TextParagraph, TextPropertyOptions, TextValues, ThreadKeySet, ThreadUpdate, TimestampOperatorOptions, TimestampPropertyOptions, TimestampValues, TombstoneMetadata, Toolbar, TopicId, TopicState, TopicStateUpdate, TransactionContext, TransactionDebugInfo, TranscriptionSessionInfo, TransientData, Trigger, TriggerAction, TriggerKey, Triggers, TrustedResourceUrlProto, TypeInfo, UniversalPhoneAccess, UnmappedIdentity, UnreserveItemsRequest, UpdateBccRecipients, UpdateBody, UpdateCcRecipients, UpdateDataSourceRequest, UpdateDraftActionMarkup, UpdateSchemaRequest, UpdateSubject, UpdateToRecipients, UploadItemRef, UploadMetadata, UrlMetadata, User, UserActivity, UserDisplayInfo, UserId, UserInfo, UserMentionData, UserMentionMetadata, Value, ValueFilter, VideoCallMetadata, VideoInfo, VoicePhoneNumber, VoicePhoneNumberI18nData, VpcSettings, WhiteboardInfo, WidgetMarkup, WonderCardDelete, WonderMessageMapping, WrappedResourceKey, YouTubeBroadcastSessionInfo, YouTubeBroadcastStats, YouTubeLiveBroadcastEvent, YoutubeMetadata, YoutubeUserProto, ZwiebackSessionProto

Constant Summary collapse

GEM_VERSION =

Version of the google-apis-cloudsearch_v1 gem

"0.52.0"
GENERATOR_VERSION =

Version of the code generator used to generate this client

"0.12.0"
REVISION =

Revision of the discovery document this client was generated from

"20230531"
VERSION =

Version of the Cloud Search API this client connects to. This is NOT the gem version.

'V1'
AUTH_CLOUD_SEARCH =

Index and serve your organization's data with Cloud Search

'https://www.googleapis.com/auth/cloud_search'
AUTH_CLOUD_SEARCH_DEBUG =

Index and serve your organization's data with Cloud Search

'https://www.googleapis.com/auth/cloud_search.debug'
AUTH_CLOUD_SEARCH_INDEXING =

Index and serve your organization's data with Cloud Search

'https://www.googleapis.com/auth/cloud_search.indexing'
AUTH_CLOUD_SEARCH_QUERY =

Search your organization's data in the Cloud Search index

'https://www.googleapis.com/auth/cloud_search.query'
AUTH_CLOUD_SEARCH_SETTINGS =

Index and serve your organization's data with Cloud Search

'https://www.googleapis.com/auth/cloud_search.settings'
AUTH_CLOUD_SEARCH_SETTINGS_INDEXING =

Index and serve your organization's data with Cloud Search

'https://www.googleapis.com/auth/cloud_search.settings.indexing'
AUTH_CLOUD_SEARCH_SETTINGS_QUERY =

Index and serve your organization's data with Cloud Search

'https://www.googleapis.com/auth/cloud_search.settings.query'
AUTH_CLOUD_SEARCH_STATS =

Index and serve your organization's data with Cloud Search

'https://www.googleapis.com/auth/cloud_search.stats'
AUTH_CLOUD_SEARCH_STATS_INDEXING =

Index and serve your organization's data with Cloud Search

'https://www.googleapis.com/auth/cloud_search.stats.indexing'