java.lang.Object
- software.amazon.awssdk.services.kendra.model.SalesforceKnowledgeArticleConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SalesforceKnowledgeArticleConfiguration.Builder,SalesforceKnowledgeArticleConfiguration>
```
@Generated("software.amazon.awssdk:codegen")
public final class SalesforceKnowledgeArticleConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SalesforceKnowledgeArticleConfiguration.Builder,SalesforceKnowledgeArticleConfiguration>
```
Provides the configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SalesforceKnowledgeArticleConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SalesforceKnowledgeArticleConfiguration.Builder`	`builder()`
`List<SalesforceCustomKnowledgeArticleTypeConfiguration>`	`customKnowledgeArticleTypeConfigurations()`	Configuration information for custom Salesforce knowledge articles.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCustomKnowledgeArticleTypeConfigurations()`	For responses, this returns true if the service returned a value for the CustomKnowledgeArticleTypeConfigurations property.
`int`	`hashCode()`
`boolean`	`hasIncludedStates()`	For responses, this returns true if the service returned a value for the IncludedStates property.
`List<SalesforceKnowledgeArticleState>`	`includedStates()`	Specifies the document states that should be included when Amazon Kendra indexes knowledge articles.
`List<String>`	`includedStatesAsStrings()`	Specifies the document states that should be included when Amazon Kendra indexes knowledge articles.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SalesforceKnowledgeArticleConfiguration.Builder>`	`serializableBuilderClass()`
`SalesforceStandardKnowledgeArticleTypeConfiguration`	`standardKnowledgeArticleTypeConfiguration()`	Configuration information for standard Salesforce knowledge articles.
`SalesforceKnowledgeArticleConfiguration.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
  - includedStates
```
public final List<SalesforceKnowledgeArticleState> includedStates()
```
    Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
    
    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 hasIncludedStates() method.
    
    Returns:
    
    Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
  - hasIncludedStates
```
public final boolean hasIncludedStates()
```
    For responses, this returns true if the service returned a value for the IncludedStates 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.
  - includedStatesAsStrings
```
public final List<String> includedStatesAsStrings()
```
    Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
    
    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 hasIncludedStates() method.
    
    Returns:
    
    Specifies the document states that should be included when Amazon Kendra indexes knowledge articles. You must specify at least one state.
  - standardKnowledgeArticleTypeConfiguration
```
public final SalesforceStandardKnowledgeArticleTypeConfiguration standardKnowledgeArticleTypeConfiguration()
```
    Configuration information for standard Salesforce knowledge articles.
    
    Returns:
    
    Configuration information for standard Salesforce knowledge articles.
  - hasCustomKnowledgeArticleTypeConfigurations
```
public final boolean hasCustomKnowledgeArticleTypeConfigurations()
```
    For responses, this returns true if the service returned a value for the CustomKnowledgeArticleTypeConfigurations 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.
  - customKnowledgeArticleTypeConfigurations
```
public final List<SalesforceCustomKnowledgeArticleTypeConfiguration> customKnowledgeArticleTypeConfigurations()
```
    Configuration information for custom Salesforce knowledge articles.
    
    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 hasCustomKnowledgeArticleTypeConfigurations() method.
    
    Returns:
    
    Configuration information for custom Salesforce knowledge articles.
  - toBuilder
```
public SalesforceKnowledgeArticleConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SalesforceKnowledgeArticleConfiguration.Builder,SalesforceKnowledgeArticleConfiguration>
  - builder
```
public static SalesforceKnowledgeArticleConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SalesforceKnowledgeArticleConfiguration.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

Class SalesforceKnowledgeArticleConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

includedStates

hasIncludedStates

includedStatesAsStrings

standardKnowledgeArticleTypeConfiguration

hasCustomKnowledgeArticleTypeConfigurations

customKnowledgeArticleTypeConfigurations

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields