io.github.cdklabs.cdk.appflow.SalesforceSource Maven / Gradle / Ivy

Go to download
package io.github.cdklabs.cdk.appflow;

/**
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.103.1 (build bef2dea)", date = "2024-10-11T10:39:08.287Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = io.github.cdklabs.cdk.appflow.$Module.class, fqn = "@cdklabs/cdk-appflow.SalesforceSource")
public class SalesforceSource extends software.amazon.jsii.JsiiObject implements io.github.cdklabs.cdk.appflow.ISource {

    protected SalesforceSource(final software.amazon.jsii.JsiiObjectRef objRef) {
        super(objRef);
    }

    protected SalesforceSource(final software.amazon.jsii.JsiiObject.InitializationMode initializationMode) {
        super(initializationMode);
    }

    /**
     * @param props This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public SalesforceSource(final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdk.appflow.SalesforceSourceProps props) {
        super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
        software.amazon.jsii.JsiiEngine.getInstance().createNewObject(this, new Object[] { java.util.Objects.requireNonNull(props, "props is required") });
    }

    /**
     * @param flow This parameter is required.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    @Override
    public @org.jetbrains.annotations.NotNull software.amazon.awscdk.services.appflow.CfnFlow.SourceFlowConfigProperty bind(final @org.jetbrains.annotations.NotNull io.github.cdklabs.cdk.appflow.IFlow flow) {
        return software.amazon.jsii.Kernel.call(this, "bind", software.amazon.jsii.NativeType.forClass(software.amazon.awscdk.services.appflow.CfnFlow.SourceFlowConfigProperty.class), new Object[] { java.util.Objects.requireNonNull(flow, "flow is required") });
    }

    /**
     * (experimental) The AppFlow type of the connector that this source is implemented for.
     */
    @Override
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public @org.jetbrains.annotations.NotNull io.github.cdklabs.cdk.appflow.ConnectorType getConnectorType() {
        return software.amazon.jsii.Kernel.get(this, "connectorType", software.amazon.jsii.NativeType.forClass(io.github.cdklabs.cdk.appflow.ConnectorType.class));
    }

    /**
     * (experimental) A fluent builder for {@link io.github.cdklabs.cdk.appflow.SalesforceSource}.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    public static final class Builder implements software.amazon.jsii.Builder {
        /**
         * @return a new instance of {@link Builder}.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public static Builder create() {
            return new Builder();
        }

        private final io.github.cdklabs.cdk.appflow.SalesforceSourceProps.Builder props;

        private Builder() {
            this.props = new io.github.cdklabs.cdk.appflow.SalesforceSourceProps.Builder();
        }

        /**
         * @return {@code this}
         * @param object This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public Builder object(final java.lang.String object) {
            this.props.object(object);
            return this;
        }

        /**
         * @return {@code this}
         * @param profile This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public Builder profile(final io.github.cdklabs.cdk.appflow.SalesforceConnectorProfile profile) {
            this.props.profile(profile);
            return this;
        }

        /**
         * @return {@code this}
         * @param apiVersion This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public Builder apiVersion(final java.lang.String apiVersion) {
            this.props.apiVersion(apiVersion);
            return this;
        }

        /**
         * (experimental) Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce.
         * 
         * @return {@code this}
         * @param dataTransferApi Specifies which Salesforce API is used by Amazon AppFlow when your flow transfers data from Salesforce. This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public Builder dataTransferApi(final io.github.cdklabs.cdk.appflow.SalesforceDataTransferApi dataTransferApi) {
            this.props.dataTransferApi(dataTransferApi);
            return this;
        }

        /**
         * @return {@code this}
         * @param enableDynamicFieldUpdate This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public Builder enableDynamicFieldUpdate(final java.lang.Boolean enableDynamicFieldUpdate) {
            this.props.enableDynamicFieldUpdate(enableDynamicFieldUpdate);
            return this;
        }

        /**
         * @return {@code this}
         * @param includeDeletedRecords This parameter is required.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        public Builder includeDeletedRecords(final java.lang.Boolean includeDeletedRecords) {
            this.props.includeDeletedRecords(includeDeletedRecords);
            return this;
        }

        /**
         * @return a newly built instance of {@link io.github.cdklabs.cdk.appflow.SalesforceSource}.
         */
        @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
        @Override
        public io.github.cdklabs.cdk.appflow.SalesforceSource build() {
            return new io.github.cdklabs.cdk.appflow.SalesforceSource(
                this.props.build()
            );
        }
    }
}