addFileMetadata
Add File Metadata
|
Add information about documents found in the file system to the index, such as document owner, ACLs, etc.
type: boolean
default value: 'true '
|
additionalItemFilters
Additional item filters
|
Google Drive's API allows you to supply a filter query when listing files (see https://developers.google.com/Drive/v3/web/search-parameters#fn4 ) there are additional search parameters you can add to filter the files returned by Google Drive to be indexed. Example: modifiedTime > '2012-06-04T12:00:00'
type: string
|
changesPageSize
Changes API batch size
|
When doing an incremental crawl, the Google Drive Changes api is called to obtain all the changes seen for each user since last crawled. Changes are returned using multiple pages. This field defines the maximum number of changes to return per page. Acceptable values are 1 to 1000, inclusive. (Default: 500)
type: number
default value: '500 '
multipleOf: 1.0
|
childPageSize
Files list page size
|
During the crawl, each folder will be queried for child items, and the children will be returned in pages. This property controls the number of child files returned in each page. Max of 1000.
type: number
default value: '1000 '
multipleOf: 1.0
|
clientAccountProperties
Credentials for accessing Google Drive using single account
|
type: object
object attributes: {
}
|
connectTimeout
Google Drive connect timeout (ms)
|
Determines how long, in milliseconds, a request to the Google Drive API is allowed to take to connect prior to timing out
type: number
default value: '20000 '
multipleOf: 1.0
|
driveApiCacheSize
Google Drive API cache size
|
The number of Google Drive api connections to cache. Max of 1000.
type: number
default value: '10 '
multipleOf: 1.0
|
driveFileCacheSize
Google Drive file cache size
|
The number of Google Drive files to cache.
type: number
default value: '5000 '
multipleOf: 1.0
|
extraFileFieldsToIndex
Additional item fields to index
|
Google Drive by default will only index "id,createdTime,modifiedTime,size,name,description,mimeType,owners,permissions,webContentLink,webViewLink,fileExtension,trashed,parents". You can specify additional fields to index here. Note: You can only specify top level fields. Such as "capabilities". Specifying sub fields like "capabilities(canAddChildren,canRename)" will result in an error.
type: string
|
includeDirectories
Index Directories
|
When true, directory items are indexed as documents.
type: boolean
default value: 'false '
|
initialItemIds
Initial Google Drive Item IDs
|
The Google file or folder IDs to crawl. Leave empty if you want to crawl everything available.
type: array of string
|
readTimeout
Google Drive read timeout (ms)
|
Determines how long, in milliseconds, a request to the Google Drive API is allowed to attempt to read content prior to timing out
type: number
default value: '20000 '
multipleOf: 1.0
|
serviceAccountProperties
Credentials for accessing Google Drive using service account
|
type: object
object attributes: {
}
|
userQueryPageSize
User query batch size
|
The crawl process starts by querying for each Google account that will need to be crawled. Google directory api will be queried for users. This property controls page size of users fetched during each request. Max of 500.
type: number
default value: '100 '
multipleOf: 1.0
|
depthLimitConfig
Maximum Item Depth
|
Maximum depth level for fetch items. If an item has a depth greater than the configured value, it will not be fetched. The default is "no limit" (-1).
type: number
default value: '-1 '
exclusiveMaximum: false
exclusiveMinimum: false
maximum: 2147483647
minimum: -2147483648
multipleOf: 1.0
|
extensionConfig
Extension Config
|
excludedFileExtensions
A set of all file extensions to be skipped from the fetch.
type: array of string
default value: ' '
includedFileExtensions
Set of file extensions to be fetched. If specified, all non-matching files will be skipped.
type: array of string
default value: ' '
regexCacheSize
The number of regex matches to cache when evaluating regular expressions. For example if you exclude files by filename, each filename's regex result will be cached so that if this same filename came up again, the regex matches would be remembered.
type: number
default value: '10000 '
exclusiveMaximum: false
exclusiveMinimum: false
maximum: 2147483647
minimum: -2147483648
multipleOf: 1.0
|
fetchRetryProperties
Fetch Retry Properties
|
delayFactor
The retryer will retry failed operations in the case that they might succeed if attempted again. The retryer will sleep an exponential amount of time after the first failed attempt and retry in exponentially incrementing amounts after each failed attempt up to the maximumTime. nextWaitTime = exponentialIncrement * multiplier.
type: number
default value: '2.0 '
exclusiveMaximum: false
exclusiveMinimum: false
maximum: 9999.0
minimum: 1.0
multipleOf: 1.0
delayMs
Sets the delay between retries, exponentially backing off to the maxDelayTimeMs and multiplying successive delays by the delayFactor
type: number
default value: '1000 '
exclusiveMaximum: false
exclusiveMinimum: false
maximum: 9223372036854775807
minimum: 1
multipleOf: 1.0
errorExclusions
Optional regex list that will be matched against failed attempts exception class and message. If any regex matches, do not retry this request. This is needed to prevent the retryer from retrying non-recoverable errors that were not already ignored by the connector implementation.
type: array of string
maxDelayTimeMs
The maximum time wait time between successive retries.
type: number
default value: '300000 '
exclusiveMaximum: false
exclusiveMinimum: false
maximum: 600000
minimum: 1
multipleOf: 1.0
maxRetries
The retryer will retry failed operations in the case that they might succeed if attempted again. This parameter states the number of attempts to retry until giving up. This parameter, if specified, will override the "Stop retrying after time (milliseconds)" parameter.
type: number
default value: '3 '
exclusiveMaximum: false
exclusiveMinimum: false
maximum: 100
minimum: 0
multipleOf: 1.0
maxTimeLimitMs
This setting is used to limit the maximum amount of time spent on retries. Note: this will be ignored if "Maximum Retries" is specified.
type: number
default value: '600000 '
exclusiveMaximum: false
exclusiveMinimum: false
maximum: 28800000
minimum: 1
multipleOf: 1.0
|
maximumItemLimitConfig
Maximum Output Limit
|
Limits the number of items emitted to the configured IndexPipeline. The default is no limit (-1).
type: number
default value: '-1 '
exclusiveMaximum: false
exclusiveMinimum: false
maximum: 2147483647
minimum: -2147483648
multipleOf: 1.0
|
mimeTypeProperties
Mime Type Properties
|
excludedMimeTypes
A list of the Mime types to exclude from this crawl. NOTE: This is only used if the "Mime Type Includes" field is empty.
type: array of string
includedMimeTypes
A list of the Mime types to include in this crawl. Note: If you specify includes, the exclude mime types property will be ignored.
type: array of string
|
regexConfig
Regex Config
|
exclusiveRegexes
Regular expressions for URI patterns to exclude. This will limit this datasource to only URIs that do not match the regular expression.
type: array of string
default value: ' '
inclusiveRegexes
Regular expressions for URI patterns to include. This will limit this datasource to only URIs that match the regular expression.
type: array of string
default value: ' '
regexCacheSize
The number of regex matches to cache when evaluating regular expressions. For example if you exclude files by filename, each filename's regex result will be cached so that if this same filename came up again, the regex matches would be remembered.
type: number
default value: '10000 '
exclusiveMaximum: false
exclusiveMinimum: false
maximum: 2147483647
minimum: -2147483648
multipleOf: 1.0
|
securityTrimmingProperties
Security trimming configuration
|
enableSecurityTrimming
Enable indexing and query-time security-trimming
type: boolean
default value: 'true '
|
sizeLimitProperties
Size Limit Properties
|
maxSizeBytes
Used for excluding items when the item size is larger than the configured value.
type: number
default value: '-1 '
exclusiveMaximum: false
exclusiveMinimum: false
maximum: 2147483647
minimum: -2147483648
multipleOf: 1.0
minSizeBytes
Used for excluding items when the item size is smaller than the configured value.
type: number
default value: '1 '
exclusiveMaximum: false
exclusiveMinimum: false
maximum: 2147483647
minimum: -2147483648
multipleOf: 1.0
|