software.amazon.awssdk.services.wisdom.model

Class AppIntegrationsConfiguration

java.lang.Object

software.amazon.awssdk.services.wisdom.model.AppIntegrationsConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AppIntegrationsConfiguration.Builder,AppIntegrationsConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class AppIntegrationsConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AppIntegrationsConfiguration.Builder,AppIntegrationsConfiguration>

Configuration information for Amazon AppIntegrations to automatically ingest content.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AppIntegrationsConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
String	appIntegrationArn() The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
static AppIntegrationsConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasObjectFields() For responses, this returns true if the service returned a value for the ObjectFields property.
List<String>	objectFields() The fields from the source that are made available to your agents in Wisdom.
List<SdkField<?>>	sdkFields()
static Class<? extends AppIntegrationsConfiguration.Builder>	serializableBuilderClass()
AppIntegrationsConfiguration.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

appIntegrationArn

public final 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.

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.

hasObjectFields

public final boolean hasObjectFields()

For responses, this returns true if the service returned a value for the ObjectFields property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

objectFields

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasObjectFields() method.

Returns:

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.

toBuilder

public AppIntegrationsConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AppIntegrationsConfiguration.Builder,AppIntegrationsConfiguration>

builder

public static AppIntegrationsConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends AppIntegrationsConfiguration.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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