Package com.commercetools.api.models.project

Interface ProjectChangeProductSearchIndexingEnabledAction

All Superinterfaces:
ProjectUpdateAction, ResourceUpdateAction<ProjectUpdateAction>
public interface ProjectChangeProductSearchIndexingEnabledAction extends ProjectUpdateAction
ProjectChangeProductSearchIndexingEnabledAction
Example to create an instance using the builder pattern 

     ProjectChangeProductSearchIndexingEnabledAction projectChangeProductSearchIndexingEnabledAction = ProjectChangeProductSearchIndexingEnabledAction.builder()
             .enabled(true)
             .build()

  • Field Details

    • CHANGE_PRODUCT_SEARCH_INDEXING_ENABLED

      static final String CHANGE_PRODUCT_SEARCH_INDEXING_ENABLED
      discriminator value for ProjectChangeProductSearchIndexingEnabledAction
      See Also:

  • Method Details

    • getEnabled

      @NotNull @NotNull Boolean getEnabled()
      • If false, the indexing of Product information will stop and the Product Projection Search as well as the Product Suggestions endpoint will not be available anymore for this Project. The Project's SearchIndexingConfiguration status for products will be changed to "Deactivated".
      • If true, the indexing of Product information will start and the Product Projection Search as well as the Product Suggestions endpoint will become available soon after for this Project. Proportional to the amount of information being indexed, the Project's SearchIndexingConfiguration status for products will be shown as "Indexing" during this time. As soon as the indexing has finished, the configuration status will be changed to "Activated" making the aforementioned endpoints fully available for this Project.
      Returns:
      enabled

    • getMode

      ProductSearchIndexingMode getMode()

      Controls whether the action should apply to Product Projection Search or to Product Search.

      Returns:
      mode

    • setEnabled

      void setEnabled(Boolean enabled)
      • If false, the indexing of Product information will stop and the Product Projection Search as well as the Product Suggestions endpoint will not be available anymore for this Project. The Project's SearchIndexingConfiguration status for products will be changed to "Deactivated".
      • If true, the indexing of Product information will start and the Product Projection Search as well as the Product Suggestions endpoint will become available soon after for this Project. Proportional to the amount of information being indexed, the Project's SearchIndexingConfiguration status for products will be shown as "Indexing" during this time. As soon as the indexing has finished, the configuration status will be changed to "Activated" making the aforementioned endpoints fully available for this Project.
      Parameters:
      enabled - value to be set

    • setMode

      void setMode(ProductSearchIndexingMode mode)

      Controls whether the action should apply to Product Projection Search or to Product Search.

      Parameters:
      mode - value to be set

    • of

      static ProjectChangeProductSearchIndexingEnabledAction of()
      factory method
      Returns:
      instance of ProjectChangeProductSearchIndexingEnabledAction

    • of

      static ProjectChangeProductSearchIndexingEnabledAction of(ProjectChangeProductSearchIndexingEnabledAction template)
      factory method to create a shallow copy ProjectChangeProductSearchIndexingEnabledAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • deepCopy

      @Nullable static ProjectChangeProductSearchIndexingEnabledAction deepCopy(@Nullable ProjectChangeProductSearchIndexingEnabledAction template)
      factory method to create a deep copy of ProjectChangeProductSearchIndexingEnabledAction
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ProjectChangeProductSearchIndexingEnabledActionBuilder builder()
      builder factory method for ProjectChangeProductSearchIndexingEnabledAction
      Returns:
      builder

    • builder

      static ProjectChangeProductSearchIndexingEnabledActionBuilder builder(ProjectChangeProductSearchIndexingEnabledAction template)
      create builder for ProjectChangeProductSearchIndexingEnabledAction instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withProjectChangeProductSearchIndexingEnabledAction

      default <T> T withProjectChangeProductSearchIndexingEnabledAction(Function<ProjectChangeProductSearchIndexingEnabledAction,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ProjectChangeProductSearchIndexingEnabledAction> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference