io.sphere.sdk.extensions.Extension Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of commercetools-models Show documentation

There is a newer version: 2.16.0

package io.sphere.sdk.extensions;

import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;

import io.sphere.sdk.annotations.*;
import io.sphere.sdk.models.Reference;
import io.sphere.sdk.models.Resource;
import io.sphere.sdk.models.WithKey;

import javax.annotation.Nullable;
import java.util.List;


@JsonDeserialize(as= ExtensionImpl.class)
@ResourceValue
@ResourceInfo(pluralName = "extensions", pathElement = "extensions")
@HasByIdGetEndpoint(javadocSummary = "Retrieves a extension by a known ID.")
@HasByKeyGetEndpoint(javadocSummary = "Retrieves a extension by a known Key.")
@HasQueryModel(baseInterfaces = {"io.sphere.sdk.queries.QueryModel"})
@HasQueryEndpoint
@HasCreateCommand(javadocSummary = "Creates an extension")
@HasUpdateCommand(javadocSummary = "Updates an extension.", updateWith = {"key","id"})
@HasDeleteCommand(javadocSummary = "Deletes an extension.", deleteWith = {"key","id"})
public interface Extension extends Resource, WithKey {


    @IgnoreInQueryModel
    @HasUpdateAction
    List getTriggers();

    @IgnoreInQueryModel
    @HasUpdateAction
    Destination getDestination();

    @Override
    @Nullable
    @HasUpdateAction
    String getKey();

    @IgnoreInQueryModel
    @HasUpdateAction
    @Nullable
    Long getTimeoutInMs();

    static TypeReference typeReference() {
        return new TypeReference() {
            @Override
            public String toString() {
                return "TypeReference";
            }
        };
    }

    @Override
    default Reference toReference() {
        return Reference.of(referenceTypeId(), getId(), this);
    }

    static Reference reference(final String id) {
        return Reference.of(referenceTypeId(), id);
    }

    static Reference referenceOfId(final String id) {
        return Reference.of(referenceTypeId(), id);
    }

    static String resourceTypeId() {
        return "extension";
    }

    static String referenceTypeId() {
        return "extension";
    }

}