DocumentsImportFromRequest.java

/**
 * This file was auto-generated by Fern from our API Definition.
 */
package com.cloudpdf.api.resources.documents.requests;

import com.cloudpdf.api.core.ObjectMappers;
import com.cloudpdf.api.resources.documents.types.DocumentsImportFromRequestDedupMode;
import com.cloudpdf.api.resources.documents.types.DocumentsImportFromRequestExpected;
import com.cloudpdf.api.resources.documents.types.DocumentsImportFromRequestMode;
import com.cloudpdf.api.resources.documents.types.DocumentsImportFromRequestSource;
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonAnySetter;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonSetter;
import com.fasterxml.jackson.annotation.Nulls;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import org.jetbrains.annotations.NotNull;

@JsonInclude(JsonInclude.Include.NON_ABSENT)
@JsonDeserialize(builder = DocumentsImportFromRequest.Builder.class)
public final class DocumentsImportFromRequest {
    private final DocumentsImportFromRequestSource source;

    private final Optional<DocumentsImportFromRequestExpected> expected;

    private final Optional<Map<String, Object>> metadata;

    private final Optional<String> idempotencyKey;

    private final Optional<DocumentsImportFromRequestDedupMode> dedupMode;

    private final Optional<String> docId;

    private final Optional<DocumentsImportFromRequestMode> mode;

    private final Map<String, Object> additionalProperties;

    private DocumentsImportFromRequest(
            DocumentsImportFromRequestSource source,
            Optional<DocumentsImportFromRequestExpected> expected,
            Optional<Map<String, Object>> metadata,
            Optional<String> idempotencyKey,
            Optional<DocumentsImportFromRequestDedupMode> dedupMode,
            Optional<String> docId,
            Optional<DocumentsImportFromRequestMode> mode,
            Map<String, Object> additionalProperties) {
        this.source = source;
        this.expected = expected;
        this.metadata = metadata;
        this.idempotencyKey = idempotencyKey;
        this.dedupMode = dedupMode;
        this.docId = docId;
        this.mode = mode;
        this.additionalProperties = additionalProperties;
    }

    /**
     * @return Where CloudPDF pulls the bytes from. The two shapes differ in WHO supplies the authority to read, not in which storage vendor holds the file.
     */
    @JsonProperty("source")
    public DocumentsImportFromRequestSource getSource() {
        return source;
    }

    /**
     * @return Integrity pins, enforced when present. When absent, the server-observed values become authoritative.
     */
    @JsonProperty("expected")
    public Optional<DocumentsImportFromRequestExpected> getExpected() {
        return expected;
    }

    @JsonProperty("metadata")
    public Optional<Map<String, Object>> getMetadata() {
        return metadata;
    }

    /**
     * @return Retrying with the same key resumes the same document rather than importing a second copy — including after a 502.
     */
    @JsonProperty("idempotencyKey")
    public Optional<String> getIdempotencyKey() {
        return idempotencyKey;
    }

    /**
     * @return always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.
     */
    @JsonProperty("dedupMode")
    public Optional<DocumentsImportFromRequestDedupMode> getDedupMode() {
        return dedupMode;
    }

    @JsonProperty("docId")
    public Optional<String> getDocId() {
        return docId;
    }

    /**
     * @return sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256.
     */
    @JsonProperty("mode")
    public Optional<DocumentsImportFromRequestMode> getMode() {
        return mode;
    }

    @java.lang.Override
    public boolean equals(Object other) {
        if (this == other) return true;
        return other instanceof DocumentsImportFromRequest && equalTo((DocumentsImportFromRequest) other);
    }

    @JsonAnyGetter
    public Map<String, Object> getAdditionalProperties() {
        return this.additionalProperties;
    }

    private boolean equalTo(DocumentsImportFromRequest other) {
        return source.equals(other.source)
                && expected.equals(other.expected)
                && metadata.equals(other.metadata)
                && idempotencyKey.equals(other.idempotencyKey)
                && dedupMode.equals(other.dedupMode)
                && docId.equals(other.docId)
                && mode.equals(other.mode);
    }

    @java.lang.Override
    public int hashCode() {
        return Objects.hash(
                this.source, this.expected, this.metadata, this.idempotencyKey, this.dedupMode, this.docId, this.mode);
    }

    @java.lang.Override
    public String toString() {
        return ObjectMappers.stringify(this);
    }

    public static SourceStage builder() {
        return new Builder();
    }

    public interface SourceStage {
        /**
         * <p>Where CloudPDF pulls the bytes from. The two shapes differ in WHO supplies the authority to read, not in which storage vendor holds the file.</p>
         */
        _FinalStage source(@NotNull DocumentsImportFromRequestSource source);

        Builder from(DocumentsImportFromRequest other);
    }

    public interface _FinalStage {
        DocumentsImportFromRequest build();

        _FinalStage additionalProperty(String key, Object value);

        _FinalStage additionalProperties(Map<String, Object> additionalProperties);

        /**
         * <p>Integrity pins, enforced when present. When absent, the server-observed values become authoritative.</p>
         */
        _FinalStage expected(Optional<DocumentsImportFromRequestExpected> expected);

        _FinalStage expected(DocumentsImportFromRequestExpected expected);

        _FinalStage metadata(Optional<Map<String, Object>> metadata);

        _FinalStage metadata(Map<String, Object> metadata);

        /**
         * <p>Retrying with the same key resumes the same document rather than importing a second copy — including after a 502.</p>
         */
        _FinalStage idempotencyKey(Optional<String> idempotencyKey);

        _FinalStage idempotencyKey(String idempotencyKey);

        /**
         * <p>always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.</p>
         */
        _FinalStage dedupMode(Optional<DocumentsImportFromRequestDedupMode> dedupMode);

        _FinalStage dedupMode(DocumentsImportFromRequestDedupMode dedupMode);

        _FinalStage docId(Optional<String> docId);

        _FinalStage docId(String docId);

        /**
         * <p>sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256.</p>
         */
        _FinalStage mode(Optional<DocumentsImportFromRequestMode> mode);

        _FinalStage mode(DocumentsImportFromRequestMode mode);
    }

    @JsonIgnoreProperties(ignoreUnknown = true)
    public static final class Builder implements SourceStage, _FinalStage {
        private DocumentsImportFromRequestSource source;

        private Optional<DocumentsImportFromRequestMode> mode = Optional.empty();

        private Optional<String> docId = Optional.empty();

        private Optional<DocumentsImportFromRequestDedupMode> dedupMode = Optional.empty();

        private Optional<String> idempotencyKey = Optional.empty();

        private Optional<Map<String, Object>> metadata = Optional.empty();

        private Optional<DocumentsImportFromRequestExpected> expected = Optional.empty();

        @JsonAnySetter
        private Map<String, Object> additionalProperties = new HashMap<>();

        private Builder() {}

        @java.lang.Override
        public Builder from(DocumentsImportFromRequest other) {
            source(other.getSource());
            expected(other.getExpected());
            metadata(other.getMetadata());
            idempotencyKey(other.getIdempotencyKey());
            dedupMode(other.getDedupMode());
            docId(other.getDocId());
            mode(other.getMode());
            return this;
        }

        /**
         * <p>Where CloudPDF pulls the bytes from. The two shapes differ in WHO supplies the authority to read, not in which storage vendor holds the file.</p>
         * @return Reference to {@code this} so that method calls can be chained together.
         */
        @java.lang.Override
        @JsonSetter("source")
        public _FinalStage source(@NotNull DocumentsImportFromRequestSource source) {
            this.source = Objects.requireNonNull(source, "source must not be null");
            return this;
        }

        /**
         * <p>sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256.</p>
         * @return Reference to {@code this} so that method calls can be chained together.
         */
        @java.lang.Override
        public _FinalStage mode(DocumentsImportFromRequestMode mode) {
            this.mode = Optional.ofNullable(mode);
            return this;
        }

        /**
         * <p>sync (default) holds the response open for the whole transfer. async answers 202 with the document pending and transfers in the background; it requires a connection source, and filesystem connections additionally require expected.sha256.</p>
         */
        @java.lang.Override
        @JsonSetter(value = "mode", nulls = Nulls.SKIP)
        public _FinalStage mode(Optional<DocumentsImportFromRequestMode> mode) {
            this.mode = mode;
            return this;
        }

        @java.lang.Override
        public _FinalStage docId(String docId) {
            this.docId = Optional.ofNullable(docId);
            return this;
        }

        @java.lang.Override
        @JsonSetter(value = "docId", nulls = Nulls.SKIP)
        public _FinalStage docId(Optional<String> docId) {
            this.docId = docId;
            return this;
        }

        /**
         * <p>always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.</p>
         * @return Reference to {@code this} so that method calls can be chained together.
         */
        @java.lang.Override
        public _FinalStage dedupMode(DocumentsImportFromRequestDedupMode dedupMode) {
            this.dedupMode = Optional.ofNullable(dedupMode);
            return this;
        }

        /**
         * <p>always-create (default) creates a new document every time. reuse-existing returns a document that already holds the same content instead of storing it twice.</p>
         */
        @java.lang.Override
        @JsonSetter(value = "dedupMode", nulls = Nulls.SKIP)
        public _FinalStage dedupMode(Optional<DocumentsImportFromRequestDedupMode> dedupMode) {
            this.dedupMode = dedupMode;
            return this;
        }

        /**
         * <p>Retrying with the same key resumes the same document rather than importing a second copy — including after a 502.</p>
         * @return Reference to {@code this} so that method calls can be chained together.
         */
        @java.lang.Override
        public _FinalStage idempotencyKey(String idempotencyKey) {
            this.idempotencyKey = Optional.ofNullable(idempotencyKey);
            return this;
        }

        /**
         * <p>Retrying with the same key resumes the same document rather than importing a second copy — including after a 502.</p>
         */
        @java.lang.Override
        @JsonSetter(value = "idempotencyKey", nulls = Nulls.SKIP)
        public _FinalStage idempotencyKey(Optional<String> idempotencyKey) {
            this.idempotencyKey = idempotencyKey;
            return this;
        }

        @java.lang.Override
        public _FinalStage metadata(Map<String, Object> metadata) {
            this.metadata = Optional.ofNullable(metadata);
            return this;
        }

        @java.lang.Override
        @JsonSetter(value = "metadata", nulls = Nulls.SKIP)
        public _FinalStage metadata(Optional<Map<String, Object>> metadata) {
            this.metadata = metadata;
            return this;
        }

        /**
         * <p>Integrity pins, enforced when present. When absent, the server-observed values become authoritative.</p>
         * @return Reference to {@code this} so that method calls can be chained together.
         */
        @java.lang.Override
        public _FinalStage expected(DocumentsImportFromRequestExpected expected) {
            this.expected = Optional.ofNullable(expected);
            return this;
        }

        /**
         * <p>Integrity pins, enforced when present. When absent, the server-observed values become authoritative.</p>
         */
        @java.lang.Override
        @JsonSetter(value = "expected", nulls = Nulls.SKIP)
        public _FinalStage expected(Optional<DocumentsImportFromRequestExpected> expected) {
            this.expected = expected;
            return this;
        }

        @java.lang.Override
        public DocumentsImportFromRequest build() {
            return new DocumentsImportFromRequest(
                    source, expected, metadata, idempotencyKey, dedupMode, docId, mode, additionalProperties);
        }

        @java.lang.Override
        public Builder additionalProperty(String key, Object value) {
            this.additionalProperties.put(key, value);
            return this;
        }

        @java.lang.Override
        public Builder additionalProperties(Map<String, Object> additionalProperties) {
            this.additionalProperties.putAll(additionalProperties);
            return this;
        }
    }
}