/* * Copyright 2018-2023 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.appflow.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* The properties that are applied when Salesforce is being used as a source. *

* * @see AWS * API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class SalesforceSourceProperties implements Serializable, Cloneable, StructuredPojo { /** *

* The object specified in the Salesforce flow source. *

*/ private String object; /** *

* The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a * flow. *

*/ private Boolean enableDynamicFieldUpdate; /** *

* Indicates whether Amazon AppFlow includes deleted files in the flow run. *

*/ private Boolean includeDeletedRecords; /** *

* Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce. *

*
*
AUTOMATIC
*
*

* The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from * Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your * flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0. *

*

* Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be * aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow * runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the * next day to transfer 1,100,000 records. For each of these flow runs, the respective Salesforce API formats the * data differently. Some of the differences include how dates are formatted and null values are represented. Also, * Bulk API 2.0 doesn't transfer Salesforce compound fields. *

*

* By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff * is inconsistent formatting in the output. *

*
*
BULKV2
*
*

* Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for * large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize * performance only for large data transfers. *

*

* Note that Bulk API 2.0 does not transfer Salesforce compound fields. *

*
*
REST_SYNC
*
*

* Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes * consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. * In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error. *

*
*
*/ private String dataTransferApi; /** *

* The object specified in the Salesforce flow source. *

* * @param object * The object specified in the Salesforce flow source. */ public void setObject(String object) { this.object = object; } /** *

* The object specified in the Salesforce flow source. *

* * @return The object specified in the Salesforce flow source. */ public String getObject() { return this.object; } /** *

* The object specified in the Salesforce flow source. *

* * @param object * The object specified in the Salesforce flow source. * @return Returns a reference to this object so that method calls can be chained together. */ public SalesforceSourceProperties withObject(String object) { setObject(object); return this; } /** *

* The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a * flow. *

* * @param enableDynamicFieldUpdate * The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while * running a flow. */ public void setEnableDynamicFieldUpdate(Boolean enableDynamicFieldUpdate) { this.enableDynamicFieldUpdate = enableDynamicFieldUpdate; } /** *

* The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a * flow. *

* * @return The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while * running a flow. */ public Boolean getEnableDynamicFieldUpdate() { return this.enableDynamicFieldUpdate; } /** *

* The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a * flow. *

* * @param enableDynamicFieldUpdate * The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while * running a flow. * @return Returns a reference to this object so that method calls can be chained together. */ public SalesforceSourceProperties withEnableDynamicFieldUpdate(Boolean enableDynamicFieldUpdate) { setEnableDynamicFieldUpdate(enableDynamicFieldUpdate); return this; } /** *

* The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a * flow. *

* * @return The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while * running a flow. */ public Boolean isEnableDynamicFieldUpdate() { return this.enableDynamicFieldUpdate; } /** *

* Indicates whether Amazon AppFlow includes deleted files in the flow run. *

* * @param includeDeletedRecords * Indicates whether Amazon AppFlow includes deleted files in the flow run. */ public void setIncludeDeletedRecords(Boolean includeDeletedRecords) { this.includeDeletedRecords = includeDeletedRecords; } /** *

* Indicates whether Amazon AppFlow includes deleted files in the flow run. *

* * @return Indicates whether Amazon AppFlow includes deleted files in the flow run. */ public Boolean getIncludeDeletedRecords() { return this.includeDeletedRecords; } /** *

* Indicates whether Amazon AppFlow includes deleted files in the flow run. *

* * @param includeDeletedRecords * Indicates whether Amazon AppFlow includes deleted files in the flow run. * @return Returns a reference to this object so that method calls can be chained together. */ public SalesforceSourceProperties withIncludeDeletedRecords(Boolean includeDeletedRecords) { setIncludeDeletedRecords(includeDeletedRecords); return this; } /** *

* Indicates whether Amazon AppFlow includes deleted files in the flow run. *

* * @return Indicates whether Amazon AppFlow includes deleted files in the flow run. */ public Boolean isIncludeDeletedRecords() { return this.includeDeletedRecords; } /** *

* Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce. *

*
*
AUTOMATIC
*
*

* The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from * Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your * flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0. *

*

* Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be * aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow * runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the * next day to transfer 1,100,000 records. For each of these flow runs, the respective Salesforce API formats the * data differently. Some of the differences include how dates are formatted and null values are represented. Also, * Bulk API 2.0 doesn't transfer Salesforce compound fields. *

*

* By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff * is inconsistent formatting in the output. *

*
*
BULKV2
*
*

* Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for * large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize * performance only for large data transfers. *

*

* Note that Bulk API 2.0 does not transfer Salesforce compound fields. *

*
*
REST_SYNC
*
*

* Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes * consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. * In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error. *

*
*
* * @param dataTransferApi * Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from * Salesforce.

*
*
AUTOMATIC
*
*

* The default. Amazon AppFlow selects which API to use based on the number of records that your flow * transfers from Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses * Salesforce REST API. If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk * API 2.0. *

*

* Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API * automatically, be aware that, for recurring flows, the data output might vary from one flow run to the * next. For example, if a flow runs daily, it might use REST API on one day to transfer 900,000 records, and * it might use Bulk API 2.0 on the next day to transfer 1,100,000 records. For each of these flow runs, the * respective Salesforce API formats the data differently. Some of the differences include how dates are * formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields. *

*

* By choosing this option, you optimize flow performance for both small and large data transfers, but the * tradeoff is inconsistent formatting in the output. *

*
*
BULKV2
*
*

* Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's * optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent * output, but you optimize performance only for large data transfers. *

*

* Note that Bulk API 2.0 does not transfer Salesforce compound fields. *

*
*
REST_SYNC
*
*

* Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes * consistent output, but you decrease performance for large data transfers that are better suited for Bulk * API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a * timed out error. *

*
* @see SalesforceDataTransferApi */ public void setDataTransferApi(String dataTransferApi) { this.dataTransferApi = dataTransferApi; } /** *

* Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce. *

*
*
AUTOMATIC
*
*

* The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from * Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your * flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0. *

*

* Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be * aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow * runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the * next day to transfer 1,100,000 records. For each of these flow runs, the respective Salesforce API formats the * data differently. Some of the differences include how dates are formatted and null values are represented. Also, * Bulk API 2.0 doesn't transfer Salesforce compound fields. *

*

* By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff * is inconsistent formatting in the output. *

*
*
BULKV2
*
*

* Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for * large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize * performance only for large data transfers. *

*

* Note that Bulk API 2.0 does not transfer Salesforce compound fields. *

*
*
REST_SYNC
*
*

* Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes * consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. * In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error. *

*
*
* * @return Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from * Salesforce.

*
*
AUTOMATIC
*
*

* The default. Amazon AppFlow selects which API to use based on the number of records that your flow * transfers from Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses * Salesforce REST API. If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce * Bulk API 2.0. *

*

* Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API * automatically, be aware that, for recurring flows, the data output might vary from one flow run to the * next. For example, if a flow runs daily, it might use REST API on one day to transfer 900,000 records, * and it might use Bulk API 2.0 on the next day to transfer 1,100,000 records. For each of these flow runs, * the respective Salesforce API formats the data differently. Some of the differences include how dates are * formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound * fields. *

*

* By choosing this option, you optimize flow performance for both small and large data transfers, but the * tradeoff is inconsistent formatting in the output. *

*
*
BULKV2
*
*

* Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's * optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent * output, but you optimize performance only for large data transfers. *

*

* Note that Bulk API 2.0 does not transfer Salesforce compound fields. *

*
*
REST_SYNC
*
*

* Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes * consistent output, but you decrease performance for large data transfers that are better suited for Bulk * API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a * timed out error. *

*
* @see SalesforceDataTransferApi */ public String getDataTransferApi() { return this.dataTransferApi; } /** *

* Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce. *

*
*
AUTOMATIC
*
*

* The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from * Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your * flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0. *

*

* Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be * aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow * runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the * next day to transfer 1,100,000 records. For each of these flow runs, the respective Salesforce API formats the * data differently. Some of the differences include how dates are formatted and null values are represented. Also, * Bulk API 2.0 doesn't transfer Salesforce compound fields. *

*

* By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff * is inconsistent formatting in the output. *

*
*
BULKV2
*
*

* Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for * large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize * performance only for large data transfers. *

*

* Note that Bulk API 2.0 does not transfer Salesforce compound fields. *

*
*
REST_SYNC
*
*

* Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes * consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. * In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error. *

*
*
* * @param dataTransferApi * Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from * Salesforce.

*
*
AUTOMATIC
*
*

* The default. Amazon AppFlow selects which API to use based on the number of records that your flow * transfers from Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses * Salesforce REST API. If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk * API 2.0. *

*

* Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API * automatically, be aware that, for recurring flows, the data output might vary from one flow run to the * next. For example, if a flow runs daily, it might use REST API on one day to transfer 900,000 records, and * it might use Bulk API 2.0 on the next day to transfer 1,100,000 records. For each of these flow runs, the * respective Salesforce API formats the data differently. Some of the differences include how dates are * formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields. *

*

* By choosing this option, you optimize flow performance for both small and large data transfers, but the * tradeoff is inconsistent formatting in the output. *

*
*
BULKV2
*
*

* Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's * optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent * output, but you optimize performance only for large data transfers. *

*

* Note that Bulk API 2.0 does not transfer Salesforce compound fields. *

*
*
REST_SYNC
*
*

* Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes * consistent output, but you decrease performance for large data transfers that are better suited for Bulk * API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a * timed out error. *

*
* @return Returns a reference to this object so that method calls can be chained together. * @see SalesforceDataTransferApi */ public SalesforceSourceProperties withDataTransferApi(String dataTransferApi) { setDataTransferApi(dataTransferApi); return this; } /** *

* Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce. *

*
*
AUTOMATIC
*
*

* The default. Amazon AppFlow selects which API to use based on the number of records that your flow transfers from * Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses Salesforce REST API. If your * flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk API 2.0. *

*

* Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API automatically, be * aware that, for recurring flows, the data output might vary from one flow run to the next. For example, if a flow * runs daily, it might use REST API on one day to transfer 900,000 records, and it might use Bulk API 2.0 on the * next day to transfer 1,100,000 records. For each of these flow runs, the respective Salesforce API formats the * data differently. Some of the differences include how dates are formatted and null values are represented. Also, * Bulk API 2.0 doesn't transfer Salesforce compound fields. *

*

* By choosing this option, you optimize flow performance for both small and large data transfers, but the tradeoff * is inconsistent formatting in the output. *

*
*
BULKV2
*
*

* Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's optimal for * large sets of data. By choosing this option, you ensure that your flow writes consistent output, but you optimize * performance only for large data transfers. *

*

* Note that Bulk API 2.0 does not transfer Salesforce compound fields. *

*
*
REST_SYNC
*
*

* Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes * consistent output, but you decrease performance for large data transfers that are better suited for Bulk API 2.0. * In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a timed out error. *

*
*
* * @param dataTransferApi * Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from * Salesforce.

*
*
AUTOMATIC
*
*

* The default. Amazon AppFlow selects which API to use based on the number of records that your flow * transfers from Salesforce. If your flow transfers fewer than 1,000,000 records, Amazon AppFlow uses * Salesforce REST API. If your flow transfers 1,000,000 records or more, Amazon AppFlow uses Salesforce Bulk * API 2.0. *

*

* Each of these Salesforce APIs structures data differently. If Amazon AppFlow selects the API * automatically, be aware that, for recurring flows, the data output might vary from one flow run to the * next. For example, if a flow runs daily, it might use REST API on one day to transfer 900,000 records, and * it might use Bulk API 2.0 on the next day to transfer 1,100,000 records. For each of these flow runs, the * respective Salesforce API formats the data differently. Some of the differences include how dates are * formatted and null values are represented. Also, Bulk API 2.0 doesn't transfer Salesforce compound fields. *

*

* By choosing this option, you optimize flow performance for both small and large data transfers, but the * tradeoff is inconsistent formatting in the output. *

*
*
BULKV2
*
*

* Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs asynchronous data transfers, and it's * optimal for large sets of data. By choosing this option, you ensure that your flow writes consistent * output, but you optimize performance only for large data transfers. *

*

* Note that Bulk API 2.0 does not transfer Salesforce compound fields. *

*
*
REST_SYNC
*
*

* Amazon AppFlow uses only Salesforce REST API. By choosing this option, you ensure that your flow writes * consistent output, but you decrease performance for large data transfers that are better suited for Bulk * API 2.0. In some cases, if your flow attempts to transfer a vary large set of data, it might fail wituh a * timed out error. *

*
* @return Returns a reference to this object so that method calls can be chained together. * @see SalesforceDataTransferApi */ public SalesforceSourceProperties withDataTransferApi(SalesforceDataTransferApi dataTransferApi) { this.dataTransferApi = dataTransferApi.toString(); 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 (getObject() != null) sb.append("Object: ").append(getObject()).append(","); if (getEnableDynamicFieldUpdate() != null) sb.append("EnableDynamicFieldUpdate: ").append(getEnableDynamicFieldUpdate()).append(","); if (getIncludeDeletedRecords() != null) sb.append("IncludeDeletedRecords: ").append(getIncludeDeletedRecords()).append(","); if (getDataTransferApi() != null) sb.append("DataTransferApi: ").append(getDataTransferApi()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof SalesforceSourceProperties == false) return false; SalesforceSourceProperties other = (SalesforceSourceProperties) obj; if (other.getObject() == null ^ this.getObject() == null) return false; if (other.getObject() != null && other.getObject().equals(this.getObject()) == false) return false; if (other.getEnableDynamicFieldUpdate() == null ^ this.getEnableDynamicFieldUpdate() == null) return false; if (other.getEnableDynamicFieldUpdate() != null && other.getEnableDynamicFieldUpdate().equals(this.getEnableDynamicFieldUpdate()) == false) return false; if (other.getIncludeDeletedRecords() == null ^ this.getIncludeDeletedRecords() == null) return false; if (other.getIncludeDeletedRecords() != null && other.getIncludeDeletedRecords().equals(this.getIncludeDeletedRecords()) == false) return false; if (other.getDataTransferApi() == null ^ this.getDataTransferApi() == null) return false; if (other.getDataTransferApi() != null && other.getDataTransferApi().equals(this.getDataTransferApi()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getObject() == null) ? 0 : getObject().hashCode()); hashCode = prime * hashCode + ((getEnableDynamicFieldUpdate() == null) ? 0 : getEnableDynamicFieldUpdate().hashCode()); hashCode = prime * hashCode + ((getIncludeDeletedRecords() == null) ? 0 : getIncludeDeletedRecords().hashCode()); hashCode = prime * hashCode + ((getDataTransferApi() == null) ? 0 : getDataTransferApi().hashCode()); return hashCode; } @Override public SalesforceSourceProperties clone() { try { return (SalesforceSourceProperties) 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.appflow.model.transform.SalesforceSourcePropertiesMarshaller.getInstance().marshall(this, protocolMarshaller); } }