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

Class SalesforceStandardObjectConfiguration

java.lang.Object

software.amazon.awssdk.services.kendra.model.SalesforceStandardObjectConfiguration

All Implemented Interfaces:

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

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

Provides the configuration information for indexing a single standard object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SalesforceStandardObjectConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static SalesforceStandardObjectConfiguration.Builder	builder()
String	documentDataFieldName()	The name of the field in the standard object table that contains the document contents.
String	documentTitleFieldName()	The name of the field in the standard object table that contains the document title.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<DataSourceToIndexFieldMapping>	fieldMappings()	Maps attributes or field names of the standard object to Amazon Kendra index field names.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFieldMappings()	For responses, this returns true if the service returned a value for the FieldMappings property.
int	hashCode()
SalesforceStandardObjectName	name()	The name of the standard object.
String	nameAsString()	The name of the standard object.
List<SdkField<?>>	sdkFields()
static Class<? extends SalesforceStandardObjectConfiguration.Builder>	serializableBuilderClass()
SalesforceStandardObjectConfiguration.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

name

public final SalesforceStandardObjectName name()

The name of the standard object.

If the service returns an enum value that is not available in the current SDK version, name will return SalesforceStandardObjectName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

Returns:

The name of the standard object.

See Also:

SalesforceStandardObjectName

nameAsString

public final String nameAsString()

The name of the standard object.

If the service returns an enum value that is not available in the current SDK version, name will return SalesforceStandardObjectName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nameAsString().

Returns:

The name of the standard object.

See Also:

SalesforceStandardObjectName

documentDataFieldName

public final String documentDataFieldName()

The name of the field in the standard object table that contains the document contents.

Returns:

The name of the field in the standard object table that contains the document contents.

documentTitleFieldName

public final String documentTitleFieldName()

The name of the field in the standard object table that contains the document title.

Returns:

The name of the field in the standard object table that contains the document title.

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

fieldMappings

public final List<DataSourceToIndexFieldMapping> fieldMappings()

Maps attributes or field names of the standard object to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

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 attributes or field names of the standard object to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

toBuilder

public SalesforceStandardObjectConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SalesforceStandardObjectConfiguration.Builder,SalesforceStandardObjectConfiguration>

builder

public static SalesforceStandardObjectConfiguration.Builder builder()

serializableBuilderClass

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