Class SalesforceChatterFeedConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The name of the column in the Salesforce FeedItem table that contains the content to index.final String
The name of the column in the Salesforce FeedItem table that contains the title of the document.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the FieldMappings property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the IncludeFilterTypes property.Filters the documents in the feed based on status of the user.Filters the documents in the feed based on status of the user.static Class
<? extends SalesforceChatterFeedConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
documentDataFieldName
The name of the column in the Salesforce FeedItem table that contains the content to index. Typically this is the
Body
column.- Returns:
- The name of the column in the Salesforce FeedItem table that contains the content to index. Typically
this is the
Body
column.
-
documentTitleFieldName
The name of the column in the Salesforce FeedItem table that contains the title of the document. This is typically the
Title
column.- Returns:
- The name of the column in the Salesforce FeedItem table that contains the title of the document. This is
typically the
Title
column.
-
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
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
Filters the documents in the feed based on status of the user. When you specify
ACTIVE_USERS
only documents from users who have an active account are indexed. When you specifySTANDARD_USER
only 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_USERS
only documents from users who have an active account are indexed. When you specifySTANDARD_USER
only 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
Filters the documents in the feed based on status of the user. When you specify
ACTIVE_USERS
only documents from users who have an active account are indexed. When you specifySTANDARD_USER
only 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_USERS
only documents from users who have an active account are indexed. When you specifySTANDARD_USER
only documents for Salesforce standard users are documented. You can specify both.
-
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 interfaceToCopyableBuilder<SalesforceChatterFeedConfiguration.Builder,
SalesforceChatterFeedConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends SalesforceChatterFeedConfiguration.Builder> serializableBuilderClass() -
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-