Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

Documentation

data GitHubDocumentCrawlProperties

Provides the configuration information to include certain types of GitHub content. You can configure to index repository files only, or also include issues and pull requests, comments, and comment attachments.

See: newGitHubDocumentCrawlProperties smart constructor.

Constructors

GitHubDocumentCrawlProperties'

Fields

• crawlIssue :: Maybe Bool

  TRUE to index all issues within a repository.

• crawlIssueComment :: Maybe Bool

  TRUE to index all comments on issues.

• crawlIssueCommentAttachment :: Maybe Bool

  TRUE to include all comment attachments for issues.

• crawlPullRequest :: Maybe Bool

  TRUE to index all pull requests within a repository.

• crawlPullRequestComment :: Maybe Bool

  TRUE to index all comments on pull requests.

• crawlPullRequestCommentAttachment :: Maybe Bool

  TRUE to include all comment attachments for pull requests.

• crawlRepositoryDocuments :: Maybe Bool

  TRUE to index all files with a repository.

Instances

FromJSON GitHubDocumentCrawlProperties

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

Methods

parseJSON :: Value -> Parser GitHubDocumentCrawlProperties

parseJSONList :: Value -> Parser [GitHubDocumentCrawlProperties]

ToJSON GitHubDocumentCrawlProperties

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

Methods

toJSON :: GitHubDocumentCrawlProperties -> Value

toEncoding :: GitHubDocumentCrawlProperties -> Encoding

toJSONList :: [GitHubDocumentCrawlProperties] -> Value

toEncodingList :: [GitHubDocumentCrawlProperties] -> Encoding

Generic GitHubDocumentCrawlProperties

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

Associated Types

type Rep GitHubDocumentCrawlProperties :: Type -> Type

Methods

from :: GitHubDocumentCrawlProperties -> Rep GitHubDocumentCrawlProperties x

to :: Rep GitHubDocumentCrawlProperties x -> GitHubDocumentCrawlProperties

Read GitHubDocumentCrawlProperties

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

Methods

readsPrec :: Int -> ReadS GitHubDocumentCrawlProperties

readList :: ReadS [GitHubDocumentCrawlProperties]

readPrec :: ReadPrec GitHubDocumentCrawlProperties

readListPrec :: ReadPrec [GitHubDocumentCrawlProperties]

Show GitHubDocumentCrawlProperties

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

Methods

showsPrec :: Int -> GitHubDocumentCrawlProperties -> ShowS

show :: GitHubDocumentCrawlProperties -> String

showList :: [GitHubDocumentCrawlProperties] -> ShowS

NFData GitHubDocumentCrawlProperties

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

Methods

rnf :: GitHubDocumentCrawlProperties -> ()

Eq GitHubDocumentCrawlProperties

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

Methods

(==) :: GitHubDocumentCrawlProperties -> GitHubDocumentCrawlProperties -> Bool

(/=) :: GitHubDocumentCrawlProperties -> GitHubDocumentCrawlProperties -> Bool

Hashable GitHubDocumentCrawlProperties

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

Methods

hashWithSalt :: Int -> GitHubDocumentCrawlProperties -> Int

hash :: GitHubDocumentCrawlProperties -> Int

type Rep GitHubDocumentCrawlProperties

Defined in Amazonka.Kendra.Types.GitHubDocumentCrawlProperties

type Rep GitHubDocumentCrawlProperties = D1 ('MetaData "GitHubDocumentCrawlProperties" "Amazonka.Kendra.Types.GitHubDocumentCrawlProperties" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GitHubDocumentCrawlProperties'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "crawlIssue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "crawlIssueComment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "crawlIssueCommentAttachment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "crawlPullRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "crawlPullRequestComment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "crawlPullRequestCommentAttachment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "crawlRepositoryDocuments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))

newGitHubDocumentCrawlProperties :: GitHubDocumentCrawlProperties

Create a value of GitHubDocumentCrawlProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:crawlIssue:GitHubDocumentCrawlProperties', gitHubDocumentCrawlProperties_crawlIssue - TRUE to index all issues within a repository.

$sel:crawlIssueComment:GitHubDocumentCrawlProperties', gitHubDocumentCrawlProperties_crawlIssueComment - TRUE to index all comments on issues.

$sel:crawlIssueCommentAttachment:GitHubDocumentCrawlProperties', gitHubDocumentCrawlProperties_crawlIssueCommentAttachment - TRUE to include all comment attachments for issues.

$sel:crawlPullRequest:GitHubDocumentCrawlProperties', gitHubDocumentCrawlProperties_crawlPullRequest - TRUE to index all pull requests within a repository.

$sel:crawlPullRequestComment:GitHubDocumentCrawlProperties', gitHubDocumentCrawlProperties_crawlPullRequestComment - TRUE to index all comments on pull requests.

$sel:crawlPullRequestCommentAttachment:GitHubDocumentCrawlProperties', gitHubDocumentCrawlProperties_crawlPullRequestCommentAttachment - TRUE to include all comment attachments for pull requests.

$sel:crawlRepositoryDocuments:GitHubDocumentCrawlProperties', gitHubDocumentCrawlProperties_crawlRepositoryDocuments - TRUE to index all files with a repository.

gitHubDocumentCrawlProperties_crawlIssue :: Lens' GitHubDocumentCrawlProperties (Maybe Bool)

TRUE to index all issues within a repository.

gitHubDocumentCrawlProperties_crawlIssueComment :: Lens' GitHubDocumentCrawlProperties (Maybe Bool)

TRUE to index all comments on issues.

gitHubDocumentCrawlProperties_crawlIssueCommentAttachment :: Lens' GitHubDocumentCrawlProperties (Maybe Bool)

TRUE to include all comment attachments for issues.

gitHubDocumentCrawlProperties_crawlPullRequest :: Lens' GitHubDocumentCrawlProperties (Maybe Bool)

TRUE to index all pull requests within a repository.

gitHubDocumentCrawlProperties_crawlPullRequestComment :: Lens' GitHubDocumentCrawlProperties (Maybe Bool)

TRUE to index all comments on pull requests.

gitHubDocumentCrawlProperties_crawlPullRequestCommentAttachment :: Lens' GitHubDocumentCrawlProperties (Maybe Bool)

TRUE to include all comment attachments for pull requests.

gitHubDocumentCrawlProperties_crawlRepositoryDocuments :: Lens' GitHubDocumentCrawlProperties (Maybe Bool)

TRUE to index all files with a repository.