Package com.azure.android.core.rest.annotation

Annotation Type ServiceClient

  • @Retention(SOURCE)
@Target(TYPE)
public @interface ServiceClient
    Annotation given to all service client classes.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.Class<?> builder
      The builder class that can construct an instance of this class.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      boolean isAsync
      Represents whether the network IO methods on this client will be performed asynchronously or synchronously (i.e.
      java.lang.Class<?>[] serviceInterfaces
      Optional field to indicate all the services this service client interacts with.

    • Element Detail

      • builder

        java.lang.Class<?> builder
        The builder class that can construct an instance of this class. All service clients are instantiated using a builder and this is a required field. Also, builders should be annotated with ServiceClientBuilder.
        Returns:
        the classname of the builder that can create an instance of this class.

      • isAsync

        boolean isAsync
        Represents whether the network IO methods on this client will be performed asynchronously or synchronously (i.e. blocking).
        Returns:
        true is the Service Client is asynchronous.
        Default:
        false

      • serviceInterfaces

        java.lang.Class<?>[] serviceInterfaces
        Optional field to indicate all the services this service client interacts with. All classes mentioned in this list should be annotated with ServiceInterface. Typically, there's one service associated with each client. However, there could be zero to N services associated with a single client.
        Returns:
        An array of all services this service client interacts with
        Default:
        {}