Package software.amazon.awssdk.services.kendra.model

Class GitHubDocumentCrawlProperties

java.lang.Object
software.amazon.awssdk.services.kendra.model.GitHubDocumentCrawlProperties
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<GitHubDocumentCrawlProperties.Builder,GitHubDocumentCrawlProperties>
@Generated("software.amazon.awssdk:codegen") public final class GitHubDocumentCrawlProperties extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GitHubDocumentCrawlProperties.Builder,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 Also:

  • Method Details

    • crawlRepositoryDocuments

      public final Boolean crawlRepositoryDocuments()

      TRUE to index all files with a repository.

      Returns:
      TRUE to index all files with a repository.

    • crawlIssue

      public final Boolean crawlIssue()

      TRUE to index all issues within a repository.

      Returns:
      TRUE to index all issues within a repository.

    • crawlIssueComment

      public final Boolean crawlIssueComment()

      TRUE to index all comments on issues.

      Returns:
      TRUE to index all comments on issues.

    • crawlIssueCommentAttachment

      public final Boolean crawlIssueCommentAttachment()

      TRUE to include all comment attachments for issues.

      Returns:
      TRUE to include all comment attachments for issues.

    • crawlPullRequest

      public final Boolean crawlPullRequest()

      TRUE to index all pull requests within a repository.

      Returns:
      TRUE to index all pull requests within a repository.

    • crawlPullRequestComment

      public final Boolean crawlPullRequestComment()

      TRUE to index all comments on pull requests.

      Returns:
      TRUE to index all comments on pull requests.

    • crawlPullRequestCommentAttachment

      public final Boolean crawlPullRequestCommentAttachment()

      TRUE to include all comment attachments for pull requests.

      Returns:
      TRUE to include all comment attachments for pull requests.

    • toBuilder

      public GitHubDocumentCrawlProperties.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GitHubDocumentCrawlProperties.Builder,GitHubDocumentCrawlProperties>
      Returns:
      a builder for type T

    • builder

      public static GitHubDocumentCrawlProperties.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GitHubDocumentCrawlProperties.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.