com.amazonaws.services.kendra.model.SalesforceStandardObjectConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kendra Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kendra.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Provides the configuration information for indexing a single standard object.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SalesforceStandardObjectConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the standard object.
*
*/
private String name;
/**
*
* The name of the field in the standard object table that contains the document contents.
*
*/
private String documentDataFieldName;
/**
*
* The name of the field in the standard object table that contains the document title.
*
*/
private String documentTitleFieldName;
/**
*
* 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.
*
*/
private java.util.List fieldMappings;
/**
*
* The name of the standard object.
*
*
* @param name
* The name of the standard object.
* @see SalesforceStandardObjectName
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the standard object.
*
*
* @return The name of the standard object.
* @see SalesforceStandardObjectName
*/
public String getName() {
return this.name;
}
/**
*
* The name of the standard object.
*
*
* @param name
* The name of the standard object.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SalesforceStandardObjectName
*/
public SalesforceStandardObjectConfiguration withName(String name) {
setName(name);
return this;
}
/**
*
* The name of the standard object.
*
*
* @param name
* The name of the standard object.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SalesforceStandardObjectName
*/
public SalesforceStandardObjectConfiguration withName(SalesforceStandardObjectName name) {
this.name = name.toString();
return this;
}
/**
*
* The name of the field in the standard object table that contains the document contents.
*
*
* @param documentDataFieldName
* The name of the field in the standard object table that contains the document contents.
*/
public void setDocumentDataFieldName(String documentDataFieldName) {
this.documentDataFieldName = documentDataFieldName;
}
/**
*
* The name of the field in the standard object table that contains the document contents.
*
*
* @return The name of the field in the standard object table that contains the document contents.
*/
public String getDocumentDataFieldName() {
return this.documentDataFieldName;
}
/**
*
* The name of the field in the standard object table that contains the document contents.
*
*
* @param documentDataFieldName
* The name of the field in the standard object table that contains the document contents.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SalesforceStandardObjectConfiguration withDocumentDataFieldName(String documentDataFieldName) {
setDocumentDataFieldName(documentDataFieldName);
return this;
}
/**
*
* The name of the field in the standard object table that contains the document title.
*
*
* @param documentTitleFieldName
* The name of the field in the standard object table that contains the document title.
*/
public void setDocumentTitleFieldName(String documentTitleFieldName) {
this.documentTitleFieldName = documentTitleFieldName;
}
/**
*
* The name of the field in the standard object table that contains the document title.
*
*
* @return The name of the field in the standard object table that contains the document title.
*/
public String getDocumentTitleFieldName() {
return this.documentTitleFieldName;
}
/**
*
* The name of the field in the standard object table that contains the document title.
*
*
* @param documentTitleFieldName
* The name of the field in the standard object table that contains the document title.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SalesforceStandardObjectConfiguration withDocumentTitleFieldName(String documentTitleFieldName) {
setDocumentTitleFieldName(documentTitleFieldName);
return this;
}
/**
*
* 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.
*
*
* @return 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.
*/
public java.util.List getFieldMappings() {
return 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.
*
*
* @param 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.
*/
public void setFieldMappings(java.util.Collection fieldMappings) {
if (fieldMappings == null) {
this.fieldMappings = null;
return;
}
this.fieldMappings = new java.util.ArrayList(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.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFieldMappings(java.util.Collection)} or {@link #withFieldMappings(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SalesforceStandardObjectConfiguration withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings) {
if (this.fieldMappings == null) {
setFieldMappings(new java.util.ArrayList(fieldMappings.length));
}
for (DataSourceToIndexFieldMapping ele : fieldMappings) {
this.fieldMappings.add(ele);
}
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SalesforceStandardObjectConfiguration withFieldMappings(java.util.Collection fieldMappings) {
setFieldMappings(fieldMappings);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getDocumentDataFieldName() != null)
sb.append("DocumentDataFieldName: ").append(getDocumentDataFieldName()).append(",");
if (getDocumentTitleFieldName() != null)
sb.append("DocumentTitleFieldName: ").append(getDocumentTitleFieldName()).append(",");
if (getFieldMappings() != null)
sb.append("FieldMappings: ").append(getFieldMappings());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SalesforceStandardObjectConfiguration == false)
return false;
SalesforceStandardObjectConfiguration other = (SalesforceStandardObjectConfiguration) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getDocumentDataFieldName() == null ^ this.getDocumentDataFieldName() == null)
return false;
if (other.getDocumentDataFieldName() != null && other.getDocumentDataFieldName().equals(this.getDocumentDataFieldName()) == false)
return false;
if (other.getDocumentTitleFieldName() == null ^ this.getDocumentTitleFieldName() == null)
return false;
if (other.getDocumentTitleFieldName() != null && other.getDocumentTitleFieldName().equals(this.getDocumentTitleFieldName()) == false)
return false;
if (other.getFieldMappings() == null ^ this.getFieldMappings() == null)
return false;
if (other.getFieldMappings() != null && other.getFieldMappings().equals(this.getFieldMappings()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDocumentDataFieldName() == null) ? 0 : getDocumentDataFieldName().hashCode());
hashCode = prime * hashCode + ((getDocumentTitleFieldName() == null) ? 0 : getDocumentTitleFieldName().hashCode());
hashCode = prime * hashCode + ((getFieldMappings() == null) ? 0 : getFieldMappings().hashCode());
return hashCode;
}
@Override
public SalesforceStandardObjectConfiguration clone() {
try {
return (SalesforceStandardObjectConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.kendra.model.transform.SalesforceStandardObjectConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}