AppIntegrationsConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.qconnect.model.AppIntegrationsConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AppIntegrationsConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Configuration information for Amazon AppIntegrations to automatically ingest content.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AppIntegrationsConfiguration()

Constructors
Constructor and Description
`AppIntegrationsConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AppIntegrationsConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAppIntegrationArn()` The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
`List<String>`	`getObjectFields()` The fields from the source that are made available to your agents in Amazon Q in Connect.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAppIntegrationArn(String appIntegrationArn)` The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
`void`	`setObjectFields(Collection<String> objectFields)` The fields from the source that are made available to your agents in Amazon Q in Connect.
`String`	`toString()` Returns a string representation of this object.
`AppIntegrationsConfiguration`	`withAppIntegrationArn(String appIntegrationArn)` The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
`AppIntegrationsConfiguration`	`withObjectFields(Collection<String> objectFields)` The fields from the source that are made available to your agents in Amazon Q in Connect.
`AppIntegrationsConfiguration`	`withObjectFields(String... objectFields)` The fields from the source that are made available to your agents in Amazon Q in Connect.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AppIntegrationsConfiguration
```
public AppIntegrationsConfiguration()
```
- Method Detail
  - setAppIntegrationArn
```
public void setAppIntegrationArn(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.
  - getAppIntegrationArn
```
public String getAppIntegrationArn()
```
    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:
    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.
  - withAppIntegrationArn
```
public AppIntegrationsConfiguration withAppIntegrationArn(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.
  - getObjectFields
```
public List<String> getObjectFields()
```
    The fields from the source that are made available to your agents in Amazon Q in Connect. 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:
    The fields from the source that are made available to your agents in Amazon Q in Connect. 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.
  - setObjectFields
```
public void setObjectFields(Collection<String> objectFields)
```
    The fields from the source that are made available to your agents in Amazon Q in Connect. 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 Amazon Q in Connect. 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.
  - withObjectFields
```
public AppIntegrationsConfiguration withObjectFields(String... objectFields)
```
    The fields from the source that are made available to your agents in Amazon Q in Connect. 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setObjectFields(java.util.Collection) or withObjectFields(java.util.Collection) if you want to override the existing values.
    Parameters:
    objectFields - The fields from the source that are made available to your agents in Amazon Q in Connect. 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.
  - withObjectFields
```
public AppIntegrationsConfiguration withObjectFields(Collection<String> objectFields)
```
    The fields from the source that are made available to your agents in Amazon Q in Connect. 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 Amazon Q in Connect. 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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AppIntegrationsConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class AppIntegrationsConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AppIntegrationsConfiguration

Method Detail

setAppIntegrationArn

getAppIntegrationArn

withAppIntegrationArn

getObjectFields

setObjectFields

withObjectFields

withObjectFields

toString

equals

hashCode

clone

marshall