Package com.appiancorp.suiteapi.resources

Annotation Interface Write

@Documented @Repeatable(List.class) @Target(METHOD) @Retention(RUNTIME) public @interface Write
Indicate that a method is writing to one or more resources. In general, Read methods scale better than Write methods. In Data sources with replication, a Read call may generally go to any of the replicas. Calls with multiple Data targets may be more likely to lag due to latency from any of the targets.

Example of a method that writes to the K Content engine and the Object Store (either disk or S3):

@Write({Data.K_CONTENT, Data.OBJECT_STORE})

Example of a method that writes to the K Process Execution engine:

@Write(Data.K_PROCESS_EXECUTION)
When directing to a K engine, this is used for primary vs. secondary routing. Methods marked with this annotation are kept current, and their annotations may change to reflect current usage despite being in suiteapi. For example, if a method was a Write, but no longer does a Write, then its Write annotation may be updated and replaced by the appropriate Read.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static @interface 
    Write.List
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    indirectRouting
    Is this write indirectly routed, i.e., does not count toward primary write update routing (e.g., this is written via k-to-k from another engine).
    Data[]
    value
    Which Data Resource will be used?

  • Element Details

    • value

      Data[] value
      Which Data Resource will be used?
      Default:
      {UNKNOWN}

    • indirectRouting

      boolean indirectRouting
      Is this write indirectly routed, i.e., does not count toward primary write update routing (e.g., this is written via k-to-k from another engine).
      Default:
      false