Class SalesforceStandardObjectConfiguration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SalesforceStandardObjectConfiguration.Builder,
SalesforceStandardObjectConfiguration>
Provides the configuration information for indexing a single standard object.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The name of the field in the standard object table that contains the document contents.final String
The name of the field in the standard object table that contains the document title.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.Maps attributes or field names of the standard object to Amazon Kendra index field names.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()
name()
The name of the standard object.final String
The name of the standard object.static Class
<? extends SalesforceStandardObjectConfiguration.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
-
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 returnSalesforceStandardObjectName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The name of the standard object.
- See Also:
-
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 returnSalesforceStandardObjectName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The name of the standard object.
- See Also:
-
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
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 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 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
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<SalesforceStandardObjectConfiguration.Builder,
SalesforceStandardObjectConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends SalesforceStandardObjectConfiguration.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
-