Package software.amazon.awssdk.services.kendra.model

Class SalesforceKnowledgeArticleConfiguration

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:

  • Method Details

    • 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()
      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 interface ToCopyableBuilder<SalesforceKnowledgeArticleConfiguration.Builder,SalesforceKnowledgeArticleConfiguration>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.