Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Network.Google.CloudSearch
Contents
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- cloudsearch.debug.datasources.items.checkAccess
- cloudsearch.debug.datasources.items.searchByViewUrl
- cloudsearch.debug.datasources.items.unmappedids.list
- cloudsearch.debug.identitysources.items.listForunmappedidentity
- cloudsearch.debug.identitysources.unmappedids.list
- cloudsearch.indexing.datasources.deleteSchema
- cloudsearch.indexing.datasources.getSchema
- cloudsearch.indexing.datasources.items.delete
- cloudsearch.indexing.datasources.items.deleteQueueItems
- cloudsearch.indexing.datasources.items.get
- cloudsearch.indexing.datasources.items.index
- cloudsearch.indexing.datasources.items.list
- cloudsearch.indexing.datasources.items.poll
- cloudsearch.indexing.datasources.items.push
- cloudsearch.indexing.datasources.items.unreserve
- cloudsearch.indexing.datasources.items.upload
- cloudsearch.indexing.datasources.updateSchema
- cloudsearch.media.upload
- cloudsearch.operations.get
- cloudsearch.query.search
- cloudsearch.query.sources.list
- cloudsearch.query.suggest
- cloudsearch.settings.datasources.create
- cloudsearch.settings.datasources.delete
- cloudsearch.settings.datasources.get
- cloudsearch.settings.datasources.list
- cloudsearch.settings.datasources.update
- cloudsearch.settings.searchapplications.create
- cloudsearch.settings.searchapplications.delete
- cloudsearch.settings.searchapplications.get
- cloudsearch.settings.searchapplications.list
- cloudsearch.settings.searchapplications.reset
- cloudsearch.settings.searchapplications.update
- cloudsearch.stats.getIndex
- cloudsearch.stats.index.datasources.get
- Types
- DriveMimeTypeRestrictType
- DriveFollowUpRestrictType
- ItemContent
- Photo
- SearchItemsByViewURLRequest
- SearchApplication
- BooleanOperatorOptions
- Status
- EnumPropertyOptions
- ItemStatusCode
- UnreserveItemsRequest
- DateOperatorOptions
- GetDataSourceIndexStatsResponse
- ObjectDisplayOptions
- QueryItem
- ListUnmAppedIdentitiesResponse
- DeleteQueueItemsRequest
- SearchResult
- SpellResult
- PeopleSuggestion
- QuerySource
- SuggestResponse
- RepositoryError
- QueryInterpretationInterpretationType
- HTMLPropertyOptions
- PropertyDefinition
- SortOptions
- ObjectPropertyOptions
- InteractionType
- QueryOperatorType
- SearchResponse
- SuggestResult
- TextValues
- DriveLocationRestrict
- ListQuerySourcesResponse
- DoubleOperatorOptions
- Operation
- Person
- CompositeFilter
- ResultDisplayLine
- DoubleValues
- Snippet
- TextOperatorOptions
- EnumPropertyOptionsOrderedRanking
- QueryInterpretationOptions
- ResetSearchApplicationRequest
- IntegerPropertyOptionsOrderedRanking
- ItemMetadata
- FilterOptions
- StructuredResult
- ProcessingError
- PushItemType
- ListItemNamesForUnmAppedIdentityResponse
- CompositeFilterLogicOperator
- ItemACL
- Value
- FieldViolation
- SourceScoringConfigSourceImportance
- Metaline
- FacetBucket
- StatusDetailsItem
- RetrievalImportanceImportance
- TimestampOperatorOptions
- ProcessingErrorCode
- IntegerOperatorOptions
- SortOptionsSortOrder
- QuerySuggestion
- ListSearchApplicationsResponse
- ResultDebugInfo
- ItemCountByStatus
- TimestampPropertyOptions
- ResultCounts
- FreshnessOptions
- DebugOptions
- IntegerPropertyOptions
- DataSourceRestriction
- Schema
- DriveTimeSpanRestrict
- ResultDisplayField
- UpdateSchemaRequest
- Date
- DisplayedProperty
- FacetResult
- DriveMimeTypeRestrict
- StructuredDataObject
- Media
- ItemStructuredData
- DriveFollowUpRestrict
- DateValues
- NamedProperty
- MatchRange
- ResponseDebugInfo
- ListDataSourceResponse
- SearchRequest
- Name
- SourceResultCount
- SourceConfig
- UnmAppedIdentityResolutionStatusCode
- ListItemsResponse
- ScoringConfig
- StartUploadItemRequest
- UploadItemRef
- PushItemRequest
- DoublePropertyOptions
- QueryOperator
- Xgafv
- PollItemsResponse
- SourceScoringConfig
- EmailAddress
- RetrievalImportance
- DataSourceIndexStats
- SourceCrowdingConfig
- Interaction
- Principal
- IndexItemRequest
- RepositoryErrorType
- TextPropertyOptions
- EnumValuePair
- DriveLocationRestrictType
- Metadata
- UpdateDataSourceRequest
- DataSource
- HTMLValues
- HTMLOperatorOptions
- Item
- Source
- PropertyDisplayOptions
- ObjectValues
- ObjectOptions
- FacetOptions
- SuggestRequest
- Filter
- ObjectDefinition
- ItemItemType
- ItemCountByStatusStatusCode
- PollItemsRequest
- QueryInterpretation
- UnmAppedIdentity
- OperationMetadata
- CustomerIndexStats
- PushItem
- ErrorMessage
- BooleanPropertyOptions
- ValueFilter
- EnumOperatorOptions
- DatePropertyOptions
- EnumValues
- GSuitePrincipal
- SearchQualityMetadata
- ItemContentContentFormat
- TimestampValues
- ErrorInfo
- ResultDisplayMetadata
- OperationResponse
- IntegerValues
- SearchItemsByViewURLResponse
- SourcePredefinedSource
- GetCustomerIndexStatsResponse
- RestrictItem
- DriveTimeSpanRestrictType
- IndexItemRequestMode
- ItemACLACLInheritanceType
- CheckAccessResponse
- RequestOptions
- ItemStatus
Description
Cloud Search provides cloud-based search capabilities over G Suite data. The Cloud Search API allows indexing of non-G Suite data into Cloud Search.
Synopsis
- cloudSearchService :: ServiceConfig
- cloudSearchSettingsQueryScope :: Proxy '["https://www.googleapis.com/auth/cloud_search.settings.query"]
- cloudSearchStatsIndexingScope :: Proxy '["https://www.googleapis.com/auth/cloud_search.stats.indexing"]
- cloudSearchIndexingScope :: Proxy '["https://www.googleapis.com/auth/cloud_search.indexing"]
- cloudSearchScope :: Proxy '["https://www.googleapis.com/auth/cloud_search"]
- cloudSearchSettingsIndexingScope :: Proxy '["https://www.googleapis.com/auth/cloud_search.settings.indexing"]
- cloudSearchQueryScope :: Proxy '["https://www.googleapis.com/auth/cloud_search.query"]
- cloudSearchDebugScope :: Proxy '["https://www.googleapis.com/auth/cloud_search.debug"]
- cloudSearchStatsScope :: Proxy '["https://www.googleapis.com/auth/cloud_search.stats"]
- cloudSearchSettingsScope :: Proxy '["https://www.googleapis.com/auth/cloud_search.settings"]
- type CloudSearchAPI = SettingsDatasourcesListResource :<|> (SettingsDatasourcesGetResource :<|> (SettingsDatasourcesCreateResource :<|> (SettingsDatasourcesDeleteResource :<|> (SettingsDatasourcesUpdateResource :<|> (SettingsSearchApplicationsListResource :<|> (SettingsSearchApplicationsGetResource :<|> (SettingsSearchApplicationsCreateResource :<|> (SettingsSearchApplicationsResetResource :<|> (SettingsSearchApplicationsDeleteResource :<|> (SettingsSearchApplicationsUpdateResource :<|> (StatsIndexDatasourcesGetResource :<|> (StatsGetIndexResource :<|> (DebugDatasourcesItemsUnmAppedidsListResource :<|> (DebugDatasourcesItemsCheckAccessResource :<|> (DebugDatasourcesItemsSearchByViewURLResource :<|> (DebugIdentitysourcesUnmAppedidsListResource :<|> (DebugIdentitysourcesItemsListForunmAppedidentityResource :<|> (MediaUploadResource :<|> (QuerySourcesListResource :<|> (QuerySuggestResource :<|> (QuerySearchResource :<|> (OperationsGetResource :<|> (IndexingDatasourcesItemsListResource :<|> (IndexingDatasourcesItemsUnreserveResource :<|> (IndexingDatasourcesItemsGetResource :<|> (IndexingDatasourcesItemsDeleteQueueItemsResource :<|> (IndexingDatasourcesItemsPollResource :<|> (IndexingDatasourcesItemsUploadResource :<|> (IndexingDatasourcesItemsIndexResource :<|> (IndexingDatasourcesItemsPushResource :<|> (IndexingDatasourcesItemsDeleteResource :<|> (IndexingDatasourcesGetSchemaResource :<|> (IndexingDatasourcesUpdateSchemaResource :<|> IndexingDatasourcesDeleteSchemaResource)))))))))))))))))))))))))))))))))
- module Network.Google.Resource.CloudSearch.Debug.Datasources.Items.CheckAccess
- module Network.Google.Resource.CloudSearch.Debug.Datasources.Items.SearchByViewURL
- module Network.Google.Resource.CloudSearch.Debug.Datasources.Items.UnmAppedids.List
- module Network.Google.Resource.CloudSearch.Debug.Identitysources.Items.ListForunmAppedidentity
- module Network.Google.Resource.CloudSearch.Debug.Identitysources.UnmAppedids.List
- module Network.Google.Resource.CloudSearch.Indexing.Datasources.DeleteSchema
- module Network.Google.Resource.CloudSearch.Indexing.Datasources.GetSchema
- module Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.Delete
- module Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.DeleteQueueItems
- module Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.Get
- module Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.Index
- module Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.List
- module Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.Poll
- module Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.Push
- module Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.Unreserve
- module Network.Google.Resource.CloudSearch.Indexing.Datasources.Items.Upload
- module Network.Google.Resource.CloudSearch.Indexing.Datasources.UpdateSchema
- module Network.Google.Resource.CloudSearch.Media.Upload
- module Network.Google.Resource.CloudSearch.Operations.Get
- module Network.Google.Resource.CloudSearch.Query.Search
- module Network.Google.Resource.CloudSearch.Query.Sources.List
- module Network.Google.Resource.CloudSearch.Query.Suggest
- module Network.Google.Resource.CloudSearch.Settings.Datasources.Create
- module Network.Google.Resource.CloudSearch.Settings.Datasources.Delete
- module Network.Google.Resource.CloudSearch.Settings.Datasources.Get
- module Network.Google.Resource.CloudSearch.Settings.Datasources.List
- module Network.Google.Resource.CloudSearch.Settings.Datasources.Update
- module Network.Google.Resource.CloudSearch.Settings.SearchApplications.Create
- module Network.Google.Resource.CloudSearch.Settings.SearchApplications.Delete
- module Network.Google.Resource.CloudSearch.Settings.SearchApplications.Get
- module Network.Google.Resource.CloudSearch.Settings.SearchApplications.List
- module Network.Google.Resource.CloudSearch.Settings.SearchApplications.Reset
- module Network.Google.Resource.CloudSearch.Settings.SearchApplications.Update
- module Network.Google.Resource.CloudSearch.Stats.GetIndex
- module Network.Google.Resource.CloudSearch.Stats.Index.Datasources.Get
- data DriveMimeTypeRestrictType
- = Unspecified
- | Document
- | Presentation
- | Spreadsheet
- | Form
- | Drawing
- | Script
- | Map
- | Image
- | Audio
- | Video
- | Folder
- | Archive
- | Site
- data DriveFollowUpRestrictType
- data ItemContent
- itemContent :: ItemContent
- icHash :: Lens' ItemContent (Maybe Text)
- icContentFormat :: Lens' ItemContent (Maybe ItemContentContentFormat)
- icContentDataRef :: Lens' ItemContent (Maybe UploadItemRef)
- icInlineContent :: Lens' ItemContent (Maybe ByteString)
- data Photo
- photo :: Photo
- pURL :: Lens' Photo (Maybe Text)
- data SearchItemsByViewURLRequest
- searchItemsByViewURLRequest :: SearchItemsByViewURLRequest
- sibvurDebugOptions :: Lens' SearchItemsByViewURLRequest (Maybe DebugOptions)
- sibvurPageToken :: Lens' SearchItemsByViewURLRequest (Maybe Text)
- sibvurViewURL :: Lens' SearchItemsByViewURLRequest (Maybe Text)
- data SearchApplication
- searchApplication :: SearchApplication
- saDataSourceRestrictions :: Lens' SearchApplication [DataSourceRestriction]
- saOperationIds :: Lens' SearchApplication [Text]
- saDefaultFacetOptions :: Lens' SearchApplication [FacetOptions]
- saScoringConfig :: Lens' SearchApplication (Maybe ScoringConfig)
- saName :: Lens' SearchApplication (Maybe Text)
- saSourceConfig :: Lens' SearchApplication [SourceConfig]
- saDisplayName :: Lens' SearchApplication (Maybe Text)
- saDefaultSortOptions :: Lens' SearchApplication (Maybe SortOptions)
- data BooleanOperatorOptions
- booleanOperatorOptions :: BooleanOperatorOptions
- booOperatorName :: Lens' BooleanOperatorOptions (Maybe Text)
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data EnumPropertyOptions
- enumPropertyOptions :: EnumPropertyOptions
- epoPossibleValues :: Lens' EnumPropertyOptions [EnumValuePair]
- epoOrderedRanking :: Lens' EnumPropertyOptions (Maybe EnumPropertyOptionsOrderedRanking)
- epoOperatorOptions :: Lens' EnumPropertyOptions (Maybe EnumOperatorOptions)
- data ItemStatusCode
- data UnreserveItemsRequest
- unreserveItemsRequest :: UnreserveItemsRequest
- uirQueue :: Lens' UnreserveItemsRequest (Maybe Text)
- uirDebugOptions :: Lens' UnreserveItemsRequest (Maybe DebugOptions)
- uirConnectorName :: Lens' UnreserveItemsRequest (Maybe Text)
- data DateOperatorOptions
- dateOperatorOptions :: DateOperatorOptions
- dooOperatorName :: Lens' DateOperatorOptions (Maybe Text)
- dooLessThanOperatorName :: Lens' DateOperatorOptions (Maybe Text)
- dooGreaterThanOperatorName :: Lens' DateOperatorOptions (Maybe Text)
- data GetDataSourceIndexStatsResponse
- getDataSourceIndexStatsResponse :: GetDataSourceIndexStatsResponse
- gdsisrStats :: Lens' GetDataSourceIndexStatsResponse [DataSourceIndexStats]
- data ObjectDisplayOptions
- objectDisplayOptions :: ObjectDisplayOptions
- odoMetalines :: Lens' ObjectDisplayOptions [Metaline]
- odoObjectDisplayLabel :: Lens' ObjectDisplayOptions (Maybe Text)
- data QueryItem
- queryItem :: QueryItem
- qiIsSynthetic :: Lens' QueryItem (Maybe Bool)
- data ListUnmAppedIdentitiesResponse
- listUnmAppedIdentitiesResponse :: ListUnmAppedIdentitiesResponse
- luairNextPageToken :: Lens' ListUnmAppedIdentitiesResponse (Maybe Text)
- luairUnmAppedIdentities :: Lens' ListUnmAppedIdentitiesResponse [UnmAppedIdentity]
- data DeleteQueueItemsRequest
- deleteQueueItemsRequest :: DeleteQueueItemsRequest
- dqirQueue :: Lens' DeleteQueueItemsRequest (Maybe Text)
- dqirDebugOptions :: Lens' DeleteQueueItemsRequest (Maybe DebugOptions)
- dqirConnectorName :: Lens' DeleteQueueItemsRequest (Maybe Text)
- data SearchResult
- searchResult :: SearchResult
- srDebugInfo :: Lens' SearchResult (Maybe ResultDebugInfo)
- srSnippet :: Lens' SearchResult (Maybe Snippet)
- srURL :: Lens' SearchResult (Maybe Text)
- srClusteredResults :: Lens' SearchResult [SearchResult]
- srMetadata :: Lens' SearchResult (Maybe Metadata)
- srTitle :: Lens' SearchResult (Maybe Text)
- data SpellResult
- spellResult :: SpellResult
- srSuggestedQuery :: Lens' SpellResult (Maybe Text)
- data PeopleSuggestion
- peopleSuggestion :: PeopleSuggestion
- psPerson :: Lens' PeopleSuggestion (Maybe Person)
- data QuerySource
- querySource :: QuerySource
- qsShortName :: Lens' QuerySource (Maybe Text)
- qsDisplayName :: Lens' QuerySource (Maybe Text)
- qsSource :: Lens' QuerySource (Maybe Source)
- qsOperators :: Lens' QuerySource [QueryOperator]
- data SuggestResponse
- suggestResponse :: SuggestResponse
- srSuggestResults :: Lens' SuggestResponse [SuggestResult]
- data RepositoryError
- repositoryError :: RepositoryError
- reHTTPStatusCode :: Lens' RepositoryError (Maybe Int32)
- reType :: Lens' RepositoryError (Maybe RepositoryErrorType)
- reErrorMessage :: Lens' RepositoryError (Maybe Text)
- data QueryInterpretationInterpretationType
- data HTMLPropertyOptions
- htmlPropertyOptions :: HTMLPropertyOptions
- hpoRetrievalImportance :: Lens' HTMLPropertyOptions (Maybe RetrievalImportance)
- hpoOperatorOptions :: Lens' HTMLPropertyOptions (Maybe HTMLOperatorOptions)
- data PropertyDefinition
- propertyDefinition :: PropertyDefinition
- pdEnumPropertyOptions :: Lens' PropertyDefinition (Maybe EnumPropertyOptions)
- pdHTMLPropertyOptions :: Lens' PropertyDefinition (Maybe HTMLPropertyOptions)
- pdObjectPropertyOptions :: Lens' PropertyDefinition (Maybe ObjectPropertyOptions)
- pdIsReturnable :: Lens' PropertyDefinition (Maybe Bool)
- pdTimestampPropertyOptions :: Lens' PropertyDefinition (Maybe TimestampPropertyOptions)
- pdIntegerPropertyOptions :: Lens' PropertyDefinition (Maybe IntegerPropertyOptions)
- pdName :: Lens' PropertyDefinition (Maybe Text)
- pdIsRepeatable :: Lens' PropertyDefinition (Maybe Bool)
- pdDoublePropertyOptions :: Lens' PropertyDefinition (Maybe DoublePropertyOptions)
- pdDisplayOptions :: Lens' PropertyDefinition (Maybe PropertyDisplayOptions)
- pdTextPropertyOptions :: Lens' PropertyDefinition (Maybe TextPropertyOptions)
- pdIsSortable :: Lens' PropertyDefinition (Maybe Bool)
- pdIsFacetable :: Lens' PropertyDefinition (Maybe Bool)
- pdBooleanPropertyOptions :: Lens' PropertyDefinition (Maybe BooleanPropertyOptions)
- pdDatePropertyOptions :: Lens' PropertyDefinition (Maybe DatePropertyOptions)
- data SortOptions
- sortOptions :: SortOptions
- soSortOrder :: Lens' SortOptions (Maybe SortOptionsSortOrder)
- soOperatorName :: Lens' SortOptions (Maybe Text)
- data ObjectPropertyOptions
- objectPropertyOptions :: ObjectPropertyOptions
- opoSubobjectProperties :: Lens' ObjectPropertyOptions [PropertyDefinition]
- data InteractionType
- data QueryOperatorType
- data SearchResponse
- searchResponse :: SearchResponse
- sSpellResults :: Lens' SearchResponse [SpellResult]
- sFacetResults :: Lens' SearchResponse [FacetResult]
- sDebugInfo :: Lens' SearchResponse (Maybe ResponseDebugInfo)
- sResults :: Lens' SearchResponse [SearchResult]
- sHasMoreResults :: Lens' SearchResponse (Maybe Bool)
- sResultCounts :: Lens' SearchResponse (Maybe ResultCounts)
- sResultCountExact :: Lens' SearchResponse (Maybe Int64)
- sResultCountEstimate :: Lens' SearchResponse (Maybe Int64)
- sQueryInterpretation :: Lens' SearchResponse (Maybe QueryInterpretation)
- sStructuredResults :: Lens' SearchResponse [StructuredResult]
- sErrorInfo :: Lens' SearchResponse (Maybe ErrorInfo)
- data SuggestResult
- suggestResult :: SuggestResult
- sPeopleSuggestion :: Lens' SuggestResult (Maybe PeopleSuggestion)
- sQuerySuggestion :: Lens' SuggestResult (Maybe QuerySuggestion)
- sSuggestedQuery :: Lens' SuggestResult (Maybe Text)
- sSource :: Lens' SuggestResult (Maybe Source)
- data TextValues
- textValues :: TextValues
- tvValues :: Lens' TextValues [Text]
- data DriveLocationRestrict
- driveLocationRestrict :: DriveLocationRestrict
- dlrType :: Lens' DriveLocationRestrict (Maybe DriveLocationRestrictType)
- data ListQuerySourcesResponse
- listQuerySourcesResponse :: ListQuerySourcesResponse
- lqsrNextPageToken :: Lens' ListQuerySourcesResponse (Maybe Text)
- lqsrSources :: Lens' ListQuerySourcesResponse [QuerySource]
- data DoubleOperatorOptions
- doubleOperatorOptions :: DoubleOperatorOptions
- dOperatorName :: Lens' DoubleOperatorOptions (Maybe Text)
- data Operation
- operation :: Operation
- oDone :: Lens' Operation (Maybe Bool)
- oError :: Lens' Operation (Maybe Status)
- oResponse :: Lens' Operation (Maybe OperationResponse)
- oName :: Lens' Operation (Maybe Text)
- oMetadata :: Lens' Operation (Maybe OperationMetadata)
- data Person
- person :: Person
- pEmailAddresses :: Lens' Person [EmailAddress]
- pPersonNames :: Lens' Person [Name]
- pPhotos :: Lens' Person [Photo]
- pName :: Lens' Person (Maybe Text)
- pObfuscatedId :: Lens' Person (Maybe Text)
- data CompositeFilter
- compositeFilter :: CompositeFilter
- cfSubFilters :: Lens' CompositeFilter [Filter]
- cfLogicOperator :: Lens' CompositeFilter (Maybe CompositeFilterLogicOperator)
- data ResultDisplayLine
- resultDisplayLine :: ResultDisplayLine
- rdlFields :: Lens' ResultDisplayLine [ResultDisplayField]
- data DoubleValues
- doubleValues :: DoubleValues
- dvValues :: Lens' DoubleValues [Double]
- data Snippet
- snippet :: Snippet
- sMatchRanges :: Lens' Snippet [MatchRange]
- sSnippet :: Lens' Snippet (Maybe Text)
- data TextOperatorOptions
- textOperatorOptions :: TextOperatorOptions
- tooOperatorName :: Lens' TextOperatorOptions (Maybe Text)
- tooExactMatchWithOperator :: Lens' TextOperatorOptions (Maybe Bool)
- data EnumPropertyOptionsOrderedRanking
- data QueryInterpretationOptions
- queryInterpretationOptions :: QueryInterpretationOptions
- qioDisableNlInterpretation :: Lens' QueryInterpretationOptions (Maybe Bool)
- data ResetSearchApplicationRequest
- resetSearchApplicationRequest :: ResetSearchApplicationRequest
- rsarDebugOptions :: Lens' ResetSearchApplicationRequest (Maybe DebugOptions)
- data IntegerPropertyOptionsOrderedRanking
- data ItemMetadata
- itemMetadata :: ItemMetadata
- imSourceRepositoryURL :: Lens' ItemMetadata (Maybe Text)
- imHash :: Lens' ItemMetadata (Maybe Text)
- imObjectType :: Lens' ItemMetadata (Maybe Text)
- imContainerName :: Lens' ItemMetadata (Maybe Text)
- imInteractions :: Lens' ItemMetadata [Interaction]
- imMimeType :: Lens' ItemMetadata (Maybe Text)
- imUpdateTime :: Lens' ItemMetadata (Maybe UTCTime)
- imKeywords :: Lens' ItemMetadata [Text]
- imTitle :: Lens' ItemMetadata (Maybe Text)
- imContentLanguage :: Lens' ItemMetadata (Maybe Text)
- imSearchQualityMetadata :: Lens' ItemMetadata (Maybe SearchQualityMetadata)
- imCreateTime :: Lens' ItemMetadata (Maybe UTCTime)
- data FilterOptions
- filterOptions :: FilterOptions
- foObjectType :: Lens' FilterOptions (Maybe Text)
- foFilter :: Lens' FilterOptions (Maybe Filter)
- data StructuredResult
- structuredResult :: StructuredResult
- srPerson :: Lens' StructuredResult (Maybe Person)
- data ProcessingError
- processingError :: ProcessingError
- peFieldViolations :: Lens' ProcessingError [FieldViolation]
- peCode :: Lens' ProcessingError (Maybe ProcessingErrorCode)
- peErrorMessage :: Lens' ProcessingError (Maybe Text)
- data PushItemType
- data ListItemNamesForUnmAppedIdentityResponse
- listItemNamesForUnmAppedIdentityResponse :: ListItemNamesForUnmAppedIdentityResponse
- linfuairNextPageToken :: Lens' ListItemNamesForUnmAppedIdentityResponse (Maybe Text)
- linfuairItemNames :: Lens' ListItemNamesForUnmAppedIdentityResponse [Text]
- data CompositeFilterLogicOperator
- data ItemACL
- itemACL :: ItemACL
- iaOwners :: Lens' ItemACL [Principal]
- iaReaders :: Lens' ItemACL [Principal]
- iaACLInheritanceType :: Lens' ItemACL (Maybe ItemACLACLInheritanceType)
- iaInheritACLFrom :: Lens' ItemACL (Maybe Text)
- iaDeniedReaders :: Lens' ItemACL [Principal]
- data Value
- value :: Value
- vIntegerValue :: Lens' Value (Maybe Int64)
- vTimestampValue :: Lens' Value (Maybe UTCTime)
- vDoubleValue :: Lens' Value (Maybe Double)
- vStringValue :: Lens' Value (Maybe Text)
- vDateValue :: Lens' Value (Maybe Date)
- vBooleanValue :: Lens' Value (Maybe Bool)
- data FieldViolation
- fieldViolation :: FieldViolation
- fvField :: Lens' FieldViolation (Maybe Text)
- fvDescription :: Lens' FieldViolation (Maybe Text)
- data SourceScoringConfigSourceImportance
- data Metaline
- metaline :: Metaline
- mProperties :: Lens' Metaline [DisplayedProperty]
- data FacetBucket
- facetBucket :: FacetBucket
- fbValue :: Lens' FacetBucket (Maybe Value)
- fbCount :: Lens' FacetBucket (Maybe Int32)
- fbPercentage :: Lens' FacetBucket (Maybe Int32)
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data RetrievalImportanceImportance
- = RIIDefault
- | RIIHighest
- | RIIHigh
- | RIILow
- | RIINone
- data TimestampOperatorOptions
- timestampOperatorOptions :: TimestampOperatorOptions
- tOperatorName :: Lens' TimestampOperatorOptions (Maybe Text)
- tLessThanOperatorName :: Lens' TimestampOperatorOptions (Maybe Text)
- tGreaterThanOperatorName :: Lens' TimestampOperatorOptions (Maybe Text)
- data ProcessingErrorCode
- data IntegerOperatorOptions
- integerOperatorOptions :: IntegerOperatorOptions
- iooOperatorName :: Lens' IntegerOperatorOptions (Maybe Text)
- iooLessThanOperatorName :: Lens' IntegerOperatorOptions (Maybe Text)
- iooGreaterThanOperatorName :: Lens' IntegerOperatorOptions (Maybe Text)
- data SortOptionsSortOrder
- data QuerySuggestion
- querySuggestion :: QuerySuggestion
- data ListSearchApplicationsResponse
- listSearchApplicationsResponse :: ListSearchApplicationsResponse
- lsarNextPageToken :: Lens' ListSearchApplicationsResponse (Maybe Text)
- lsarSearchApplications :: Lens' ListSearchApplicationsResponse [SearchApplication]
- data ResultDebugInfo
- resultDebugInfo :: ResultDebugInfo
- rdiFormattedDebugInfo :: Lens' ResultDebugInfo (Maybe Text)
- data ItemCountByStatus
- itemCountByStatus :: ItemCountByStatus
- icbsCount :: Lens' ItemCountByStatus (Maybe Int64)
- icbsStatusCode :: Lens' ItemCountByStatus (Maybe ItemCountByStatusStatusCode)
- data TimestampPropertyOptions
- timestampPropertyOptions :: TimestampPropertyOptions
- tpoOperatorOptions :: Lens' TimestampPropertyOptions (Maybe TimestampOperatorOptions)
- data ResultCounts
- resultCounts :: ResultCounts
- rcSourceResultCounts :: Lens' ResultCounts [SourceResultCount]
- data FreshnessOptions
- freshnessOptions :: FreshnessOptions
- foFreshnessDuration :: Lens' FreshnessOptions (Maybe Scientific)
- foFreshnessProperty :: Lens' FreshnessOptions (Maybe Text)
- data DebugOptions
- debugOptions :: DebugOptions
- doEnableDebugging :: Lens' DebugOptions (Maybe Bool)
- data IntegerPropertyOptions
- integerPropertyOptions :: IntegerPropertyOptions
- ipoMaximumValue :: Lens' IntegerPropertyOptions (Maybe Int64)
- ipoOrderedRanking :: Lens' IntegerPropertyOptions (Maybe IntegerPropertyOptionsOrderedRanking)
- ipoMinimumValue :: Lens' IntegerPropertyOptions (Maybe Int64)
- ipoOperatorOptions :: Lens' IntegerPropertyOptions (Maybe IntegerOperatorOptions)
- data DataSourceRestriction
- dataSourceRestriction :: DataSourceRestriction
- dsrFilterOptions :: Lens' DataSourceRestriction [FilterOptions]
- dsrSource :: Lens' DataSourceRestriction (Maybe Source)
- data Schema
- schema :: Schema
- sObjectDefinitions :: Lens' Schema [ObjectDefinition]
- sOperationIds :: Lens' Schema [Text]
- data DriveTimeSpanRestrict
- driveTimeSpanRestrict :: DriveTimeSpanRestrict
- dtsrType :: Lens' DriveTimeSpanRestrict (Maybe DriveTimeSpanRestrictType)
- data ResultDisplayField
- resultDisplayField :: ResultDisplayField
- rdfProperty :: Lens' ResultDisplayField (Maybe NamedProperty)
- rdfOperatorName :: Lens' ResultDisplayField (Maybe Text)
- rdfLabel :: Lens' ResultDisplayField (Maybe Text)
- data UpdateSchemaRequest
- updateSchemaRequest :: UpdateSchemaRequest
- usrValidateOnly :: Lens' UpdateSchemaRequest (Maybe Bool)
- usrSchema :: Lens' UpdateSchemaRequest (Maybe Schema)
- usrDebugOptions :: Lens' UpdateSchemaRequest (Maybe DebugOptions)
- data Date
- date :: Date
- dDay :: Lens' Date (Maybe Int32)
- dYear :: Lens' Date (Maybe Int32)
- dMonth :: Lens' Date (Maybe Int32)
- data DisplayedProperty
- displayedProperty :: DisplayedProperty
- dpPropertyName :: Lens' DisplayedProperty (Maybe Text)
- data FacetResult
- facetResult :: FacetResult
- frSourceName :: Lens' FacetResult (Maybe Text)
- frBuckets :: Lens' FacetResult [FacetBucket]
- frObjectType :: Lens' FacetResult (Maybe Text)
- frOperatorName :: Lens' FacetResult (Maybe Text)
- data DriveMimeTypeRestrict
- driveMimeTypeRestrict :: DriveMimeTypeRestrict
- dmtrType :: Lens' DriveMimeTypeRestrict (Maybe DriveMimeTypeRestrictType)
- data StructuredDataObject
- structuredDataObject :: StructuredDataObject
- sdoProperties :: Lens' StructuredDataObject [NamedProperty]
- data Media
- media :: Media
- mResourceName :: Lens' Media (Maybe Text)
- data ItemStructuredData
- itemStructuredData :: ItemStructuredData
- isdHash :: Lens' ItemStructuredData (Maybe Text)
- isdObject :: Lens' ItemStructuredData (Maybe StructuredDataObject)
- data DriveFollowUpRestrict
- driveFollowUpRestrict :: DriveFollowUpRestrict
- dfurType :: Lens' DriveFollowUpRestrict (Maybe DriveFollowUpRestrictType)
- data DateValues
- dateValues :: DateValues
- dValues :: Lens' DateValues [Date]
- data NamedProperty
- namedProperty :: NamedProperty
- npDoubleValues :: Lens' NamedProperty (Maybe DoubleValues)
- npTextValues :: Lens' NamedProperty (Maybe TextValues)
- npDateValues :: Lens' NamedProperty (Maybe DateValues)
- npName :: Lens' NamedProperty (Maybe Text)
- npBooleanValue :: Lens' NamedProperty (Maybe Bool)
- npObjectValues :: Lens' NamedProperty (Maybe ObjectValues)
- npHTMLValues :: Lens' NamedProperty (Maybe HTMLValues)
- npEnumValues :: Lens' NamedProperty (Maybe EnumValues)
- npTimestampValues :: Lens' NamedProperty (Maybe TimestampValues)
- npIntegerValues :: Lens' NamedProperty (Maybe IntegerValues)
- data MatchRange
- matchRange :: MatchRange
- mrStart :: Lens' MatchRange (Maybe Int32)
- mrEnd :: Lens' MatchRange (Maybe Int32)
- data ResponseDebugInfo
- responseDebugInfo :: ResponseDebugInfo
- rFormattedDebugInfo :: Lens' ResponseDebugInfo (Maybe Text)
- data ListDataSourceResponse
- listDataSourceResponse :: ListDataSourceResponse
- ldsrNextPageToken :: Lens' ListDataSourceResponse (Maybe Text)
- ldsrSources :: Lens' ListDataSourceResponse [DataSource]
- data SearchRequest
- searchRequest :: SearchRequest
- srSortOptions :: Lens' SearchRequest (Maybe SortOptions)
- srDataSourceRestrictions :: Lens' SearchRequest [DataSourceRestriction]
- srQueryInterpretationOptions :: Lens' SearchRequest (Maybe QueryInterpretationOptions)
- srStart :: Lens' SearchRequest (Maybe Int32)
- srQuery :: Lens' SearchRequest (Maybe Text)
- srFacetOptions :: Lens' SearchRequest [FacetOptions]
- srPageSize :: Lens' SearchRequest (Maybe Int32)
- srRequestOptions :: Lens' SearchRequest (Maybe RequestOptions)
- data Name
- name :: Name
- nDisplayName :: Lens' Name (Maybe Text)
- data SourceResultCount
- sourceResultCount :: SourceResultCount
- srcHasMoreResults :: Lens' SourceResultCount (Maybe Bool)
- srcResultCountExact :: Lens' SourceResultCount (Maybe Int64)
- srcResultCountEstimate :: Lens' SourceResultCount (Maybe Int64)
- srcSource :: Lens' SourceResultCount (Maybe Source)
- data SourceConfig
- sourceConfig :: SourceConfig
- scCrowdingConfig :: Lens' SourceConfig (Maybe SourceCrowdingConfig)
- scScoringConfig :: Lens' SourceConfig (Maybe SourceScoringConfig)
- scSource :: Lens' SourceConfig (Maybe Source)
- data UnmAppedIdentityResolutionStatusCode
- data ListItemsResponse
- listItemsResponse :: ListItemsResponse
- lirNextPageToken :: Lens' ListItemsResponse (Maybe Text)
- lirItems :: Lens' ListItemsResponse [Item]
- data ScoringConfig
- scoringConfig :: ScoringConfig
- scDisablePersonalization :: Lens' ScoringConfig (Maybe Bool)
- scDisableFreshness :: Lens' ScoringConfig (Maybe Bool)
- data StartUploadItemRequest
- startUploadItemRequest :: StartUploadItemRequest
- suirDebugOptions :: Lens' StartUploadItemRequest (Maybe DebugOptions)
- suirConnectorName :: Lens' StartUploadItemRequest (Maybe Text)
- data UploadItemRef
- uploadItemRef :: UploadItemRef
- uirName :: Lens' UploadItemRef (Maybe Text)
- data PushItemRequest
- pushItemRequest :: PushItemRequest
- pirDebugOptions :: Lens' PushItemRequest (Maybe DebugOptions)
- pirConnectorName :: Lens' PushItemRequest (Maybe Text)
- pirItem :: Lens' PushItemRequest (Maybe PushItem)
- data DoublePropertyOptions
- doublePropertyOptions :: DoublePropertyOptions
- dpoOperatorOptions :: Lens' DoublePropertyOptions (Maybe DoubleOperatorOptions)
- data QueryOperator
- queryOperator :: QueryOperator
- qoIsSuggestable :: Lens' QueryOperator (Maybe Bool)
- qoIsReturnable :: Lens' QueryOperator (Maybe Bool)
- qoIsRepeatable :: Lens' QueryOperator (Maybe Bool)
- qoOperatorName :: Lens' QueryOperator (Maybe Text)
- qoIsSortable :: Lens' QueryOperator (Maybe Bool)
- qoIsFacetable :: Lens' QueryOperator (Maybe Bool)
- qoDisplayName :: Lens' QueryOperator (Maybe Text)
- qoLessThanOperatorName :: Lens' QueryOperator (Maybe Text)
- qoType :: Lens' QueryOperator (Maybe QueryOperatorType)
- qoEnumValues :: Lens' QueryOperator [Text]
- qoGreaterThanOperatorName :: Lens' QueryOperator (Maybe Text)
- data Xgafv
- data PollItemsResponse
- pollItemsResponse :: PollItemsResponse
- pirItems :: Lens' PollItemsResponse [Item]
- data SourceScoringConfig
- sourceScoringConfig :: SourceScoringConfig
- sscSourceImportance :: Lens' SourceScoringConfig (Maybe SourceScoringConfigSourceImportance)
- data EmailAddress
- emailAddress :: EmailAddress
- eaEmailAddress :: Lens' EmailAddress (Maybe Text)
- data RetrievalImportance
- retrievalImportance :: RetrievalImportance
- riImportance :: Lens' RetrievalImportance (Maybe RetrievalImportanceImportance)
- data DataSourceIndexStats
- dataSourceIndexStats :: DataSourceIndexStats
- dsisItemCountByStatus :: Lens' DataSourceIndexStats [ItemCountByStatus]
- dsisDate :: Lens' DataSourceIndexStats (Maybe Date)
- data SourceCrowdingConfig
- sourceCrowdingConfig :: SourceCrowdingConfig
- sccField :: Lens' SourceCrowdingConfig (Maybe Text)
- sccNumSuggestions :: Lens' SourceCrowdingConfig (Maybe Int32)
- sccNumResults :: Lens' SourceCrowdingConfig (Maybe Int32)
- sccSource :: Lens' SourceCrowdingConfig (Maybe Bool)
- data Interaction
- interaction :: Interaction
- iInteractionTime :: Lens' Interaction (Maybe UTCTime)
- iPrincipal :: Lens' Interaction (Maybe Principal)
- iType :: Lens' Interaction (Maybe InteractionType)
- data Principal
- principal :: Principal
- pUserResourceName :: Lens' Principal (Maybe Text)
- pGroupResourceName :: Lens' Principal (Maybe Text)
- pGsuitePrincipal :: Lens' Principal (Maybe GSuitePrincipal)
- data IndexItemRequest
- indexItemRequest :: IndexItemRequest
- iirMode :: Lens' IndexItemRequest (Maybe IndexItemRequestMode)
- iirDebugOptions :: Lens' IndexItemRequest (Maybe DebugOptions)
- iirConnectorName :: Lens' IndexItemRequest (Maybe Text)
- iirItem :: Lens' IndexItemRequest (Maybe Item)
- data RepositoryErrorType
- data TextPropertyOptions
- textPropertyOptions :: TextPropertyOptions
- tRetrievalImportance :: Lens' TextPropertyOptions (Maybe RetrievalImportance)
- tOperatorOptions :: Lens' TextPropertyOptions (Maybe TextOperatorOptions)
- data EnumValuePair
- enumValuePair :: EnumValuePair
- evpIntegerValue :: Lens' EnumValuePair (Maybe Int32)
- evpStringValue :: Lens' EnumValuePair (Maybe Text)
- data DriveLocationRestrictType
- data Metadata
- metadata :: Metadata
- mObjectType :: Lens' Metadata (Maybe Text)
- mOwner :: Lens' Metadata (Maybe Person)
- mMimeType :: Lens' Metadata (Maybe Text)
- mUpdateTime :: Lens' Metadata (Maybe UTCTime)
- mDisplayOptions :: Lens' Metadata (Maybe ResultDisplayMetadata)
- mSource :: Lens' Metadata (Maybe Source)
- mCreateTime :: Lens' Metadata (Maybe UTCTime)
- mFields :: Lens' Metadata [NamedProperty]
- data UpdateDataSourceRequest
- updateDataSourceRequest :: UpdateDataSourceRequest
- udsrDebugOptions :: Lens' UpdateDataSourceRequest (Maybe DebugOptions)
- udsrSource :: Lens' UpdateDataSourceRequest (Maybe DataSource)
- data DataSource
- dataSource :: DataSource
- dsShortName :: Lens' DataSource (Maybe Text)
- dsItemsVisibility :: Lens' DataSource [GSuitePrincipal]
- dsOperationIds :: Lens' DataSource [Text]
- dsDisableServing :: Lens' DataSource (Maybe Bool)
- dsIndexingServiceAccounts :: Lens' DataSource [Text]
- dsDisableModifications :: Lens' DataSource (Maybe Bool)
- dsName :: Lens' DataSource (Maybe Text)
- dsDisplayName :: Lens' DataSource (Maybe Text)
- data HTMLValues
- htmlValues :: HTMLValues
- hvValues :: Lens' HTMLValues [Text]
- data HTMLOperatorOptions
- htmlOperatorOptions :: HTMLOperatorOptions
- hooOperatorName :: Lens' HTMLOperatorOptions (Maybe Text)
- data Item
- item :: Item
- iStatus :: Lens' Item (Maybe ItemStatus)
- iItemType :: Lens' Item (Maybe ItemItemType)
- iPayload :: Lens' Item (Maybe ByteString)
- iStructuredData :: Lens' Item (Maybe ItemStructuredData)
- iQueue :: Lens' Item (Maybe Text)
- iContent :: Lens' Item (Maybe ItemContent)
- iName :: Lens' Item (Maybe Text)
- iVersion :: Lens' Item (Maybe ByteString)
- iMetadata :: Lens' Item (Maybe ItemMetadata)
- iACL :: Lens' Item (Maybe ItemACL)
- data Source
- source :: Source
- sName :: Lens' Source (Maybe Text)
- sPredefinedSource :: Lens' Source (Maybe SourcePredefinedSource)
- data PropertyDisplayOptions
- propertyDisplayOptions :: PropertyDisplayOptions
- pdoDisplayLabel :: Lens' PropertyDisplayOptions (Maybe Text)
- data ObjectValues
- objectValues :: ObjectValues
- ovValues :: Lens' ObjectValues [StructuredDataObject]
- data ObjectOptions
- objectOptions :: ObjectOptions
- ooFreshnessOptions :: Lens' ObjectOptions (Maybe FreshnessOptions)
- ooDisplayOptions :: Lens' ObjectOptions (Maybe ObjectDisplayOptions)
- data FacetOptions
- facetOptions :: FacetOptions
- fSourceName :: Lens' FacetOptions (Maybe Text)
- fObjectType :: Lens' FacetOptions (Maybe Text)
- fOperatorName :: Lens' FacetOptions (Maybe Text)
- data SuggestRequest
- suggestRequest :: SuggestRequest
- sDataSourceRestrictions :: Lens' SuggestRequest [DataSourceRestriction]
- sQuery :: Lens' SuggestRequest (Maybe Text)
- sRequestOptions :: Lens' SuggestRequest (Maybe RequestOptions)
- data Filter
- filter' :: Filter
- fCompositeFilter :: Lens' Filter (Maybe CompositeFilter)
- fValueFilter :: Lens' Filter (Maybe ValueFilter)
- data ObjectDefinition
- objectDefinition :: ObjectDefinition
- odName :: Lens' ObjectDefinition (Maybe Text)
- odOptions :: Lens' ObjectDefinition (Maybe ObjectOptions)
- odPropertyDefinitions :: Lens' ObjectDefinition [PropertyDefinition]
- data ItemItemType
- data ItemCountByStatusStatusCode
- data PollItemsRequest
- pollItemsRequest :: PollItemsRequest
- pQueue :: Lens' PollItemsRequest (Maybe Text)
- pDebugOptions :: Lens' PollItemsRequest (Maybe DebugOptions)
- pConnectorName :: Lens' PollItemsRequest (Maybe Text)
- pStatusCodes :: Lens' PollItemsRequest [Text]
- pLimit :: Lens' PollItemsRequest (Maybe Int32)
- data QueryInterpretation
- queryInterpretation :: QueryInterpretation
- qiInterpretedQuery :: Lens' QueryInterpretation (Maybe Text)
- qiInterpretationType :: Lens' QueryInterpretation (Maybe QueryInterpretationInterpretationType)
- data UnmAppedIdentity
- unmAppedIdentity :: UnmAppedIdentity
- uaiResolutionStatusCode :: Lens' UnmAppedIdentity (Maybe UnmAppedIdentityResolutionStatusCode)
- uaiExternalIdentity :: Lens' UnmAppedIdentity (Maybe Principal)
- data OperationMetadata
- operationMetadata :: HashMap Text JSONValue -> OperationMetadata
- omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue)
- data CustomerIndexStats
- customerIndexStats :: CustomerIndexStats
- cisItemCountByStatus :: Lens' CustomerIndexStats [ItemCountByStatus]
- cisDate :: Lens' CustomerIndexStats (Maybe Date)
- data PushItem
- pushItem :: PushItem
- piRepositoryError :: Lens' PushItem (Maybe RepositoryError)
- piContentHash :: Lens' PushItem (Maybe Text)
- piStructuredDataHash :: Lens' PushItem (Maybe Text)
- piPayload :: Lens' PushItem (Maybe ByteString)
- piQueue :: Lens' PushItem (Maybe Text)
- piMetadataHash :: Lens' PushItem (Maybe Text)
- piType :: Lens' PushItem (Maybe PushItemType)
- data ErrorMessage
- errorMessage :: ErrorMessage
- emSource :: Lens' ErrorMessage (Maybe Source)
- emErrorMessage :: Lens' ErrorMessage (Maybe Text)
- data BooleanPropertyOptions
- booleanPropertyOptions :: BooleanPropertyOptions
- bpoOperatorOptions :: Lens' BooleanPropertyOptions (Maybe BooleanOperatorOptions)
- data ValueFilter
- valueFilter :: ValueFilter
- vfValue :: Lens' ValueFilter (Maybe Value)
- vfOperatorName :: Lens' ValueFilter (Maybe Text)
- data EnumOperatorOptions
- enumOperatorOptions :: EnumOperatorOptions
- eooOperatorName :: Lens' EnumOperatorOptions (Maybe Text)
- data DatePropertyOptions
- datePropertyOptions :: DatePropertyOptions
- dOperatorOptions :: Lens' DatePropertyOptions (Maybe DateOperatorOptions)
- data EnumValues
- enumValues :: EnumValues
- evValues :: Lens' EnumValues [Text]
- data GSuitePrincipal
- gSuitePrincipal :: GSuitePrincipal
- gspGsuiteGroupEmail :: Lens' GSuitePrincipal (Maybe Text)
- gspGsuiteUserEmail :: Lens' GSuitePrincipal (Maybe Text)
- gspGsuiteDomain :: Lens' GSuitePrincipal (Maybe Bool)
- data SearchQualityMetadata
- searchQualityMetadata :: SearchQualityMetadata
- sqmQuality :: Lens' SearchQualityMetadata (Maybe Double)
- data ItemContentContentFormat
- data TimestampValues
- timestampValues :: TimestampValues
- tValues :: Lens' TimestampValues [UTCTime]
- data ErrorInfo
- errorInfo :: ErrorInfo
- eiErrorMessages :: Lens' ErrorInfo [ErrorMessage]
- data ResultDisplayMetadata
- resultDisplayMetadata :: ResultDisplayMetadata
- rdmMetalines :: Lens' ResultDisplayMetadata [ResultDisplayLine]
- rdmObjectTypeLabel :: Lens' ResultDisplayMetadata (Maybe Text)
- data OperationResponse
- operationResponse :: HashMap Text JSONValue -> OperationResponse
- orAddtional :: Lens' OperationResponse (HashMap Text JSONValue)
- data IntegerValues
- integerValues :: IntegerValues
- ivValues :: Lens' IntegerValues [Int64]
- data SearchItemsByViewURLResponse
- searchItemsByViewURLResponse :: SearchItemsByViewURLResponse
- sibvurNextPageToken :: Lens' SearchItemsByViewURLResponse (Maybe Text)
- sibvurItems :: Lens' SearchItemsByViewURLResponse [Item]
- data SourcePredefinedSource
- data GetCustomerIndexStatsResponse
- getCustomerIndexStatsResponse :: GetCustomerIndexStatsResponse
- gcisrStats :: Lens' GetCustomerIndexStatsResponse [CustomerIndexStats]
- data RestrictItem
- restrictItem :: RestrictItem
- riDriveLocationRestrict :: Lens' RestrictItem (Maybe DriveLocationRestrict)
- riDriveTimeSpanRestrict :: Lens' RestrictItem (Maybe DriveTimeSpanRestrict)
- riDriveMimeTypeRestrict :: Lens' RestrictItem (Maybe DriveMimeTypeRestrict)
- riDriveFollowUpRestrict :: Lens' RestrictItem (Maybe DriveFollowUpRestrict)
- riSearchOperator :: Lens' RestrictItem (Maybe Text)
- data DriveTimeSpanRestrictType
- data IndexItemRequestMode
- data ItemACLACLInheritanceType
- data CheckAccessResponse
- checkAccessResponse :: CheckAccessResponse
- carHasAccess :: Lens' CheckAccessResponse (Maybe Bool)
- data RequestOptions
- requestOptions :: RequestOptions
- roLanguageCode :: Lens' RequestOptions (Maybe Text)
- roDebugOptions :: Lens' RequestOptions (Maybe DebugOptions)
- roTimeZone :: Lens' RequestOptions (Maybe Text)
- roSearchApplicationId :: Lens' RequestOptions (Maybe Text)
- data ItemStatus
- itemStatus :: ItemStatus
- isProcessingErrors :: Lens' ItemStatus [ProcessingError]
- isCode :: Lens' ItemStatus (Maybe ItemStatusCode)
- isRepositoryErrors :: Lens' ItemStatus [RepositoryError]
Service Configuration
cloudSearchService :: ServiceConfig Source #
Default request referring to version v1
of the Cloud Search API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
cloudSearchSettingsQueryScope :: Proxy '["https://www.googleapis.com/auth/cloud_search.settings.query"] Source #
New Service: https://www.googleapis.com/auth/cloud_search.settings.query
cloudSearchStatsIndexingScope :: Proxy '["https://www.googleapis.com/auth/cloud_search.stats.indexing"] Source #
New Service: https://www.googleapis.com/auth/cloud_search.stats.indexing
cloudSearchIndexingScope :: Proxy '["https://www.googleapis.com/auth/cloud_search.indexing"] Source #
New Service: https://www.googleapis.com/auth/cloud_search.indexing
cloudSearchScope :: Proxy '["https://www.googleapis.com/auth/cloud_search"] Source #
Index and serve your organization's data with Cloud Search
cloudSearchSettingsIndexingScope :: Proxy '["https://www.googleapis.com/auth/cloud_search.settings.indexing"] Source #
New Service: https://www.googleapis.com/auth/cloud_search.settings.indexing
cloudSearchQueryScope :: Proxy '["https://www.googleapis.com/auth/cloud_search.query"] Source #
Search your organization's data in the Cloud Search index
cloudSearchDebugScope :: Proxy '["https://www.googleapis.com/auth/cloud_search.debug"] Source #
New Service: https://www.googleapis.com/auth/cloud_search.debug
cloudSearchStatsScope :: Proxy '["https://www.googleapis.com/auth/cloud_search.stats"] Source #
New Service: https://www.googleapis.com/auth/cloud_search.stats
cloudSearchSettingsScope :: Proxy '["https://www.googleapis.com/auth/cloud_search.settings"] Source #
New Service: https://www.googleapis.com/auth/cloud_search.settings
API Declaration
type CloudSearchAPI = SettingsDatasourcesListResource :<|> (SettingsDatasourcesGetResource :<|> (SettingsDatasourcesCreateResource :<|> (SettingsDatasourcesDeleteResource :<|> (SettingsDatasourcesUpdateResource :<|> (SettingsSearchApplicationsListResource :<|> (SettingsSearchApplicationsGetResource :<|> (SettingsSearchApplicationsCreateResource :<|> (SettingsSearchApplicationsResetResource :<|> (SettingsSearchApplicationsDeleteResource :<|> (SettingsSearchApplicationsUpdateResource :<|> (StatsIndexDatasourcesGetResource :<|> (StatsGetIndexResource :<|> (DebugDatasourcesItemsUnmAppedidsListResource :<|> (DebugDatasourcesItemsCheckAccessResource :<|> (DebugDatasourcesItemsSearchByViewURLResource :<|> (DebugIdentitysourcesUnmAppedidsListResource :<|> (DebugIdentitysourcesItemsListForunmAppedidentityResource :<|> (MediaUploadResource :<|> (QuerySourcesListResource :<|> (QuerySuggestResource :<|> (QuerySearchResource :<|> (OperationsGetResource :<|> (IndexingDatasourcesItemsListResource :<|> (IndexingDatasourcesItemsUnreserveResource :<|> (IndexingDatasourcesItemsGetResource :<|> (IndexingDatasourcesItemsDeleteQueueItemsResource :<|> (IndexingDatasourcesItemsPollResource :<|> (IndexingDatasourcesItemsUploadResource :<|> (IndexingDatasourcesItemsIndexResource :<|> (IndexingDatasourcesItemsPushResource :<|> (IndexingDatasourcesItemsDeleteResource :<|> (IndexingDatasourcesGetSchemaResource :<|> (IndexingDatasourcesUpdateSchemaResource :<|> IndexingDatasourcesDeleteSchemaResource))))))))))))))))))))))))))))))))) Source #
Represents the entirety of the methods and resources available for the Cloud Search API service.
Resources
cloudsearch.debug.datasources.items.checkAccess
cloudsearch.debug.datasources.items.searchByViewUrl
cloudsearch.debug.datasources.items.unmappedids.list
cloudsearch.debug.identitysources.items.listForunmappedidentity
cloudsearch.debug.identitysources.unmappedids.list
cloudsearch.indexing.datasources.deleteSchema
cloudsearch.indexing.datasources.getSchema
cloudsearch.indexing.datasources.items.delete
cloudsearch.indexing.datasources.items.deleteQueueItems
cloudsearch.indexing.datasources.items.get
cloudsearch.indexing.datasources.items.index
cloudsearch.indexing.datasources.items.list
cloudsearch.indexing.datasources.items.poll
cloudsearch.indexing.datasources.items.push
cloudsearch.indexing.datasources.items.unreserve
cloudsearch.indexing.datasources.items.upload
cloudsearch.indexing.datasources.updateSchema
cloudsearch.media.upload
cloudsearch.operations.get
cloudsearch.query.search
cloudsearch.query.sources.list
cloudsearch.query.suggest
cloudsearch.settings.datasources.create
cloudsearch.settings.datasources.delete
cloudsearch.settings.datasources.get
cloudsearch.settings.datasources.list
cloudsearch.settings.datasources.update
cloudsearch.settings.searchapplications.create
cloudsearch.settings.searchapplications.delete
cloudsearch.settings.searchapplications.get
cloudsearch.settings.searchapplications.list
cloudsearch.settings.searchapplications.reset
cloudsearch.settings.searchapplications.update
cloudsearch.stats.getIndex
cloudsearch.stats.index.datasources.get
Types
DriveMimeTypeRestrictType
data DriveMimeTypeRestrictType Source #
Constructors
Unspecified | UNSPECIFIED |
Document | DOCUMENT |
Presentation | PRESENTATION |
Spreadsheet | SPREADSHEET |
Form | FORM |
Drawing | DRAWING |
Script | SCRIPT |
Map | MAP |
Image | IMAGE |
Audio | AUDIO |
Video | VIDEO |
Folder | FOLDER |
Archive | ARCHIVE |
Site | SITE |
Instances
DriveFollowUpRestrictType
data DriveFollowUpRestrictType Source #
Constructors
DFURTUnspecified | UNSPECIFIED |
DFURTFollowupSuggestions | FOLLOWUP_SUGGESTIONS |
DFURTFollowupActionItems | FOLLOWUP_ACTION_ITEMS |
Instances
ItemContent
data ItemContent Source #
Content of an item to be indexed and surfaced by Cloud Search.
See: itemContent
smart constructor.
Instances
itemContent :: ItemContent Source #
Creates a value of ItemContent
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
icHash :: Lens' ItemContent (Maybe Text) Source #
Hashing info calculated and provided by the API client for content. Can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
icContentDataRef :: Lens' ItemContent (Maybe UploadItemRef) Source #
Upload reference ID of a previously uploaded content via write method.
icInlineContent :: Lens' ItemContent (Maybe ByteString) Source #
Content that is supplied inlined within the update method. The maximum length is 102400 bytes (100 KiB).
Photo
A person's photo.
See: photo
smart constructor.
Instances
Eq Photo Source # | |
Data Photo Source # | |
Defined in Network.Google.CloudSearch.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Photo -> c Photo # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Photo # dataTypeOf :: Photo -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Photo) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Photo) # gmapT :: (forall b. Data b => b -> b) -> Photo -> Photo # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Photo -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Photo -> r # gmapQ :: (forall d. Data d => d -> u) -> Photo -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Photo -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Photo -> m Photo # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Photo -> m Photo # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Photo -> m Photo # | |
Show Photo Source # | |
Generic Photo Source # | |
ToJSON Photo Source # | |
Defined in Network.Google.CloudSearch.Types.Product | |
FromJSON Photo Source # | |
type Rep Photo Source # | |
Defined in Network.Google.CloudSearch.Types.Product |
SearchItemsByViewURLRequest
data SearchItemsByViewURLRequest Source #
Instances
searchItemsByViewURLRequest :: SearchItemsByViewURLRequest Source #
Creates a value of SearchItemsByViewURLRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sibvurDebugOptions :: Lens' SearchItemsByViewURLRequest (Maybe DebugOptions) Source #
Common debug options.
sibvurPageToken :: Lens' SearchItemsByViewURLRequest (Maybe Text) Source #
The next_page_token value returned from a previous request, if any.
sibvurViewURL :: Lens' SearchItemsByViewURLRequest (Maybe Text) Source #
Specify the full view URL to find the corresponding item. The maximum length is 2048 characters.
SearchApplication
data SearchApplication Source #
SearchApplication
See: searchApplication
smart constructor.
Instances
searchApplication :: SearchApplication Source #
Creates a value of SearchApplication
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
saDataSourceRestrictions :: Lens' SearchApplication [DataSourceRestriction] Source #
Retrictions applied to the configurations. The maximum number of elements is 10.
saOperationIds :: Lens' SearchApplication [Text] Source #
IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.
saDefaultFacetOptions :: Lens' SearchApplication [FacetOptions] Source #
The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.
saScoringConfig :: Lens' SearchApplication (Maybe ScoringConfig) Source #
Configuration for ranking results.
saName :: Lens' SearchApplication (Maybe Text) Source #
Name of the Search Application. Format: searchapplications/{application_id}.
saSourceConfig :: Lens' SearchApplication [SourceConfig] Source #
Configuration for a sources specified in data_source_restrictions.
saDisplayName :: Lens' SearchApplication (Maybe Text) Source #
Display name of the Search Application. The maximum length is 300 characters.
saDefaultSortOptions :: Lens' SearchApplication (Maybe SortOptions) Source #
The default options for sorting the search results
BooleanOperatorOptions
data BooleanOperatorOptions Source #
Used to provide a search operator for boolean properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
See: booleanOperatorOptions
smart constructor.
Instances
booleanOperatorOptions :: BooleanOperatorOptions Source #
Creates a value of BooleanOperatorOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
booOperatorName :: Lens' BooleanOperatorOptions (Maybe Text) Source #
Indicates the operator name required in the query in order to isolate the boolean property. For example, if operatorName is *closed* and the property's name is *isClosed*, then queries like *closed:<value>* will show results only where the value of the property named *isClosed* matches *<value>*. By contrast, a search that uses the same *<value>* without an operator will return all items where *<value>* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
Status
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. The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
See: status
smart constructor.
Instances
Eq Status Source # | |
Data Status Source # | |
Defined in Network.Google.CloudSearch.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Status -> c Status # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Status # toConstr :: Status -> Constr # dataTypeOf :: Status -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Status) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Status) # gmapT :: (forall b. Data b => b -> b) -> Status -> Status # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Status -> r # gmapQ :: (forall d. Data d => d -> u) -> Status -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Status -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Status -> m Status # | |
Show Status Source # | |
Generic Status Source # | |
ToJSON Status Source # | |
Defined in Network.Google.CloudSearch.Types.Product | |
FromJSON Status Source # | |
type Rep Status Source # | |
Defined in Network.Google.CloudSearch.Types.Product type Rep Status = D1 (MetaData "Status" "Network.Google.CloudSearch.Types.Product" "gogol-cloudsearch-0.4.0-5yB3RjcJJrULTqYmbhTTen" False) (C1 (MetaCons "Status'" PrefixI True) (S1 (MetaSel (Just "_sDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [StatusDetailsItem])) :*: (S1 (MetaSel (Just "_sCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_sMessage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) |
sDetails :: Lens' Status [StatusDetailsItem] Source #
A list of messages that carry the error details. There is a common set of message types for APIs to use.
sCode :: Lens' Status (Maybe Int32) Source #
The status code, which should be an enum value of google.rpc.Code.
sMessage :: Lens' Status (Maybe Text) Source #
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.
EnumPropertyOptions
data EnumPropertyOptions Source #
Options for enum properties, which allow you to define a restricted set of strings to match user queries, set rankings for those string values, and define an operator name to be paired with those strings so that users can narrow results to only items with a specific value. For example, for items in a request tracking system with priority information, you could define *p0* as an allowable enum value and tie this enum to the operator name *priority* so that search users could add *priority:p0* to their query to restrict the set of results to only those items indexed with the value *p0*.
See: enumPropertyOptions
smart constructor.
Instances
enumPropertyOptions :: EnumPropertyOptions Source #
Creates a value of EnumPropertyOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
epoPossibleValues :: Lens' EnumPropertyOptions [EnumValuePair] Source #
The list of possible values for the enumeration property. All EnumValuePairs must provide a string value. If you specify an integer value for one EnumValuePair, then all possible EnumValuePairs must provide an integer value. Both the string value and integer value must be unique over all possible values. Once set, possible values cannot be removed or modified. If you supply an ordered ranking and think you might insert additional enum values in the future, leave gaps in the initial integer values to allow adding a value in between previously registered values. The maximum number of elements is 100.
epoOrderedRanking :: Lens' EnumPropertyOptions (Maybe EnumPropertyOptionsOrderedRanking) Source #
Used to specify the ordered ranking for the enumeration that determines how the integer values provided in the possible EnumValuePairs are used to rank results. If specified, integer values must be provided for all possible EnumValuePair values given for this property. Can only be used if isRepeatable is false.
epoOperatorOptions :: Lens' EnumPropertyOptions (Maybe EnumOperatorOptions) Source #
If set, describes how the enum should be used as a search operator.
ItemStatusCode
data ItemStatusCode Source #
Status code.
Constructors
CodeUnspecified |
|
Error' |
|
Modified |
|
NewItem |
|
Accepted |
|
Instances
UnreserveItemsRequest
data UnreserveItemsRequest Source #
Instances
unreserveItemsRequest :: UnreserveItemsRequest Source #
Creates a value of UnreserveItemsRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uirQueue :: Lens' UnreserveItemsRequest (Maybe Text) Source #
Name of a queue to unreserve items from.
uirDebugOptions :: Lens' UnreserveItemsRequest (Maybe DebugOptions) Source #
Common debug options.
uirConnectorName :: Lens' UnreserveItemsRequest (Maybe Text) Source #
Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
DateOperatorOptions
data DateOperatorOptions Source #
Optional. Provides a search operator for date properties. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
See: dateOperatorOptions
smart constructor.
Instances
dateOperatorOptions :: DateOperatorOptions Source #
Creates a value of DateOperatorOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dooOperatorName :: Lens' DateOperatorOptions (Maybe Text) Source #
Indicates the actual string required in the query in order to isolate the date property. For example, suppose an issue tracking schema object has a property named *closeDate* that specifies an operator with an operatorName of *closedon*. For searches on that data, queries like *closedon:<value>* will show results only where the value of the *closeDate* property matches *<value>*. By contrast, a search that uses the same *<value>* without an operator will return all items where *<value>* matches the value of any String properties or text within the content field for the indexed datasource. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
dooLessThanOperatorName :: Lens' DateOperatorOptions (Maybe Text) Source #
Indicates the operator name required in the query in order to isolate the date property using the less-than operator. For example, if lessThanOperatorName is *closedbefore* and the property's name is *closeDate*, then queries like *closedbefore:<value>* will show results only where the value of the property named *closeDate* is earlier than *<value>*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
dooGreaterThanOperatorName :: Lens' DateOperatorOptions (Maybe Text) Source #
Indicates the operator name required in the query in order to isolate the date property using the greater-than operator. For example, if greaterThanOperatorName is *closedafter* and the property's name is *closeDate*, then queries like *closedafter:<value>* will show results only where the value of the property named *closeDate* is later than *<value>*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
GetDataSourceIndexStatsResponse
data GetDataSourceIndexStatsResponse Source #
Instances
getDataSourceIndexStatsResponse :: GetDataSourceIndexStatsResponse Source #
Creates a value of GetDataSourceIndexStatsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gdsisrStats :: Lens' GetDataSourceIndexStatsResponse [DataSourceIndexStats] Source #
Summary of indexed item counts, one for each day in the requested range.
ObjectDisplayOptions
data ObjectDisplayOptions Source #
The display options for an object.
See: objectDisplayOptions
smart constructor.
Instances
objectDisplayOptions :: ObjectDisplayOptions Source #
Creates a value of ObjectDisplayOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
odoMetalines :: Lens' ObjectDisplayOptions [Metaline] Source #
Defines the properties that will be displayed in the metalines of the search results. The property values will be displayed in the order given here. If a property holds multiple values, all of the values will be diplayed before the next properties. For this reason, it is a good practice to specify singular properties before repeated properties in this list. All of the properties must set is_returnable to true. The maximum number of elements is 3.
odoObjectDisplayLabel :: Lens' ObjectDisplayOptions (Maybe Text) Source #
The user friendly label to display in the search result to inidicate the type of the item. This is OPTIONAL; if not given, an object label will not be displayed on the context line of the search results. The maximum length is 32 characters.
QueryItem
Information relevant only to a query entry.
See: queryItem
smart constructor.
Instances
Eq QueryItem Source # | |
Data QueryItem Source # | |
Defined in Network.Google.CloudSearch.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> QueryItem -> c QueryItem # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c QueryItem # toConstr :: QueryItem -> Constr # dataTypeOf :: QueryItem -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c QueryItem) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c QueryItem) # gmapT :: (forall b. Data b => b -> b) -> QueryItem -> QueryItem # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> QueryItem -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> QueryItem -> r # gmapQ :: (forall d. Data d => d -> u) -> QueryItem -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> QueryItem -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> QueryItem -> m QueryItem # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> QueryItem -> m QueryItem # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> QueryItem -> m QueryItem # | |
Show QueryItem Source # | |
Generic QueryItem Source # | |
ToJSON QueryItem Source # | |
Defined in Network.Google.CloudSearch.Types.Product | |
FromJSON QueryItem Source # | |
type Rep QueryItem Source # | |
Defined in Network.Google.CloudSearch.Types.Product |
queryItem :: QueryItem Source #
Creates a value of QueryItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qiIsSynthetic :: Lens' QueryItem (Maybe Bool) Source #
True if the text was generated by means other than a previous user search.
ListUnmAppedIdentitiesResponse
data ListUnmAppedIdentitiesResponse Source #
Instances
listUnmAppedIdentitiesResponse :: ListUnmAppedIdentitiesResponse Source #
Creates a value of ListUnmAppedIdentitiesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
luairNextPageToken :: Lens' ListUnmAppedIdentitiesResponse (Maybe Text) Source #
Token to retrieve the next page of results, or empty if there are no more results in the list.
DeleteQueueItemsRequest
data DeleteQueueItemsRequest Source #
Instances
deleteQueueItemsRequest :: DeleteQueueItemsRequest Source #
Creates a value of DeleteQueueItemsRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dqirQueue :: Lens' DeleteQueueItemsRequest (Maybe Text) Source #
Name of a queue to delete items from.
dqirDebugOptions :: Lens' DeleteQueueItemsRequest (Maybe DebugOptions) Source #
Common debug options.
dqirConnectorName :: Lens' DeleteQueueItemsRequest (Maybe Text) Source #
Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
SearchResult
data SearchResult Source #
Results containing indexed information for a document.
See: searchResult
smart constructor.
Instances
searchResult :: SearchResult Source #
Creates a value of SearchResult
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srDebugInfo :: Lens' SearchResult (Maybe ResultDebugInfo) Source #
Debugging information about this search result.
srSnippet :: Lens' SearchResult (Maybe Snippet) Source #
The concatenation of all snippets (summaries) available for this result.
srClusteredResults :: Lens' SearchResult [SearchResult] Source #
If source is clustered, provide list of clustered results. There will only be one level of clustered results. If current source is not enabled for clustering, this field will be empty.
srMetadata :: Lens' SearchResult (Maybe Metadata) Source #
Metadata of the search result.
SpellResult
data SpellResult Source #
Instances
spellResult :: SpellResult Source #
Creates a value of SpellResult
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srSuggestedQuery :: Lens' SpellResult (Maybe Text) Source #
The suggested spelling of the query.
PeopleSuggestion
data PeopleSuggestion Source #
A people suggestion.
See: peopleSuggestion
smart constructor.
Instances
peopleSuggestion :: PeopleSuggestion Source #
Creates a value of PeopleSuggestion
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
psPerson :: Lens' PeopleSuggestion (Maybe Person) Source #
Suggested person. All fields of the person object might not be populated.
QuerySource
data QuerySource Source #
List of sources that the user can search using the query API.
See: querySource
smart constructor.
Instances
querySource :: QuerySource Source #
Creates a value of QuerySource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qsShortName :: Lens' QuerySource (Maybe Text) Source #
A short name or alias for the source. This value can be used with the 'source' operator.
qsDisplayName :: Lens' QuerySource (Maybe Text) Source #
Display name of the data source.
qsOperators :: Lens' QuerySource [QueryOperator] Source #
List of all operators applicable for this source.
SuggestResponse
data SuggestResponse Source #
Response of the suggest API.
See: suggestResponse
smart constructor.
Instances
suggestResponse :: SuggestResponse Source #
Creates a value of SuggestResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srSuggestResults :: Lens' SuggestResponse [SuggestResult] Source #
List of suggestion results.
RepositoryError
data RepositoryError Source #
Errors when the connector is communicating to the source repository.
See: repositoryError
smart constructor.
Instances
repositoryError :: RepositoryError Source #
Creates a value of RepositoryError
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
reHTTPStatusCode :: Lens' RepositoryError (Maybe Int32) Source #
Error codes. Matches the definition of HTTP status codes.
reType :: Lens' RepositoryError (Maybe RepositoryErrorType) Source #
Type of error.
reErrorMessage :: Lens' RepositoryError (Maybe Text) Source #
Message that describes the error. The maximum allowable length of the message is 8192 characters.
QueryInterpretationInterpretationType
data QueryInterpretationInterpretationType Source #
Constructors
None |
|
Blend |
|
Replace |
|
Instances
HTMLPropertyOptions
data HTMLPropertyOptions Source #
Options for html properties.
See: htmlPropertyOptions
smart constructor.
Instances
htmlPropertyOptions :: HTMLPropertyOptions Source #
Creates a value of HTMLPropertyOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hpoRetrievalImportance :: Lens' HTMLPropertyOptions (Maybe RetrievalImportance) Source #
Indicates the search quality importance of the tokens within the field when used for retrieval. Can only be set to DEFAULT or NONE.
hpoOperatorOptions :: Lens' HTMLPropertyOptions (Maybe HTMLOperatorOptions) Source #
If set, describes how the property should be used as a search operator.
PropertyDefinition
data PropertyDefinition Source #
The definition of a property within an object.
See: propertyDefinition
smart constructor.
Instances
propertyDefinition :: PropertyDefinition Source #
Creates a value of PropertyDefinition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pdIsReturnable :: Lens' PropertyDefinition (Maybe Bool) Source #
Indicates that the property identifies data that should be returned in search results via the Query API. If set to *true*, indicates that Query API users can use matching property fields in results. However, storing fields requires more space allocation and uses more bandwidth for search queries, which impacts performance over large datasets. Set to *true* here only if the field is needed for search results. Cannot be true for properties whose type is an object.
pdName :: Lens' PropertyDefinition (Maybe Text) Source #
The name of the property. Item indexing requests sent to the Indexing API should set the property name equal to this value. For example, if name is *subject_line*, then indexing requests for document items with subject fields should set the name for that field equal to *subject_line*. Use the name as the identifier for the object property. Once registered as a property for an object, you cannot re-use this name for another property within that object. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters.
pdIsRepeatable :: Lens' PropertyDefinition (Maybe Bool) Source #
Indicates that multiple values are allowed for the property. For example, a document only has one description but can have multiple comments. Cannot be true for properties whose type is a boolean. If set to false, properties that contain more than one value will cause the indexing request for that item to be rejected.
pdDisplayOptions :: Lens' PropertyDefinition (Maybe PropertyDisplayOptions) Source #
Options that determine how the property is displayed in the Cloud Search results page if it is specified to be displayed in the object's display options .
pdIsSortable :: Lens' PropertyDefinition (Maybe Bool) Source #
Indicates that the property can be used for sorting. Cannot be true for properties that are repeatable. Cannot be true for properties whose type is object or user identifier. IsReturnable must be true to set this option. Only supported for Boolean, Date, Double, Integer, and Timestamp properties.
pdIsFacetable :: Lens' PropertyDefinition (Maybe Bool) Source #
Indicates that the property can be used for generating facets. Cannot be true for properties whose type is object. IsReturnable must be true to set this option. Only supported for Boolean, Enum, and Text properties.
SortOptions
data SortOptions Source #
Instances
sortOptions :: SortOptions Source #
Creates a value of SortOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
soSortOrder :: Lens' SortOptions (Maybe SortOptionsSortOrder) Source #
Ascending is the default sort order
soOperatorName :: Lens' SortOptions (Maybe Text) Source #
Name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
ObjectPropertyOptions
data ObjectPropertyOptions Source #
Options for object properties.
See: objectPropertyOptions
smart constructor.
Instances
objectPropertyOptions :: ObjectPropertyOptions Source #
Creates a value of ObjectPropertyOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
opoSubobjectProperties :: Lens' ObjectPropertyOptions [PropertyDefinition] Source #
The properties of the sub-object. These properties represent a nested object. For example, if this property represents a postal address, the subobjectProperties might be named *street*, *city*, and *state*. The maximum number of elements is 1000.
InteractionType
data InteractionType Source #
Constructors
ITUnspecified |
|
ITView |
|
ITEdit |
|
Instances
QueryOperatorType
data QueryOperatorType Source #
Type of the operator.
Constructors
QOTUnknown |
|
QOTInteger | INTEGER |
QOTDouble | DOUBLE |
QOTTimestamp | TIMESTAMP |
QOTBoolean | BOOLEAN |
QOTEnum' | ENUM |
QOTDate | DATE |
QOTText | TEXT |
QOTHTML | HTML |
Instances
SearchResponse
data SearchResponse Source #
The search API response.
See: searchResponse
smart constructor.
Instances
searchResponse :: SearchResponse Source #
Creates a value of SearchResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sSpellResults :: Lens' SearchResponse [SpellResult] Source #
Suggested spelling for the query.
sFacetResults :: Lens' SearchResponse [FacetResult] Source #
Repeated facet results.
sDebugInfo :: Lens' SearchResponse (Maybe ResponseDebugInfo) Source #
Debugging information about the response.
sResults :: Lens' SearchResponse [SearchResult] Source #
Results from a search query.
sHasMoreResults :: Lens' SearchResponse (Maybe Bool) Source #
Whether there are more search results matching the query.
sResultCounts :: Lens' SearchResponse (Maybe ResultCounts) Source #
Expanded result count information.
sResultCountExact :: Lens' SearchResponse (Maybe Int64) Source #
The exact result count for this query.
sResultCountEstimate :: Lens' SearchResponse (Maybe Int64) Source #
The estimated result count for this query.
sQueryInterpretation :: Lens' SearchResponse (Maybe QueryInterpretation) Source #
Query interpretation result for user query. Empty if query interpretation is disabled.
sStructuredResults :: Lens' SearchResponse [StructuredResult] Source #
Structured results for the user query. These results are not counted against the page_size.
sErrorInfo :: Lens' SearchResponse (Maybe ErrorInfo) Source #
Error information about the response.
SuggestResult
data SuggestResult Source #
One suggestion result.
See: suggestResult
smart constructor.
Instances
suggestResult :: SuggestResult Source #
Creates a value of SuggestResult
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sSuggestedQuery :: Lens' SuggestResult (Maybe Text) Source #
The suggested query that will be used for search, when the user clicks on the suggestion
TextValues
data TextValues Source #
List of text values.
See: textValues
smart constructor.
Instances
textValues :: TextValues Source #
Creates a value of TextValues
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tvValues :: Lens' TextValues [Text] Source #
The maximum allowable length for text values is 2048 characters. The maximum number of string elements is 100.
DriveLocationRestrict
data DriveLocationRestrict Source #
Drive location search restricts (e.g. "is:starred").
See: driveLocationRestrict
smart constructor.
Instances
driveLocationRestrict :: DriveLocationRestrict Source #
Creates a value of DriveLocationRestrict
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ListQuerySourcesResponse
data ListQuerySourcesResponse Source #
List sources response.
See: listQuerySourcesResponse
smart constructor.
Instances
listQuerySourcesResponse :: ListQuerySourcesResponse Source #
Creates a value of ListQuerySourcesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
DoubleOperatorOptions
data DoubleOperatorOptions Source #
Used to provide a search operator for double properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
See: doubleOperatorOptions
smart constructor.
Instances
doubleOperatorOptions :: DoubleOperatorOptions Source #
Creates a value of DoubleOperatorOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dOperatorName :: Lens' DoubleOperatorOptions (Maybe Text) Source #
Indicates the operator name required in the query in order to use the double property in sorting or as a facet. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
Operation
This resource represents a long-running operation that is the result of a network API call.
See: operation
smart constructor.
Instances
oDone :: Lens' Operation (Maybe Bool) Source #
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.
oError :: Lens' Operation (Maybe Status) Source #
The error result of the operation in case of failure or cancellation.
oResponse :: Lens' Operation (Maybe OperationResponse) Source #
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`.
oName :: Lens' Operation (Maybe Text) Source #
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 have the format of `operations/some/unique/name`.
oMetadata :: Lens' Operation (Maybe OperationMetadata) Source #
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.
Person
Object to represent a person.
See: person
smart constructor.
Instances
Eq Person Source # | |
Data Person Source # | |
Defined in Network.Google.CloudSearch.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Person -> c Person # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Person # toConstr :: Person -> Constr # dataTypeOf :: Person -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Person) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Person) # gmapT :: (forall b. Data b => b -> b) -> Person -> Person # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Person -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Person -> r # gmapQ :: (forall d. Data d => d -> u) -> Person -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Person -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Person -> m Person # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Person -> m Person # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Person -> m Person # | |
Show Person Source # | |
Generic Person Source # | |
ToJSON Person Source # | |
Defined in Network.Google.CloudSearch.Types.Product | |
FromJSON Person Source # | |
type Rep Person Source # | |
Defined in Network.Google.CloudSearch.Types.Product type Rep Person = D1 (MetaData "Person" "Network.Google.CloudSearch.Types.Product" "gogol-cloudsearch-0.4.0-5yB3RjcJJrULTqYmbhTTen" False) (C1 (MetaCons "Person'" PrefixI True) ((S1 (MetaSel (Just "_pEmailAddresses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [EmailAddress])) :*: S1 (MetaSel (Just "_pPersonNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Name]))) :*: (S1 (MetaSel (Just "_pPhotos") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Photo])) :*: (S1 (MetaSel (Just "_pName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pObfuscatedId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) |
Creates a value of Person
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pEmailAddresses :: Lens' Person [EmailAddress] Source #
The person's email addresses
pPhotos :: Lens' Person [Photo] Source #
A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results.
pName :: Lens' Person (Maybe Text) Source #
The resource name of the person to provide information about. See People.get from Google People API.
CompositeFilter
data CompositeFilter Source #
Instances
compositeFilter :: CompositeFilter Source #
Creates a value of CompositeFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cfSubFilters :: Lens' CompositeFilter [Filter] Source #
Sub filters.
cfLogicOperator :: Lens' CompositeFilter (Maybe CompositeFilterLogicOperator) Source #
The logic operator of the sub filter.
ResultDisplayLine
data ResultDisplayLine Source #
The collection of fields that make up a displayed line
See: resultDisplayLine
smart constructor.
Instances
resultDisplayLine :: ResultDisplayLine Source #
Creates a value of ResultDisplayLine
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
DoubleValues
data DoubleValues Source #
List of double values.
See: doubleValues
smart constructor.
Instances
doubleValues :: DoubleValues Source #
Creates a value of DoubleValues
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
Snippet
Snippet of the search result, which summarizes the content of the resulting page.
See: snippet
smart constructor.
Instances
Eq Snippet Source # | |
Data Snippet Source # | |
Defined in Network.Google.CloudSearch.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Snippet -> c Snippet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Snippet # toConstr :: Snippet -> Constr # dataTypeOf :: Snippet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Snippet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Snippet) # gmapT :: (forall b. Data b => b -> b) -> Snippet -> Snippet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Snippet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Snippet -> r # gmapQ :: (forall d. Data d => d -> u) -> Snippet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Snippet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Snippet -> m Snippet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Snippet -> m Snippet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Snippet -> m Snippet # | |
Show Snippet Source # | |
Generic Snippet Source # | |
ToJSON Snippet Source # | |
Defined in Network.Google.CloudSearch.Types.Product | |
FromJSON Snippet Source # | |
type Rep Snippet Source # | |
Defined in Network.Google.CloudSearch.Types.Product type Rep Snippet = D1 (MetaData "Snippet" "Network.Google.CloudSearch.Types.Product" "gogol-cloudsearch-0.4.0-5yB3RjcJJrULTqYmbhTTen" False) (C1 (MetaCons "Snippet'" PrefixI True) (S1 (MetaSel (Just "_sMatchRanges") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [MatchRange])) :*: S1 (MetaSel (Just "_sSnippet") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) |
Creates a value of Snippet
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sMatchRanges :: Lens' Snippet [MatchRange] Source #
The matched ranges in the snippet.
sSnippet :: Lens' Snippet (Maybe Text) Source #
The snippet of the document. The snippet of the document. May contain escaped HTML character that should be unescaped prior to rendering.
TextOperatorOptions
data TextOperatorOptions Source #
Used to provide a search operator for text properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
See: textOperatorOptions
smart constructor.
Instances
textOperatorOptions :: TextOperatorOptions Source #
Creates a value of TextOperatorOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tooOperatorName :: Lens' TextOperatorOptions (Maybe Text) Source #
Indicates the operator name required in the query in order to isolate the text property. For example, if operatorName is *subject* and the property's name is *subjectLine*, then queries like *subject:<value>* will show results only where the value of the property named *subjectLine* matches *<value>*. By contrast, a search that uses the same *<value>* without an operator will return all items where *<value>* matches the value of any text properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
tooExactMatchWithOperator :: Lens' TextOperatorOptions (Maybe Bool) Source #
If true, the text value will be tokenized as one atomic value in operator searches and facet matches. For example, if the operator name is "genre" and the value is "science-fiction" the query restrictions "genre:science" and "genre:fiction" will not match the item; "genre:science-fiction" will. Value matching is case-sensitive and does not remove special characters. If false, the text will be tokenized. For example, if the value is "science-fiction" the queries "genre:science" and "genre:fiction" will match the item.
EnumPropertyOptionsOrderedRanking
data EnumPropertyOptionsOrderedRanking Source #
Used to specify the ordered ranking for the enumeration that determines how the integer values provided in the possible EnumValuePairs are used to rank results. If specified, integer values must be provided for all possible EnumValuePair values given for this property. Can only be used if isRepeatable is false.
Constructors
NoOrder |
|
Ascending |
|
Descending |
|
Instances
QueryInterpretationOptions
data QueryInterpretationOptions Source #
Options to interpret user query.
See: queryInterpretationOptions
smart constructor.
Instances
queryInterpretationOptions :: QueryInterpretationOptions Source #
Creates a value of QueryInterpretationOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qioDisableNlInterpretation :: Lens' QueryInterpretationOptions (Maybe Bool) Source #
Flag to disable natural language (NL) interpretation of queries. Default is false, Set to true to disable natural language interpretation. NL interpretation only applies to predefined datasources.
ResetSearchApplicationRequest
data ResetSearchApplicationRequest Source #
Instances
resetSearchApplicationRequest :: ResetSearchApplicationRequest Source #
Creates a value of ResetSearchApplicationRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rsarDebugOptions :: Lens' ResetSearchApplicationRequest (Maybe DebugOptions) Source #
Common debug options.
IntegerPropertyOptionsOrderedRanking
data IntegerPropertyOptionsOrderedRanking Source #
Used to specify the ordered ranking for the integer. Can only be used if isRepeatable is false.
Constructors
IPOORNoOrder |
|
IPOORAscending |
|
IPOORDescending |
|
Instances
ItemMetadata
data ItemMetadata Source #
Available metadata fields for the item.
See: itemMetadata
smart constructor.
Instances
itemMetadata :: ItemMetadata Source #
Creates a value of ItemMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
imSourceRepositoryURL :: Lens' ItemMetadata (Maybe Text) Source #
Link to the source repository serving the data. Search results apply this link to the title. The maximum length is 2048 characters.
imHash :: Lens' ItemMetadata (Maybe Text) Source #
Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
imObjectType :: Lens' ItemMetadata (Maybe Text) Source #
The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters.
imContainerName :: Lens' ItemMetadata (Maybe Text) Source #
The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
imInteractions :: Lens' ItemMetadata [Interaction] Source #
A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.
imMimeType :: Lens' ItemMetadata (Maybe Text) Source #
The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.
imUpdateTime :: Lens' ItemMetadata (Maybe UTCTime) Source #
The time when the item was last modified in the source repository.
imKeywords :: Lens' ItemMetadata [Text] Source #
Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters.
imTitle :: Lens' ItemMetadata (Maybe Text) Source #
The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters.
imContentLanguage :: Lens' ItemMetadata (Maybe Text) Source #
The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
imSearchQualityMetadata :: Lens' ItemMetadata (Maybe SearchQualityMetadata) Source #
Additional search quality metadata of the item
imCreateTime :: Lens' ItemMetadata (Maybe UTCTime) Source #
The time when the item was created in the source repository.
FilterOptions
data FilterOptions Source #
Filter options to be applied on query.
See: filterOptions
smart constructor.
Instances
filterOptions :: FilterOptions Source #
Creates a value of FilterOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
foObjectType :: Lens' FilterOptions (Maybe Text) Source #
If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.
foFilter :: Lens' FilterOptions (Maybe Filter) Source #
Generic filter to restrict the search, such as `lang:en`, `site:xyz`.
StructuredResult
data StructuredResult Source #
Structured results that are returned as part of search request.
See: structuredResult
smart constructor.
Instances
structuredResult :: StructuredResult Source #
Creates a value of StructuredResult
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ProcessingError
data ProcessingError Source #
Instances
processingError :: ProcessingError Source #
Creates a value of ProcessingError
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
peFieldViolations :: Lens' ProcessingError [FieldViolation] Source #
In case the item fields are invalid, this field contains the details about the validation errors.
peCode :: Lens' ProcessingError (Maybe ProcessingErrorCode) Source #
Error code indicating the nature of the error.
peErrorMessage :: Lens' ProcessingError (Maybe Text) Source #
Description of the error.
PushItemType
data PushItemType Source #
The type of the push operation that defines the push behavior.
Constructors
PITUnspecified |
|
PITModified |
|
PITNotModified |
|
PITRepositoryError |
|
PITReQueue |
|
Instances
ListItemNamesForUnmAppedIdentityResponse
data ListItemNamesForUnmAppedIdentityResponse Source #
Instances
listItemNamesForUnmAppedIdentityResponse :: ListItemNamesForUnmAppedIdentityResponse Source #
Creates a value of ListItemNamesForUnmAppedIdentityResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
linfuairNextPageToken :: Lens' ListItemNamesForUnmAppedIdentityResponse (Maybe Text) Source #
Token to retrieve the next page of results, or empty if there are no more results in the list.
CompositeFilterLogicOperator
data CompositeFilterLogicOperator Source #
The logic operator of the sub filter.
Constructors
And |
|
OR | OR |
Not |
|
Instances
ItemACL
Access control list information for the item. For more information see https://developers.google.com/cloud-search/docs/guides/index-your-data#acls
See: itemACL
smart constructor.
Instances
Creates a value of ItemACL
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iaOwners :: Lens' ItemACL [Principal] Source #
Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.
iaReaders :: Lens' ItemACL [Principal] Source #
List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.
iaACLInheritanceType :: Lens' ItemACL (Maybe ItemACLACLInheritanceType) Source #
Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.
iaInheritACLFrom :: Lens' ItemACL (Maybe Text) Source #
Name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters.
iaDeniedReaders :: Lens' ItemACL [Principal] Source #
List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.
Value
Definition of a single value with generic type.
See: value
smart constructor.
Instances
Eq Value Source # | |
Data Value Source # | |
Defined in Network.Google.CloudSearch.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Value -> c Value # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Value # dataTypeOf :: Value -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Value) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Value) # gmapT :: (forall b. Data b => b -> b) -> Value -> Value # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Value -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Value -> r # gmapQ :: (forall d. Data d => d -> u) -> Value -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Value -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Value -> m Value # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Value -> m Value # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Value -> m Value # | |
Show Value Source # | |
Generic Value Source # | |
ToJSON Value Source # | |
Defined in Network.Google.CloudSearch.Types.Product | |
FromJSON Value Source # | |
type Rep Value Source # | |
Defined in Network.Google.CloudSearch.Types.Product type Rep Value = D1 (MetaData "Value" "Network.Google.CloudSearch.Types.Product" "gogol-cloudsearch-0.4.0-5yB3RjcJJrULTqYmbhTTen" False) (C1 (MetaCons "Value'" PrefixI True) ((S1 (MetaSel (Just "_vIntegerValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int64))) :*: (S1 (MetaSel (Just "_vTimestampValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime')) :*: S1 (MetaSel (Just "_vDoubleValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Double))))) :*: (S1 (MetaSel (Just "_vStringValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_vDateValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Date)) :*: S1 (MetaSel (Just "_vBooleanValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))))) |
Creates a value of Value
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
FieldViolation
data FieldViolation Source #
Instances
fieldViolation :: FieldViolation Source #
Creates a value of FieldViolation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fvDescription :: Lens' FieldViolation (Maybe Text) Source #
Description of the error.
SourceScoringConfigSourceImportance
data SourceScoringConfigSourceImportance Source #
Importance of the source.
Instances
Metaline
A metaline is a list of properties that are displayed along with the search result to provide context.
See: metaline
smart constructor.
Instances
Eq Metaline Source # | |
Data Metaline Source # | |
Defined in Network.Google.CloudSearch.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Metaline -> c Metaline # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Metaline # toConstr :: Metaline -> Constr # dataTypeOf :: Metaline -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Metaline) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Metaline) # gmapT :: (forall b. Data b => b -> b) -> Metaline -> Metaline # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Metaline -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Metaline -> r # gmapQ :: (forall d. Data d => d -> u) -> Metaline -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Metaline -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Metaline -> m Metaline # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Metaline -> m Metaline # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Metaline -> m Metaline # | |
Show Metaline Source # | |
Generic Metaline Source # | |
ToJSON Metaline Source # | |
Defined in Network.Google.CloudSearch.Types.Product | |
FromJSON Metaline Source # | |
type Rep Metaline Source # | |
Defined in Network.Google.CloudSearch.Types.Product type Rep Metaline = D1 (MetaData "Metaline" "Network.Google.CloudSearch.Types.Product" "gogol-cloudsearch-0.4.0-5yB3RjcJJrULTqYmbhTTen" True) (C1 (MetaCons "Metaline'" PrefixI True) (S1 (MetaSel (Just "_mProperties") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [DisplayedProperty])))) |
Creates a value of Metaline
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mProperties :: Lens' Metaline [DisplayedProperty] Source #
The list of displayed properties for the metaline.
FacetBucket
data FacetBucket Source #
A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object.
See: facetBucket
smart constructor.
Instances
facetBucket :: FacetBucket Source #
Creates a value of FacetBucket
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fbPercentage :: Lens' FacetBucket (Maybe Int32) Source #
Percent of results that match the bucket value. This value is between (0-100]. This may not be accurate and is a best effort estimate.
StatusDetailsItem
data StatusDetailsItem Source #
Instances
Arguments
:: HashMap Text JSONValue | |
-> StatusDetailsItem |
Creates a value of StatusDetailsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
RetrievalImportanceImportance
data RetrievalImportanceImportance Source #
Indicates the ranking importance given to property when it is matched during retrieval. Once set, the token importance of a property cannot be changed.
Constructors
RIIDefault |
|
RIIHighest |
|
RIIHigh |
|
RIILow |
|
RIINone |
|
Instances
TimestampOperatorOptions
data TimestampOperatorOptions Source #
Used to provide a search operator for timestamp properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
See: timestampOperatorOptions
smart constructor.
Instances
timestampOperatorOptions :: TimestampOperatorOptions Source #
Creates a value of TimestampOperatorOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tOperatorName :: Lens' TimestampOperatorOptions (Maybe Text) Source #
Indicates the operator name required in the query in order to isolate the timestamp property. For example, if operatorName is *closedon* and the property's name is *closeDate*, then queries like *closedon:<value>* will show results only where the value of the property named *closeDate* matches *<value>*. By contrast, a search that uses the same *<value>* without an operator will return all items where *<value>* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
tLessThanOperatorName :: Lens' TimestampOperatorOptions (Maybe Text) Source #
Indicates the operator name required in the query in order to isolate the timestamp property using the less-than operator. For example, if lessThanOperatorName is *closedbefore* and the property's name is *closeDate*, then queries like *closedbefore:<value>* will show results only where the value of the property named *closeDate* is earlier than *<value>*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
tGreaterThanOperatorName :: Lens' TimestampOperatorOptions (Maybe Text) Source #
Indicates the operator name required in the query in order to isolate the timestamp property using the greater-than operator. For example, if greaterThanOperatorName is *closedafter* and the property's name is *closeDate*, then queries like *closedafter:<value>* will show results only where the value of the property named *closeDate* is later than *<value>*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
ProcessingErrorCode
data ProcessingErrorCode Source #
Error code indicating the nature of the error.
Constructors
ProcessingErrorCodeUnspecified |
|
MalformedRequest |
|
UnsupportedContentFormat |
|
IndirectBrokenACL |
|
ACLCycle |
|
Instances
IntegerOperatorOptions
data IntegerOperatorOptions Source #
Used to provide a search operator for integer properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
See: integerOperatorOptions
smart constructor.
Instances
integerOperatorOptions :: IntegerOperatorOptions Source #
Creates a value of IntegerOperatorOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iooOperatorName :: Lens' IntegerOperatorOptions (Maybe Text) Source #
Indicates the operator name required in the query in order to isolate the integer property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:<value>* will show results only where the value of the property named *priorityVal* matches *<value>*. By contrast, a search that uses the same *<value>* without an operator will return all items where *<value>* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
iooLessThanOperatorName :: Lens' IntegerOperatorOptions (Maybe Text) Source #
Indicates the operator name required in the query in order to isolate the integer property using the less-than operator. For example, if lessThanOperatorName is *prioritybelow* and the property's name is *priorityVal*, then queries like *prioritybelow:<value>* will show results only where the value of the property named *priorityVal* is less than *<value>*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
iooGreaterThanOperatorName :: Lens' IntegerOperatorOptions (Maybe Text) Source #
Indicates the operator name required in the query in order to isolate the integer property using the greater-than operator. For example, if greaterThanOperatorName is *priorityabove* and the property's name is *priorityVal*, then queries like *priorityabove:<value>* will show results only where the value of the property named *priorityVal* is greater than *<value>*. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
SortOptionsSortOrder
data SortOptionsSortOrder Source #
Ascending is the default sort order
Constructors
SOSOAscending | ASCENDING |
SOSODescending | DESCENDING |
Instances
QuerySuggestion
data QuerySuggestion Source #
A completed query suggestion.
See: querySuggestion
smart constructor.
Instances
querySuggestion :: QuerySuggestion Source #
Creates a value of QuerySuggestion
with the minimum fields required to make a request.
ListSearchApplicationsResponse
data ListSearchApplicationsResponse Source #
Instances
listSearchApplicationsResponse :: ListSearchApplicationsResponse Source #
Creates a value of ListSearchApplicationsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lsarNextPageToken :: Lens' ListSearchApplicationsResponse (Maybe Text) Source #
Token to retrieve the next page of results, or empty if there are no more results in the list.
ResultDebugInfo
data ResultDebugInfo Source #
Debugging information about the result.
See: resultDebugInfo
smart constructor.
Instances
resultDebugInfo :: ResultDebugInfo Source #
Creates a value of ResultDebugInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdiFormattedDebugInfo :: Lens' ResultDebugInfo (Maybe Text) Source #
General debug info formatted for display.
ItemCountByStatus
data ItemCountByStatus Source #
Instances
itemCountByStatus :: ItemCountByStatus Source #
Creates a value of ItemCountByStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
icbsCount :: Lens' ItemCountByStatus (Maybe Int64) Source #
Number of items matching the status code.
icbsStatusCode :: Lens' ItemCountByStatus (Maybe ItemCountByStatusStatusCode) Source #
Status of the items.
TimestampPropertyOptions
data TimestampPropertyOptions Source #
Options for timestamp properties.
See: timestampPropertyOptions
smart constructor.
Instances
timestampPropertyOptions :: TimestampPropertyOptions Source #
Creates a value of TimestampPropertyOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tpoOperatorOptions :: Lens' TimestampPropertyOptions (Maybe TimestampOperatorOptions) Source #
If set, describes how the timestamp should be used as a search operator.
ResultCounts
data ResultCounts Source #
Result count information
See: resultCounts
smart constructor.
Instances
resultCounts :: ResultCounts Source #
Creates a value of ResultCounts
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rcSourceResultCounts :: Lens' ResultCounts [SourceResultCount] Source #
Result count information for each source with results.
FreshnessOptions
data FreshnessOptions Source #
Indicates which freshness property to use when adjusting search ranking for an item. Fresher, more recent dates indicate higher quality. Use the freshness option property that best works with your data. For fileshare documents, last modified time is most relevant. For calendar event data, the time when the event occurs is a more relevant freshness indicator. In this way, calendar events that occur closer to the time of the search query are considered higher quality and ranked accordingly.
See: freshnessOptions
smart constructor.
Instances
freshnessOptions :: FreshnessOptions Source #
Creates a value of FreshnessOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
foFreshnessDuration :: Lens' FreshnessOptions (Maybe Scientific) Source #
The duration (in seconds) after which an object should be considered stale.
foFreshnessProperty :: Lens' FreshnessOptions (Maybe Text) Source #
This property indicates the freshness level of the object in the index. If set, this property must be a top-level property within the property definitions and it must be a timestamp type or date type. Otherwise, the Indexing API uses updateTime as the freshness indicator. The maximum length is 256 characters.
DebugOptions
data DebugOptions Source #
Shared request debug options for all cloudsearch RPC methods.
See: debugOptions
smart constructor.
Instances
debugOptions :: DebugOptions Source #
Creates a value of DebugOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
doEnableDebugging :: Lens' DebugOptions (Maybe Bool) Source #
If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging.
IntegerPropertyOptions
data IntegerPropertyOptions Source #
Options for integer properties.
See: integerPropertyOptions
smart constructor.
Instances
integerPropertyOptions :: IntegerPropertyOptions Source #
Creates a value of IntegerPropertyOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ipoMaximumValue :: Lens' IntegerPropertyOptions (Maybe Int64) Source #
The maximum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values greater than the maximum are accepted and ranked with the same weight as items indexed with the maximum value.
ipoOrderedRanking :: Lens' IntegerPropertyOptions (Maybe IntegerPropertyOptionsOrderedRanking) Source #
Used to specify the ordered ranking for the integer. Can only be used if isRepeatable is false.
ipoMinimumValue :: Lens' IntegerPropertyOptions (Maybe Int64) Source #
The minimum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values less than the minimum are accepted and ranked with the same weight as items indexed with the minimum value.
ipoOperatorOptions :: Lens' IntegerPropertyOptions (Maybe IntegerOperatorOptions) Source #
If set, describes how the integer should be used as a search operator.
DataSourceRestriction
data DataSourceRestriction Source #
Restriction on Datasource.
See: dataSourceRestriction
smart constructor.
Instances
dataSourceRestriction :: DataSourceRestriction Source #
Creates a value of DataSourceRestriction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsrFilterOptions :: Lens' DataSourceRestriction [FilterOptions] Source #
Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20.
Schema
The schema definition for a data source.
See: schema
smart constructor.
Instances
Eq Schema Source # | |
Data Schema Source # | |
Defined in Network.Google.CloudSearch.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Schema -> c Schema # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Schema # toConstr :: Schema -> Constr # dataTypeOf :: Schema -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Schema) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Schema) # gmapT :: (forall b. Data b => b -> b) -> Schema -> Schema # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Schema -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Schema -> r # gmapQ :: (forall d. Data d => d -> u) -> Schema -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Schema -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Schema -> m Schema # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Schema -> m Schema # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Schema -> m Schema # | |
Show Schema Source # | |
Generic Schema Source # | |
ToJSON Schema Source # | |
Defined in Network.Google.CloudSearch.Types.Product | |
FromJSON Schema Source # | |
type Rep Schema Source # | |
Defined in Network.Google.CloudSearch.Types.Product type Rep Schema = D1 (MetaData "Schema" "Network.Google.CloudSearch.Types.Product" "gogol-cloudsearch-0.4.0-5yB3RjcJJrULTqYmbhTTen" False) (C1 (MetaCons "Schema'" PrefixI True) (S1 (MetaSel (Just "_sObjectDefinitions") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [ObjectDefinition])) :*: S1 (MetaSel (Just "_sOperationIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) |
Creates a value of Schema
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sObjectDefinitions :: Lens' Schema [ObjectDefinition] Source #
The list of top-level objects for the data source. The maximum number of elements is 10.
sOperationIds :: Lens' Schema [Text] Source #
IDs of the Long Running Operations (LROs) currently running for this schema. After modifying the schema, wait for opeations to complete before indexing additional content.
DriveTimeSpanRestrict
data DriveTimeSpanRestrict Source #
The time span search restrict (e.g. "after:2017-09-11 before:2017-09-12").
See: driveTimeSpanRestrict
smart constructor.
Instances
driveTimeSpanRestrict :: DriveTimeSpanRestrict Source #
Creates a value of DriveTimeSpanRestrict
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ResultDisplayField
data ResultDisplayField Source #
Display Fields for Search Results
See: resultDisplayField
smart constructor.
Instances
resultDisplayField :: ResultDisplayField Source #
Creates a value of ResultDisplayField
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdfProperty :: Lens' ResultDisplayField (Maybe NamedProperty) Source #
The name value pair for the property.
rdfOperatorName :: Lens' ResultDisplayField (Maybe Text) Source #
The operator name of the property.
UpdateSchemaRequest
data UpdateSchemaRequest Source #
Instances
updateSchemaRequest :: UpdateSchemaRequest Source #
Creates a value of UpdateSchemaRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
usrValidateOnly :: Lens' UpdateSchemaRequest (Maybe Bool) Source #
If true, the request will be validated without side effects.
usrDebugOptions :: Lens' UpdateSchemaRequest (Maybe DebugOptions) Source #
Common debug options.
Date
Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The date must be a valid calendar date between the year 1 and 9999.
See: date
smart constructor.
Instances
Eq Date Source # | |
Data Date Source # | |
Defined in Network.Google.CloudSearch.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Date -> c Date # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Date # dataTypeOf :: Date -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Date) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Date) # gmapT :: (forall b. Data b => b -> b) -> Date -> Date # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Date -> r # gmapQ :: (forall d. Data d => d -> u) -> Date -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Date -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Date -> m Date # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Date -> m Date # | |
Show Date Source # | |
Generic Date Source # | |
ToJSON Date Source # | |
Defined in Network.Google.CloudSearch.Types.Product | |
FromJSON Date Source # | |
type Rep Date Source # | |
Defined in Network.Google.CloudSearch.Types.Product type Rep Date = D1 (MetaData "Date" "Network.Google.CloudSearch.Types.Product" "gogol-cloudsearch-0.4.0-5yB3RjcJJrULTqYmbhTTen" False) (C1 (MetaCons "Date'" PrefixI True) (S1 (MetaSel (Just "_dDay") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: (S1 (MetaSel (Just "_dYear") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32))) :*: S1 (MetaSel (Just "_dMonth") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Int32)))))) |
dDay :: Lens' Date (Maybe Int32) Source #
Day of month. Must be from 1 to 31 and valid for the year and month.
DisplayedProperty
data DisplayedProperty Source #
A reference to a top-level property within the object that should be displayed in search results. The values of the chosen properties will be displayed in the search results along with the dislpay label for that property if one is specified. If a display label is not specified, only the values will be shown.
See: displayedProperty
smart constructor.
Instances
displayedProperty :: DisplayedProperty Source #
Creates a value of DisplayedProperty
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dpPropertyName :: Lens' DisplayedProperty (Maybe Text) Source #
The name of the top-level property as defined in a property definition for the object. If the name is not a defined property in the schema, an error will be given when attempting to update the schema.
FacetResult
data FacetResult Source #
Source specific facet response
See: facetResult
smart constructor.
Instances
facetResult :: FacetResult Source #
Creates a value of FacetResult
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
frSourceName :: Lens' FacetResult (Maybe Text) Source #
Source name for which facet results are returned. Will not be empty.
frBuckets :: Lens' FacetResult [FacetBucket] Source #
FacetBuckets for values in response containing atleast a single result.
frObjectType :: Lens' FacetResult (Maybe Text) Source #
Object type for which facet results are returned. Can be empty.
frOperatorName :: Lens' FacetResult (Maybe Text) Source #
Name of the operator chosen for faceting. 'see cloudsearch.SchemaPropertyOptions
DriveMimeTypeRestrict
data DriveMimeTypeRestrict Source #
Drive mime-type search restricts (e.g. "type:pdf").
See: driveMimeTypeRestrict
smart constructor.
Instances
driveMimeTypeRestrict :: DriveMimeTypeRestrict Source #
Creates a value of DriveMimeTypeRestrict
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
StructuredDataObject
data StructuredDataObject Source #
A structured data object consisting of named properties.
See: structuredDataObject
smart constructor.
Instances
structuredDataObject :: StructuredDataObject Source #
Creates a value of StructuredDataObject
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdoProperties :: Lens' StructuredDataObject [NamedProperty] Source #
The properties for the object. The maximum number of elements is 1000.
Media
Media resource.
See: media
smart constructor.
Instances
Eq Media Source # | |
Data Media Source # | |
Defined in Network.Google.CloudSearch.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Media -> c Media # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Media # dataTypeOf :: Media -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Media) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Media) # gmapT :: (forall b. Data b => b -> b) -> Media -> Media # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Media -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Media -> r # gmapQ :: (forall d. Data d => d -> u) -> Media -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Media -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Media -> m Media # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Media -> m Media # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Media -> m Media # | |
Show Media Source # | |
Generic Media Source # | |
ToJSON Media Source # | |
Defined in Network.Google.CloudSearch.Types.Product | |
FromJSON Media Source # | |
type Rep Media Source # | |
Defined in Network.Google.CloudSearch.Types.Product |
Creates a value of Media
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ItemStructuredData
data ItemStructuredData Source #
Available structured data fields for the item.
See: itemStructuredData
smart constructor.
Instances
itemStructuredData :: ItemStructuredData Source #
Creates a value of ItemStructuredData
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
isdHash :: Lens' ItemStructuredData (Maybe Text) Source #
Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
isdObject :: Lens' ItemStructuredData (Maybe StructuredDataObject) Source #
The structured data object that should conform to a registered object definition in the schema for the data source.
DriveFollowUpRestrict
data DriveFollowUpRestrict Source #
Drive follow-up search restricts (e.g. "followup:suggestions").
See: driveFollowUpRestrict
smart constructor.
Instances
driveFollowUpRestrict :: DriveFollowUpRestrict Source #
Creates a value of DriveFollowUpRestrict
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
DateValues
data DateValues Source #
List of date values.
See: dateValues
smart constructor.
Instances
dateValues :: DateValues Source #
Creates a value of DateValues
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
NamedProperty
data NamedProperty Source #
A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`.
See: namedProperty
smart constructor.
Instances
namedProperty :: NamedProperty Source #
Creates a value of NamedProperty
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
npName :: Lens' NamedProperty (Maybe Text) Source #
The name of the property. This name should correspond to the name of the property that was registered for object definition in the schema. The maximum allowable length for this property is 256 characters.
MatchRange
data MatchRange Source #
Matched range of a snippet [start, end).
See: matchRange
smart constructor.
Instances
matchRange :: MatchRange Source #
Creates a value of MatchRange
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ResponseDebugInfo
data ResponseDebugInfo Source #
Debugging information about the response.
See: responseDebugInfo
smart constructor.
Instances
responseDebugInfo :: ResponseDebugInfo Source #
Creates a value of ResponseDebugInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rFormattedDebugInfo :: Lens' ResponseDebugInfo (Maybe Text) Source #
General debug info formatted for display.
ListDataSourceResponse
data ListDataSourceResponse Source #
Instances
listDataSourceResponse :: ListDataSourceResponse Source #
Creates a value of ListDataSourceResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ldsrNextPageToken :: Lens' ListDataSourceResponse (Maybe Text) Source #
Token to retrieve the next page of results, or empty if there are no more results in the list.
SearchRequest
data SearchRequest Source #
The search API request.
See: searchRequest
smart constructor.
Instances
searchRequest :: SearchRequest Source #
Creates a value of SearchRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srSortOptions :: Lens' SearchRequest (Maybe SortOptions) Source #
The options for sorting the search results
srDataSourceRestrictions :: Lens' SearchRequest [DataSourceRestriction] Source #
The sources to use for querying. If not specified, all data sources from the current search application are used.
srQueryInterpretationOptions :: Lens' SearchRequest (Maybe QueryInterpretationOptions) Source #
Options to interpret the user query.
srQuery :: Lens' SearchRequest (Maybe Text) Source #
The raw query string. See supported search operators in the Cloud search Cheat Sheet
srPageSize :: Lens' SearchRequest (Maybe Int32) Source #
Maximum number of search results to return in one page. Valid values are between 1 and 100, inclusive. Default value is 10.
srRequestOptions :: Lens' SearchRequest (Maybe RequestOptions) Source #
Request options, such as the search application and user timezone.
Name
A person's name.
See: name
smart constructor.
Instances
Eq Name Source # | |
Data Name Source # | |
Defined in Network.Google.CloudSearch.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Name -> c Name # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Name # dataTypeOf :: Name -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Name) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Name) # gmapT :: (forall b. Data b => b -> b) -> Name -> Name # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Name -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Name -> r # gmapQ :: (forall d. Data d => d -> u) -> Name -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Name -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Name -> m Name # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Name -> m Name # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Name -> m Name # | |
Show Name Source # | |
Generic Name Source # | |
ToJSON Name Source # | |
Defined in Network.Google.CloudSearch.Types.Product | |
FromJSON Name Source # | |
type Rep Name Source # | |
Defined in Network.Google.CloudSearch.Types.Product |
Creates a value of Name
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nDisplayName :: Lens' Name (Maybe Text) Source #
The read-only display name formatted according to the locale specified by the viewer's account or the 'Accept-Language' HTTP header.
SourceResultCount
data SourceResultCount Source #
Per source result count information.
See: sourceResultCount
smart constructor.
Instances
sourceResultCount :: SourceResultCount Source #
Creates a value of SourceResultCount
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srcHasMoreResults :: Lens' SourceResultCount (Maybe Bool) Source #
Whether there are more search results for this source.
srcResultCountExact :: Lens' SourceResultCount (Maybe Int64) Source #
The exact result count for this source.
srcResultCountEstimate :: Lens' SourceResultCount (Maybe Int64) Source #
The estimated result count for this source.
srcSource :: Lens' SourceResultCount (Maybe Source) Source #
The source the result count information is associated with.
SourceConfig
data SourceConfig Source #
Configurations for a source while processing a Search or Suggest request.
See: sourceConfig
smart constructor.
Instances
sourceConfig :: SourceConfig Source #
Creates a value of SourceConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scCrowdingConfig :: Lens' SourceConfig (Maybe SourceCrowdingConfig) Source #
The crowding configuration for the source.
scScoringConfig :: Lens' SourceConfig (Maybe SourceScoringConfig) Source #
The scoring configuration for the source.
scSource :: Lens' SourceConfig (Maybe Source) Source #
The source for which this configuration is to be used.
UnmAppedIdentityResolutionStatusCode
data UnmAppedIdentityResolutionStatusCode Source #
The resolution status for the external identity.
Constructors
UAIRSCCodeUnspecified |
|
UAIRSCNotFound |
|
UAIRSCIdentitySourceNotFound |
|
UAIRSCIdentitySourceMisConfigured |
|
UAIRSCTooManyMAppingsFound |
|
UAIRSCInternalError |
|
Instances
ListItemsResponse
data ListItemsResponse Source #
Instances
listItemsResponse :: ListItemsResponse Source #
Creates a value of ListItemsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lirNextPageToken :: Lens' ListItemsResponse (Maybe Text) Source #
Token to retrieve the next page of results, or empty if there are no more results in the list.
ScoringConfig
data ScoringConfig Source #
Scoring configurations for a source while processing a Search or Suggest request.
See: scoringConfig
smart constructor.
Instances
scoringConfig :: ScoringConfig Source #
Creates a value of ScoringConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scDisablePersonalization :: Lens' ScoringConfig (Maybe Bool) Source #
Whether to personalize the results. By default, personal signals will be used to boost results.
scDisableFreshness :: Lens' ScoringConfig (Maybe Bool) Source #
Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal.
StartUploadItemRequest
data StartUploadItemRequest Source #
Start upload file request.
See: startUploadItemRequest
smart constructor.
Instances
startUploadItemRequest :: StartUploadItemRequest Source #
Creates a value of StartUploadItemRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
suirDebugOptions :: Lens' StartUploadItemRequest (Maybe DebugOptions) Source #
Common debug options.
suirConnectorName :: Lens' StartUploadItemRequest (Maybe Text) Source #
Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
UploadItemRef
data UploadItemRef Source #
Represents an upload session reference. This reference is created via upload method. Updating of item content may refer to this uploaded content via contentDataRef.
See: uploadItemRef
smart constructor.
Instances
uploadItemRef :: UploadItemRef Source #
Creates a value of UploadItemRef
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uirName :: Lens' UploadItemRef (Maybe Text) Source #
Name of the content reference. The maximum length is 2048 characters.
PushItemRequest
data PushItemRequest Source #
Instances
pushItemRequest :: PushItemRequest Source #
Creates a value of PushItemRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pirDebugOptions :: Lens' PushItemRequest (Maybe DebugOptions) Source #
Common debug options.
pirConnectorName :: Lens' PushItemRequest (Maybe Text) Source #
Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
DoublePropertyOptions
data DoublePropertyOptions Source #
Options for double properties.
See: doublePropertyOptions
smart constructor.
Instances
doublePropertyOptions :: DoublePropertyOptions Source #
Creates a value of DoublePropertyOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dpoOperatorOptions :: Lens' DoublePropertyOptions (Maybe DoubleOperatorOptions) Source #
If set, describes how the double should be used as a search operator.
QueryOperator
data QueryOperator Source #
The definition of a operator that can be used in a Search/Suggest request.
See: queryOperator
smart constructor.
Instances
queryOperator :: QueryOperator Source #
Creates a value of QueryOperator
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qoIsSuggestable :: Lens' QueryOperator (Maybe Bool) Source #
Can get suggestions for this field.
qoIsReturnable :: Lens' QueryOperator (Maybe Bool) Source #
Will the property associated with this facet be returned as part of search results.
qoIsRepeatable :: Lens' QueryOperator (Maybe Bool) Source #
Indicates if multiple values can be set for this property.
qoOperatorName :: Lens' QueryOperator (Maybe Text) Source #
The name of the operator.
qoIsSortable :: Lens' QueryOperator (Maybe Bool) Source #
Can this operator be used to sort results.
qoIsFacetable :: Lens' QueryOperator (Maybe Bool) Source #
Can this operator be used to get facets.
qoDisplayName :: Lens' QueryOperator (Maybe Text) Source #
Display name of the operator
qoLessThanOperatorName :: Lens' QueryOperator (Maybe Text) Source #
Indicates the operator name that can be used to isolate the property using the less-than operator.
qoType :: Lens' QueryOperator (Maybe QueryOperatorType) Source #
Type of the operator.
qoEnumValues :: Lens' QueryOperator [Text] Source #
Potential list of values for the opeatror field. This field is only filled when we can safely enumerate all the possible values of this operator.
qoGreaterThanOperatorName :: Lens' QueryOperator (Maybe Text) Source #
Indicates the operator name that can be used to isolate the property using the greater-than operator.
Xgafv
V1 error format.
Instances
PollItemsResponse
data PollItemsResponse Source #
Instances
pollItemsResponse :: PollItemsResponse Source #
Creates a value of PollItemsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pirItems :: Lens' PollItemsResponse [Item] Source #
Set of items from the queue available for connector to process. These items have the following subset of fields populated: version metadata.hash structured_data.hash content.hash payload status queue
SourceScoringConfig
data SourceScoringConfig Source #
Set the scoring configuration. This allows modifying the ranking of results for a source.
See: sourceScoringConfig
smart constructor.
Instances
sourceScoringConfig :: SourceScoringConfig Source #
Creates a value of SourceScoringConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sscSourceImportance :: Lens' SourceScoringConfig (Maybe SourceScoringConfigSourceImportance) Source #
Importance of the source.
EmailAddress
data EmailAddress Source #
A person's email address.
See: emailAddress
smart constructor.
Instances
emailAddress :: EmailAddress Source #
Creates a value of EmailAddress
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eaEmailAddress :: Lens' EmailAddress (Maybe Text) Source #
The email address.
RetrievalImportance
data RetrievalImportance Source #
Instances
retrievalImportance :: RetrievalImportance Source #
Creates a value of RetrievalImportance
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
riImportance :: Lens' RetrievalImportance (Maybe RetrievalImportanceImportance) Source #
Indicates the ranking importance given to property when it is matched during retrieval. Once set, the token importance of a property cannot be changed.
DataSourceIndexStats
data DataSourceIndexStats Source #
Aggregation of items by status code as of the specified date.
See: dataSourceIndexStats
smart constructor.
Instances
dataSourceIndexStats :: DataSourceIndexStats Source #
Creates a value of DataSourceIndexStats
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsisItemCountByStatus :: Lens' DataSourceIndexStats [ItemCountByStatus] Source #
Number of items aggregrated by status code.
dsisDate :: Lens' DataSourceIndexStats (Maybe Date) Source #
Date for which index stats were calculated. If the date of request is not the current date then stats calculated on the next day are returned. Stats are calculated close to mid night in this case. If date of request is current date, then real time stats are returned.
SourceCrowdingConfig
data SourceCrowdingConfig Source #
Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host "crowd out" other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source.
See: sourceCrowdingConfig
smart constructor.
Instances
sourceCrowdingConfig :: SourceCrowdingConfig Source #
Creates a value of SourceCrowdingConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sccField :: Lens' SourceCrowdingConfig (Maybe Text) Source #
Use a field to control results crowding. For example, if you want to control overly similar results from Gmail topics, use `thread_id`. For similar pages from Google Sites, you can use `webspace_id`. When matching query results contain the same field value in `GenericMetadata`, crowding limits are set on those records.
sccNumSuggestions :: Lens' SourceCrowdingConfig (Maybe Int32) Source #
Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.
sccNumResults :: Lens' SourceCrowdingConfig (Maybe Int32) Source #
Maximum number of results allowed from a source. No limits will be set on results if this value is less than or equal to 0.
sccSource :: Lens' SourceCrowdingConfig (Maybe Bool) Source #
Control results by content source. This option limits the total number of results from a given source and ignores field-based crowding control.
Interaction
data Interaction Source #
Represents an interaction between a user and an item.
See: interaction
smart constructor.
Instances
interaction :: Interaction Source #
Creates a value of Interaction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iInteractionTime :: Lens' Interaction (Maybe UTCTime) Source #
The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.
iPrincipal :: Lens' Interaction (Maybe Principal) Source #
The user that acted on the item.
Principal
Reference to a user, group, or domain.
See: principal
smart constructor.
Instances
Eq Principal Source # | |
Data Principal Source # | |
Defined in Network.Google.CloudSearch.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Principal -> c Principal # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Principal # toConstr :: Principal -> Constr # dataTypeOf :: Principal -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Principal) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Principal) # gmapT :: (forall b. Data b => b -> b) -> Principal -> Principal # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Principal -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Principal -> r # gmapQ :: (forall d. Data d => d -> u) -> Principal -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Principal -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Principal -> m Principal # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Principal -> m Principal # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Principal -> m Principal # | |
Show Principal Source # | |
Generic Principal Source # | |
ToJSON Principal Source # | |
Defined in Network.Google.CloudSearch.Types.Product | |
FromJSON Principal Source # | |
type Rep Principal Source # | |
Defined in Network.Google.CloudSearch.Types.Product type Rep Principal = D1 (MetaData "Principal" "Network.Google.CloudSearch.Types.Product" "gogol-cloudsearch-0.4.0-5yB3RjcJJrULTqYmbhTTen" False) (C1 (MetaCons "Principal'" PrefixI True) (S1 (MetaSel (Just "_pUserResourceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_pGroupResourceName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pGsuitePrincipal") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GSuitePrincipal))))) |
principal :: Principal Source #
Creates a value of Principal
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pUserResourceName :: Lens' Principal (Maybe Text) Source #
This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}
pGroupResourceName :: Lens' Principal (Maybe Text) Source #
This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}
pGsuitePrincipal :: Lens' Principal (Maybe GSuitePrincipal) Source #
This principal is a GSuite user, group or domain.
IndexItemRequest
data IndexItemRequest Source #
Instances
indexItemRequest :: IndexItemRequest Source #
Creates a value of IndexItemRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iirMode :: Lens' IndexItemRequest (Maybe IndexItemRequestMode) Source #
Required. The RequestMode for this request.
iirDebugOptions :: Lens' IndexItemRequest (Maybe DebugOptions) Source #
Common debug options.
iirConnectorName :: Lens' IndexItemRequest (Maybe Text) Source #
Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
iirItem :: Lens' IndexItemRequest (Maybe Item) Source #
Name of the item. Format: datasources/{source_id}/items/{item_id}
RepositoryErrorType
data RepositoryErrorType Source #
Type of error.
Constructors
Unknown |
|
NetworkError |
|
DNSError |
|
ConnectionError |
|
AuthenticationError |
|
AuthorizationError |
|
ServerError |
|
QuotaExceeded |
|
ServiceUnavailable |
|
ClientError |
|
Instances
TextPropertyOptions
data TextPropertyOptions Source #
Options for text properties.
See: textPropertyOptions
smart constructor.
Instances
textPropertyOptions :: TextPropertyOptions Source #
Creates a value of TextPropertyOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tRetrievalImportance :: Lens' TextPropertyOptions (Maybe RetrievalImportance) Source #
Indicates the search quality importance of the tokens within the field when used for retrieval.
tOperatorOptions :: Lens' TextPropertyOptions (Maybe TextOperatorOptions) Source #
If set, describes how the property should be used as a search operator.
EnumValuePair
data EnumValuePair Source #
The enumeration value pair defines two things: a required string value and an optional integer value. The string value defines the necessary query term required to retrieve that item, such as *p0* for a priority item. The integer value determines the ranking of that string value relative to other enumerated values for the same property. For example, you might associate *p0* with *0* and define another enum pair such as *p1* and *1*. You must use the integer value in combination with ordered ranking to set the ranking of a given value relative to other enumerated values for the same property name. Here, a ranking order of DESCENDING for *priority* properties results in a ranking boost for items indexed with a value of *p0* compared to items indexed with a value of *p1*. Without a specified ranking order, the integer value has no effect on item ranking.
See: enumValuePair
smart constructor.
Instances
enumValuePair :: EnumValuePair Source #
Creates a value of EnumValuePair
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
evpIntegerValue :: Lens' EnumValuePair (Maybe Int32) Source #
The integer value of the EnumValuePair which must be non-negative. Optional.
evpStringValue :: Lens' EnumValuePair (Maybe Text) Source #
The string value of the EnumValuePair. The maximum length is 32 characters.
DriveLocationRestrictType
data DriveLocationRestrictType Source #
Constructors
DLRTUnspecified | UNSPECIFIED |
DLRTTrashed | TRASHED |
DLRTStarred | STARRED |
Instances
Metadata
Metadata of a matched search result.
See: metadata
smart constructor.
Instances
Creates a value of Metadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mOwner :: Lens' Metadata (Maybe Person) Source #
Owner (usually creator) of the document or object of the search result.
mUpdateTime :: Lens' Metadata (Maybe UTCTime) Source #
The last modified date for the object in the search result.
mDisplayOptions :: Lens' Metadata (Maybe ResultDisplayMetadata) Source #
Options that specify how to display a structured data search result.
mCreateTime :: Lens' Metadata (Maybe UTCTime) Source #
The creation time for this document or object in the search result.
mFields :: Lens' Metadata [NamedProperty] Source #
Indexed fields in structured data, returned as a generic named property.
UpdateDataSourceRequest
data UpdateDataSourceRequest Source #
Instances
updateDataSourceRequest :: UpdateDataSourceRequest Source #
Creates a value of UpdateDataSourceRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
udsrDebugOptions :: Lens' UpdateDataSourceRequest (Maybe DebugOptions) Source #
Common debug options.
DataSource
data DataSource Source #
Data source is a logical namespace for items to be indexed. All items must belong to a data source. This is the prerequisite before items can be indexed into Cloud Search.
See: dataSource
smart constructor.
Instances
dataSource :: DataSource Source #
Creates a value of DataSource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsShortName :: Lens' DataSource (Maybe Text) Source #
A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *<value>* then queries like *source:<value>* will only return results for this source. The value must be unique across all data sources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep. Its maximum length is 32 characters.
dsItemsVisibility :: Lens' DataSource [GSuitePrincipal] Source #
This restricts visibility to items at a data source level to the disjunction of users/groups mentioned with the field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire data source, and that the individual items are not shared outside this visibility.
dsOperationIds :: Lens' DataSource [Text] Source #
IDs of the Long Running Operations (LROs) currently running for this schema.
dsDisableServing :: Lens' DataSource (Maybe Bool) Source #
Disable serving any search or assist results.
dsIndexingServiceAccounts :: Lens' DataSource [Text] Source #
List of service accounts that have indexing access.
dsDisableModifications :: Lens' DataSource (Maybe Bool) Source #
If true, Indexing API rejects any modification calls to this data source such as create, update, and delete. Disabling this does not imply halting process of previously accepted data.
dsName :: Lens' DataSource (Maybe Text) Source #
Name of the data source resource. Format: datasources/{source_id}. The name is ignored when creating a data source.
dsDisplayName :: Lens' DataSource (Maybe Text) Source #
Required. Display name of the data source The maximum length is 300 characters.
HTMLValues
data HTMLValues Source #
List of html values.
See: htmlValues
smart constructor.
Instances
htmlValues :: HTMLValues Source #
Creates a value of HTMLValues
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hvValues :: Lens' HTMLValues [Text] Source #
The maximum allowable length for html values is 2048 characters. The maximum number of string elements is 100.
HTMLOperatorOptions
data HTMLOperatorOptions Source #
Used to provide a search operator for html properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
See: htmlOperatorOptions
smart constructor.
Instances
htmlOperatorOptions :: HTMLOperatorOptions Source #
Creates a value of HTMLOperatorOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hooOperatorName :: Lens' HTMLOperatorOptions (Maybe Text) Source #
Indicates the operator name required in the query in order to isolate the html property. For example, if operatorName is *subject* and the property's name is *subjectLine*, then queries like *subject:<value>* will show results only where the value of the property named *subjectLine* matches *<value>*. By contrast, a search that uses the same *<value>* without an operator will return all items where *<value>* matches the value of any html properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
Item
Represents a single object that is an item in the search index, such as a file, folder, or a database record.
See: item
smart constructor.
Instances
iPayload :: Lens' Item (Maybe ByteString) Source #
Additional state connector can store for this item. The maximum length is 10000 bytes.
iStructuredData :: Lens' Item (Maybe ItemStructuredData) Source #
The structured data for the item that should conform to a registered object definition in the schema for the data source.
iQueue :: Lens' Item (Maybe Text) Source #
Queue this item belongs to. The maximum length is 100 characters.
iContent :: Lens' Item (Maybe ItemContent) Source #
Item content to be indexed and made text searchable.
iName :: Lens' Item (Maybe Text) Source #
Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.
iVersion :: Lens' Item (Maybe ByteString) Source #
Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.
Source
Defines sources for the suggest/search APIs.
See: source
smart constructor.
Instances
Eq Source Source # | |
Data Source Source # | |
Defined in Network.Google.CloudSearch.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Source -> c Source # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Source # toConstr :: Source -> Constr # dataTypeOf :: Source -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Source) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Source) # gmapT :: (forall b. Data b => b -> b) -> Source -> Source # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Source -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Source -> r # gmapQ :: (forall d. Data d => d -> u) -> Source -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Source -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Source -> m Source # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Source -> m Source # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Source -> m Source # | |
Show Source Source # | |
Generic Source Source # | |
ToJSON Source Source # | |
Defined in Network.Google.CloudSearch.Types.Product | |
FromJSON Source Source # | |
type Rep Source Source # | |
Defined in Network.Google.CloudSearch.Types.Product type Rep Source = D1 (MetaData "Source" "Network.Google.CloudSearch.Types.Product" "gogol-cloudsearch-0.4.0-5yB3RjcJJrULTqYmbhTTen" False) (C1 (MetaCons "Source'" PrefixI True) (S1 (MetaSel (Just "_sName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_sPredefinedSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe SourcePredefinedSource)))) |
Creates a value of Source
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sPredefinedSource :: Lens' Source (Maybe SourcePredefinedSource) Source #
Predefined content source for Google Apps.
PropertyDisplayOptions
data PropertyDisplayOptions Source #
The display options for a property.
See: propertyDisplayOptions
smart constructor.
Instances
propertyDisplayOptions :: PropertyDisplayOptions Source #
Creates a value of PropertyDisplayOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pdoDisplayLabel :: Lens' PropertyDisplayOptions (Maybe Text) Source #
The user friendly label for the property that will be used if the property is specified to be displayed in ObjectDisplayOptions. If given, the display label will be shown in front of the property values when the property is part of the object display options. For example, if the property value is '1', the value by itself may not be useful context for the user. If the display name given was 'priority', then the user will see 'priority : 1' in the search results which provides clear conext to search users. This is OPTIONAL; if not given, only the property values will be displayed. The maximum length is 32 characters.
ObjectValues
data ObjectValues Source #
List of object values.
See: objectValues
smart constructor.
Instances
objectValues :: ObjectValues Source #
Creates a value of ObjectValues
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ovValues :: Lens' ObjectValues [StructuredDataObject] Source #
The maximum number of elements is 100.
ObjectOptions
data ObjectOptions Source #
The options for an object.
See: objectOptions
smart constructor.
Instances
objectOptions :: ObjectOptions Source #
Creates a value of ObjectOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ooFreshnessOptions :: Lens' ObjectOptions (Maybe FreshnessOptions) Source #
The freshness options for an object.
ooDisplayOptions :: Lens' ObjectOptions (Maybe ObjectDisplayOptions) Source #
Options that determine how the object is displayed in the Cloud Search results page.
FacetOptions
data FacetOptions Source #
Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
See: facetOptions
smart constructor.
Instances
facetOptions :: FacetOptions Source #
Creates a value of FacetOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fSourceName :: Lens' FacetOptions (Maybe Text) Source #
Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.
fObjectType :: Lens' FacetOptions (Maybe Text) Source #
If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.
fOperatorName :: Lens' FacetOptions (Maybe Text) Source #
Name of the operator chosen for faceting. 'see cloudsearch.SchemaPropertyOptions
SuggestRequest
data SuggestRequest Source #
Request of suggest API.
See: suggestRequest
smart constructor.
Instances
suggestRequest :: SuggestRequest Source #
Creates a value of SuggestRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sDataSourceRestrictions :: Lens' SuggestRequest [DataSourceRestriction] Source #
The sources to use for suggestions. If not specified, all data sources from the current search application are used.
sRequestOptions :: Lens' SuggestRequest (Maybe RequestOptions) Source #
Request options, such as the search application and user timezone.
Filter
A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND.
See: filter'
smart constructor.
Instances
Eq Filter Source # | |
Data Filter Source # | |
Defined in Network.Google.CloudSearch.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Filter -> c Filter # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Filter # toConstr :: Filter -> Constr # dataTypeOf :: Filter -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Filter) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Filter) # gmapT :: (forall b. Data b => b -> b) -> Filter -> Filter # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Filter -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Filter -> r # gmapQ :: (forall d. Data d => d -> u) -> Filter -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Filter -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Filter -> m Filter # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Filter -> m Filter # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Filter -> m Filter # | |
Show Filter Source # | |
Generic Filter Source # | |
ToJSON Filter Source # | |
Defined in Network.Google.CloudSearch.Types.Product | |
FromJSON Filter Source # | |
type Rep Filter Source # | |
Defined in Network.Google.CloudSearch.Types.Product type Rep Filter = D1 (MetaData "Filter" "Network.Google.CloudSearch.Types.Product" "gogol-cloudsearch-0.4.0-5yB3RjcJJrULTqYmbhTTen" False) (C1 (MetaCons "Filter'" PrefixI True) (S1 (MetaSel (Just "_fCompositeFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CompositeFilter)) :*: S1 (MetaSel (Just "_fValueFilter") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ValueFilter)))) |
Creates a value of Filter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ObjectDefinition
data ObjectDefinition Source #
The definition for an object within a data source.
See: objectDefinition
smart constructor.
Instances
objectDefinition :: ObjectDefinition Source #
Creates a value of ObjectDefinition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
odName :: Lens' ObjectDefinition (Maybe Text) Source #
Name for the object, which then defines its type. Item indexing requests should set the objectType field equal to this value. For example, if *name* is *Document*, then indexing requests for items of type Document should set objectType equal to *Document*. Each object definition must be uniquely named within a schema. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters.
odOptions :: Lens' ObjectDefinition (Maybe ObjectOptions) Source #
The optional object-specific options.
odPropertyDefinitions :: Lens' ObjectDefinition [PropertyDefinition] Source #
The property definitions for the object. The maximum number of elements is 1000.
ItemItemType
data ItemItemType Source #
Type for this item.
Constructors
IITUnspecified | UNSPECIFIED |
IITContentItem |
|
IITContainerItem |
|
IITVirtualContainerItem |
|
Instances
ItemCountByStatusStatusCode
data ItemCountByStatusStatusCode Source #
Status of the items.
Constructors
ICBSSCCodeUnspecified |
|
ICBSSCError' |
|
ICBSSCModified |
|
ICBSSCNewItem |
|
ICBSSCAccepted |
|
Instances
PollItemsRequest
data PollItemsRequest Source #
Instances
pollItemsRequest :: PollItemsRequest Source #
Creates a value of PollItemsRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pQueue :: Lens' PollItemsRequest (Maybe Text) Source #
Queue name to fetch items from. If unspecified, PollItems will fetch from 'default' queue. The maximum length is 100 characters.
pDebugOptions :: Lens' PollItemsRequest (Maybe DebugOptions) Source #
Common debug options.
pConnectorName :: Lens' PollItemsRequest (Maybe Text) Source #
Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
pStatusCodes :: Lens' PollItemsRequest [Text] Source #
Limit the items polled to the ones with these statuses.
pLimit :: Lens' PollItemsRequest (Maybe Int32) Source #
Maximum number of items to return. The maximum and the default value is 1000
QueryInterpretation
data QueryInterpretation Source #
Instances
queryInterpretation :: QueryInterpretation Source #
Creates a value of QueryInterpretation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qiInterpretedQuery :: Lens' QueryInterpretation (Maybe Text) Source #
The interpretation of the query used in search. For example, query "email from john" will be interpreted as "from:john source:mail"
qiInterpretationType :: Lens' QueryInterpretation (Maybe QueryInterpretationInterpretationType) Source #
UnmAppedIdentity
data UnmAppedIdentity Source #
Instances
unmAppedIdentity :: UnmAppedIdentity Source #
Creates a value of UnmAppedIdentity
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uaiResolutionStatusCode :: Lens' UnmAppedIdentity (Maybe UnmAppedIdentityResolutionStatusCode) Source #
The resolution status for the external identity.
uaiExternalIdentity :: Lens' UnmAppedIdentity (Maybe Principal) Source #
The resource name for an external user.
OperationMetadata
data OperationMetadata Source #
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.
See: operationMetadata
smart constructor.
Instances
Arguments
:: HashMap Text JSONValue | |
-> OperationMetadata |
Creates a value of OperationMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
omAddtional :: Lens' OperationMetadata (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
CustomerIndexStats
data CustomerIndexStats Source #
Aggregation of items by status code as of the specified date.
See: customerIndexStats
smart constructor.
Instances
customerIndexStats :: CustomerIndexStats Source #
Creates a value of CustomerIndexStats
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cisItemCountByStatus :: Lens' CustomerIndexStats [ItemCountByStatus] Source #
Number of items aggregrated by status code.
PushItem
Represents an item to be pushed to the indexing queue.
See: pushItem
smart constructor.
Instances
Creates a value of PushItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
piRepositoryError :: Lens' PushItem (Maybe RepositoryError) Source #
Populate this field to store Connector or repository error details. This information is displayed in the Admin Console. This field may only be populated when the Type is REPOSITORY_ERROR.
piContentHash :: Lens' PushItem (Maybe Text) Source #
Content hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.
piStructuredDataHash :: Lens' PushItem (Maybe Text) Source #
Structured data hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.
piPayload :: Lens' PushItem (Maybe ByteString) Source #
Provides additional document state information for the connector, such as an alternate repository ID and other metadata. The maximum length is 8192 bytes.
piQueue :: Lens' PushItem (Maybe Text) Source #
Queue to which this item belongs to. The 'default' queue is chosen if this field is not specified. The maximum length is 512 characters.
piMetadataHash :: Lens' PushItem (Maybe Text) Source #
Metadata hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.
piType :: Lens' PushItem (Maybe PushItemType) Source #
The type of the push operation that defines the push behavior.
ErrorMessage
data ErrorMessage Source #
Error message per source response.
See: errorMessage
smart constructor.
Instances
errorMessage :: ErrorMessage Source #
Creates a value of ErrorMessage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
BooleanPropertyOptions
data BooleanPropertyOptions Source #
Options for boolean properties.
See: booleanPropertyOptions
smart constructor.
Instances
booleanPropertyOptions :: BooleanPropertyOptions Source #
Creates a value of BooleanPropertyOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bpoOperatorOptions :: Lens' BooleanPropertyOptions (Maybe BooleanOperatorOptions) Source #
If set, describes how the boolean should be used as a search operator.
ValueFilter
data ValueFilter Source #
Instances
valueFilter :: ValueFilter Source #
Creates a value of ValueFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vfOperatorName :: Lens' ValueFilter (Maybe Text) Source #
The `operator_name` applied to the query, such as *price_greater_than*. The filter can work against both types of filters defined in the schema for your data source: 1. `operator_name`, where the query filters results by the property that matches the value. 2. `greater_than_operator_name` or `less_than_operator_name` in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
EnumOperatorOptions
data EnumOperatorOptions Source #
Used to provide a search operator for enum properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. For example, if you provide no operator for a *priority* enum property with possible values *p0* and *p1*, a query that contains the term *p0* will return items that have *p0* as the value of the *priority* property, as well as any items that contain the string *p0* in other fields. If you provide an operator name for the enum, such as *priority*, then search users can use that operator to refine results to only items that have *p0* as this property's value, with the query *priority:p0*.
See: enumOperatorOptions
smart constructor.
Instances
enumOperatorOptions :: EnumOperatorOptions Source #
Creates a value of EnumOperatorOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eooOperatorName :: Lens' EnumOperatorOptions (Maybe Text) Source #
Indicates the operator name required in the query in order to isolate the enum property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:<value>* will show results only where the value of the property named *priorityVal* matches *<value>*. By contrast, a search that uses the same *<value>* without an operator will return all items where *<value>* matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.
DatePropertyOptions
data DatePropertyOptions Source #
Options for date properties.
See: datePropertyOptions
smart constructor.
Instances
datePropertyOptions :: DatePropertyOptions Source #
Creates a value of DatePropertyOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dOperatorOptions :: Lens' DatePropertyOptions (Maybe DateOperatorOptions) Source #
If set, describes how the date should be used as a search operator.
EnumValues
data EnumValues Source #
List of enum values.
See: enumValues
smart constructor.
Instances
enumValues :: EnumValues Source #
Creates a value of EnumValues
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
evValues :: Lens' EnumValues [Text] Source #
The maximum allowable length for string values is 32 characters. The maximum number of elements is 100.
GSuitePrincipal
data GSuitePrincipal Source #
Instances
gSuitePrincipal :: GSuitePrincipal Source #
Creates a value of GSuitePrincipal
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gspGsuiteGroupEmail :: Lens' GSuitePrincipal (Maybe Text) Source #
This principal references a G Suite group account
gspGsuiteUserEmail :: Lens' GSuitePrincipal (Maybe Text) Source #
This principal references a G Suite user account
gspGsuiteDomain :: Lens' GSuitePrincipal (Maybe Bool) Source #
This principal represents all users of the G Suite domain of the customer.
SearchQualityMetadata
data SearchQualityMetadata Source #
Additional search quality metadata of the item.
See: searchQualityMetadata
smart constructor.
Instances
searchQualityMetadata :: SearchQualityMetadata Source #
Creates a value of SearchQualityMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sqmQuality :: Lens' SearchQualityMetadata (Maybe Double) Source #
An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality).
ItemContentContentFormat
data ItemContentContentFormat Source #
Constructors
ICCFUnspecified |
|
ICCFHTML |
|
ICCFText |
|
ICCFRaw |
|
Instances
TimestampValues
data TimestampValues Source #
List of timestamp values.
See: timestampValues
smart constructor.
Instances
timestampValues :: TimestampValues Source #
Creates a value of TimestampValues
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ErrorInfo
Error information about the response.
See: errorInfo
smart constructor.
Instances
Eq ErrorInfo Source # | |
Data ErrorInfo Source # | |
Defined in Network.Google.CloudSearch.Types.Product Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ErrorInfo -> c ErrorInfo # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ErrorInfo # toConstr :: ErrorInfo -> Constr # dataTypeOf :: ErrorInfo -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ErrorInfo) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ErrorInfo) # gmapT :: (forall b. Data b => b -> b) -> ErrorInfo -> ErrorInfo # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ErrorInfo -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ErrorInfo -> r # gmapQ :: (forall d. Data d => d -> u) -> ErrorInfo -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ErrorInfo -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ErrorInfo -> m ErrorInfo # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ErrorInfo -> m ErrorInfo # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ErrorInfo -> m ErrorInfo # | |
Show ErrorInfo Source # | |
Generic ErrorInfo Source # | |
ToJSON ErrorInfo Source # | |
Defined in Network.Google.CloudSearch.Types.Product | |
FromJSON ErrorInfo Source # | |
type Rep ErrorInfo Source # | |
Defined in Network.Google.CloudSearch.Types.Product type Rep ErrorInfo = D1 (MetaData "ErrorInfo" "Network.Google.CloudSearch.Types.Product" "gogol-cloudsearch-0.4.0-5yB3RjcJJrULTqYmbhTTen" True) (C1 (MetaCons "ErrorInfo'" PrefixI True) (S1 (MetaSel (Just "_eiErrorMessages") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [ErrorMessage])))) |
errorInfo :: ErrorInfo Source #
Creates a value of ErrorInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ResultDisplayMetadata
data ResultDisplayMetadata Source #
Instances
resultDisplayMetadata :: ResultDisplayMetadata Source #
Creates a value of ResultDisplayMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdmMetalines :: Lens' ResultDisplayMetadata [ResultDisplayLine] Source #
The metalines content to be displayed with the result.
rdmObjectTypeLabel :: Lens' ResultDisplayMetadata (Maybe Text) Source #
The display label for the object.
OperationResponse
data OperationResponse Source #
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`.
See: operationResponse
smart constructor.
Instances
Arguments
:: HashMap Text JSONValue | |
-> OperationResponse |
Creates a value of OperationResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
orAddtional :: Lens' OperationResponse (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
IntegerValues
data IntegerValues Source #
List of integer values.
See: integerValues
smart constructor.
Instances
integerValues :: IntegerValues Source #
Creates a value of IntegerValues
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
SearchItemsByViewURLResponse
data SearchItemsByViewURLResponse Source #
Instances
searchItemsByViewURLResponse :: SearchItemsByViewURLResponse Source #
Creates a value of SearchItemsByViewURLResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sibvurNextPageToken :: Lens' SearchItemsByViewURLResponse (Maybe Text) Source #
Token to retrieve the next page of results, or empty if there are no more results in the list.
SourcePredefinedSource
data SourcePredefinedSource Source #
Predefined content source for Google Apps.
Constructors
SPSNone | NONE |
SPSQueryHistory |
|
SPSPerson |
|
SPSGoogleDrive | GOOGLE_DRIVE |
SPSGoogleGmail | GOOGLE_GMAIL |
SPSGoogleSites | GOOGLE_SITES |
SPSGoogleGroups | GOOGLE_GROUPS |
SPSGoogleCalendar | GOOGLE_CALENDAR |
SPSGoogleKeep | GOOGLE_KEEP |
Instances
GetCustomerIndexStatsResponse
data GetCustomerIndexStatsResponse Source #
Instances
getCustomerIndexStatsResponse :: GetCustomerIndexStatsResponse Source #
Creates a value of GetCustomerIndexStatsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gcisrStats :: Lens' GetCustomerIndexStatsResponse [CustomerIndexStats] Source #
Summary of indexed item counts, one for each day in the requested range.
RestrictItem
data RestrictItem Source #
Information relevant only to a restrict entry. NextId: 7
See: restrictItem
smart constructor.
Instances
restrictItem :: RestrictItem Source #
Creates a value of RestrictItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
riSearchOperator :: Lens' RestrictItem (Maybe Text) Source #
The search restrict (e.g. "after:2017-09-11 before:2017-09-12").
DriveTimeSpanRestrictType
data DriveTimeSpanRestrictType Source #
Constructors
DTSRTUnspecified | UNSPECIFIED |
DTSRTToday | TODAY |
DTSRTYesterday | YESTERDAY |
DTSRTLast7Days | LAST_7_DAYS |
DTSRTLast30Days |
|
DTSRTLast90Days |
|
Instances
IndexItemRequestMode
data IndexItemRequestMode Source #
Required. The RequestMode for this request.
Constructors
IIRMUnspecified |
|
IIRMSynchronous |
|
IIRMAsynchronous |
|
Instances
ItemACLACLInheritanceType
data ItemACLACLInheritanceType Source #
Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.
Constructors
NotApplicable |
|
ChildOverride |
|
ParentOverride |
|
BothPermit |
|
Instances
CheckAccessResponse
data CheckAccessResponse Source #
Instances
checkAccessResponse :: CheckAccessResponse Source #
Creates a value of CheckAccessResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
carHasAccess :: Lens' CheckAccessResponse (Maybe Bool) Source #
Returns true if principal has access. Returns false otherwise.
RequestOptions
data RequestOptions Source #
Shared request options for all RPC methods.
See: requestOptions
smart constructor.
Instances
requestOptions :: RequestOptions Source #
Creates a value of RequestOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
roLanguageCode :: Lens' RequestOptions (Maybe Text) Source #
The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations.
roDebugOptions :: Lens' RequestOptions (Maybe DebugOptions) Source #
Debug options of the request
roTimeZone :: Lens' RequestOptions (Maybe Text) Source #
Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by Unicode Common Locale Data Repository (CLDR) project, and currently available in the file timezone.xml
roSearchApplicationId :: Lens' RequestOptions (Maybe Text) Source #
Id of the application created using SearchApplicationsService.
ItemStatus
data ItemStatus Source #
This contains item's status and any errors.
See: itemStatus
smart constructor.
Instances
itemStatus :: ItemStatus Source #
Creates a value of ItemStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
isProcessingErrors :: Lens' ItemStatus [ProcessingError] Source #
Error details in case the item is in ERROR state.
isCode :: Lens' ItemStatus (Maybe ItemStatusCode) Source #
Status code.
isRepositoryErrors :: Lens' ItemStatus [RepositoryError] Source #
Repository error reported by connector.