Class SalesforceChatterFeedConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.kendra.model.SalesforceChatterFeedConfiguration
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<SalesforceChatterFeedConfiguration.Builder,SalesforceChatterFeedConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class SalesforceChatterFeedConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SalesforceChatterFeedConfiguration.Builder,SalesforceChatterFeedConfiguration>
The configuration information for syncing a Salesforce chatter feed. The contents of the object comes from the Salesforce FeedItem table.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSalesforceChatterFeedConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SalesforceChatterFeedConfiguration.Builderbuilder()StringdocumentDataFieldName()The name of the column in the Salesforce FeedItem table that contains the content to index.StringdocumentTitleFieldName()The name of the column in the Salesforce FeedItem table that contains the title of the document.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<DataSourceToIndexFieldMapping>fieldMappings()Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasFieldMappings()For responses, this returns true if the service returned a value for the FieldMappings property.inthashCode()booleanhasIncludeFilterTypes()For responses, this returns true if the service returned a value for the IncludeFilterTypes property.List<SalesforceChatterFeedIncludeFilterType>includeFilterTypes()Filters the documents in the feed based on status of the user.List<String>includeFilterTypesAsStrings()Filters the documents in the feed based on status of the user.List<SdkField<?>>sdkFields()static Class<? extends SalesforceChatterFeedConfiguration.Builder>serializableBuilderClass()SalesforceChatterFeedConfiguration.BuildertoBuilder()StringtoString()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
-
documentDataFieldName
public final String documentDataFieldName()
The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the
Bodycolumn.- Returns:
- The name of the column in the Salesforce FeedItem table that contains the content to index. Typically
this is the
Bodycolumn.
-
documentTitleFieldName
public final String documentTitleFieldName()
The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the
Titlecolumn.- Returns:
- The name of the column in the Salesforce FeedItem table that contains the title of the document. This is
typically the
Titlecolumn.
-
hasFieldMappings
public final boolean hasFieldMappings()
For responses, this returns true if the service returned a value for the FieldMappings property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
fieldMappings
public final List<DataSourceToIndexFieldMapping> fieldMappings()
Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
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
hasFieldMappings()method.- Returns:
- Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.
-
includeFilterTypes
public final List<SalesforceChatterFeedIncludeFilterType> includeFilterTypes()
Filters the documents in the feed based on status of the user. When you specify
ACTIVE_USERSonly documents from users who have an active account are indexed. When you specifySTANDARD_USERonly documents for Salesforce standard users are documented. You can specify both.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
hasIncludeFilterTypes()method.- Returns:
- Filters the documents in the feed based on status of the user. When you specify
ACTIVE_USERSonly documents from users who have an active account are indexed. When you specifySTANDARD_USERonly documents for Salesforce standard users are documented. You can specify both.
-
hasIncludeFilterTypes
public final boolean hasIncludeFilterTypes()
For responses, this returns true if the service returned a value for the IncludeFilterTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
includeFilterTypesAsStrings
public final List<String> includeFilterTypesAsStrings()
Filters the documents in the feed based on status of the user. When you specify
ACTIVE_USERSonly documents from users who have an active account are indexed. When you specifySTANDARD_USERonly documents for Salesforce standard users are documented. You can specify both.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
hasIncludeFilterTypes()method.- Returns:
- Filters the documents in the feed based on status of the user. When you specify
ACTIVE_USERSonly documents from users who have an active account are indexed. When you specifySTANDARD_USERonly documents for Salesforce standard users are documented. You can specify both.
-
toBuilder
public SalesforceChatterFeedConfiguration.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SalesforceChatterFeedConfiguration.Builder,SalesforceChatterFeedConfiguration>
-
builder
public static SalesforceChatterFeedConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends SalesforceChatterFeedConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-