Skip to content

GitHubDocumentCrawlProperties

Source code in docs_src/capo_kendra/types/git_hub_document_crawl_properties.py
class GitHubDocumentCrawlProperties(TypedDict, closed=True):
    crawl_repository_documents: "capo_kendra.types.boolean.Boolean"
    """<p> <code>TRUE</code> to index all files with a repository.</p>"""
    crawl_issue: "capo_kendra.types.boolean.Boolean"
    """<p> <code>TRUE</code> to index all issues within a repository.</p>"""
    crawl_issue_comment: "capo_kendra.types.boolean.Boolean"
    """<p> <code>TRUE</code> to index all comments on issues.</p>"""
    crawl_issue_comment_attachment: "capo_kendra.types.boolean.Boolean"
    """<p> <code>TRUE</code> to include all comment attachments for issues.</p>"""
    crawl_pull_request: "capo_kendra.types.boolean.Boolean"
    """<p> <code>TRUE</code> to index all pull requests within a repository.</p>"""
    crawl_pull_request_comment: "capo_kendra.types.boolean.Boolean"
    """<p> <code>TRUE</code> to index all comments on pull requests.</p>"""
    crawl_pull_request_comment_attachment: "capo_kendra.types.boolean.Boolean"
    """<p> <code>TRUE</code> to include all comment attachments for pull requests.</p>"""

crawl_issue instance-attribute

crawl_issue: Boolean

TRUE to index all issues within a repository.

crawl_issue_comment instance-attribute

crawl_issue_comment: Boolean

TRUE to index all comments on issues.

crawl_issue_comment_attachment instance-attribute

crawl_issue_comment_attachment: Boolean

TRUE to include all comment attachments for issues.

crawl_pull_request instance-attribute

crawl_pull_request: Boolean

TRUE to index all pull requests within a repository.

crawl_pull_request_comment instance-attribute

crawl_pull_request_comment: Boolean

TRUE to index all comments on pull requests.

crawl_pull_request_comment_attachment instance-attribute

crawl_pull_request_comment_attachment: Boolean

TRUE to include all comment attachments for pull requests.

crawl_repository_documents instance-attribute

crawl_repository_documents: Boolean

TRUE to index all files with a repository.