Interface AppIntegrationsConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AppIntegrationsConfiguration.Builder,AppIntegrationsConfiguration>, SdkBuilder<AppIntegrationsConfiguration.Builder,AppIntegrationsConfiguration>, SdkPojo
Enclosing class:
AppIntegrationsConfiguration

public static interface AppIntegrationsConfiguration.Builder extends SdkPojo, CopyableBuilder<AppIntegrationsConfiguration.Builder,AppIntegrationsConfiguration>
  • Method Details

    • appIntegrationArn

      AppIntegrationsConfiguration.Builder appIntegrationArn(String appIntegrationArn)

      The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

      • For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields.

      • For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields.

      • For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields.

      • For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt.

      • For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name.

        The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.

      Parameters:
      appIntegrationArn - The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.

      • For Salesforce, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted as source fields.

      • For ServiceNow, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least number, short_description, sys_mod_count, workflow_state, and active as source fields.

      • For Zendesk, your AppIntegrations DataIntegration must have an ObjectConfiguration if objectFields is not provided, including at least id, title, updated_at, and draft as source fields.

      • For SharePoint, your AppIntegrations DataIntegration must have a FileConfiguration, including only file extensions that are among docx, pdf, html, htm, and txt.

      • For Amazon S3, the ObjectConfiguration and FileConfiguration of your AppIntegrations DataIntegration must be null. The SourceURI of your DataIntegration must use the following format: s3://your_s3_bucket_name.

        The bucket policy of the corresponding S3 bucket must allow the Amazon Web Services principal app-integrations.amazonaws.com to perform s3:ListBucket, s3:GetObject, and s3:GetBucketLocation against the bucket.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • objectFields

      The fields from the source that are made available to your agents in Wisdom. Optional if ObjectConfiguration is included in the provided DataIntegration.

      • For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.

      • For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

      • For Zendesk, you must include at least id, title, updated_at, and draft.

      Make sure to include additional fields. These fields are indexed and used to source recommendations.

      Parameters:
      objectFields - The fields from the source that are made available to your agents in Wisdom. Optional if ObjectConfiguration is included in the provided DataIntegration.

      • For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted .

      • For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

      • For Zendesk, you must include at least id, title, updated_at, and draft.

      Make sure to include additional fields. These fields are indexed and used to source recommendations.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • objectFields

      AppIntegrationsConfiguration.Builder objectFields(String... objectFields)

      The fields from the source that are made available to your agents in Wisdom. Optional if ObjectConfiguration is included in the provided DataIntegration.

      • For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted.

      • For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

      • For Zendesk, you must include at least id, title, updated_at, and draft.

      Make sure to include additional fields. These fields are indexed and used to source recommendations.

      Parameters:
      objectFields - The fields from the source that are made available to your agents in Wisdom. Optional if ObjectConfiguration is included in the provided DataIntegration.

      • For Salesforce, you must include at least Id, ArticleNumber, VersionNumber, Title, PublishStatus, and IsDeleted .

      • For ServiceNow, you must include at least number, short_description, sys_mod_count, workflow_state, and active.

      • For Zendesk, you must include at least id, title, updated_at, and draft.

      Make sure to include additional fields. These fields are indexed and used to source recommendations.

      Returns:
      Returns a reference to this object so that method calls can be chained together.