Package com.sap.cloud.sdk.datamodel.metadata.generator

Interface ApiUsageMetadata

All Known Implementing Classes:
ODataApiUsageMetadata, RestApiUsageMetadata
public interface ApiUsageMetadata
Metadata about API usage.

  • Method Details

    • getServiceConstructorArguments

      @Nonnull List<ApiUsageMetadata.MethodArgument> getServiceConstructorArguments()
      Get constructor arguments.
      Returns:
      A sorted list of constructor arguments.

    • getServiceMethodInvocations

      @Nonnull List<ApiUsageMetadata.Invocation> getServiceMethodInvocations()
      Get method invocations.
      Returns:
      A sorted list of method invocations.

    • getQualifiedServiceInterfaceName

      @Nonnull String getQualifiedServiceInterfaceName()
      Get fully-qualified service interface name.
      Returns:
      The service interface name.

    • getQualifiedServiceClassName

      @Nonnull String getQualifiedServiceClassName()
      Get fully-qualified service class name.
      Returns:
      The service class name.

    • getQualifiedServiceMethodResult

      @Nonnull String getQualifiedServiceMethodResult()
      Get fully-qualified method result type.
      Returns:
      The method result type.

    • method

      @Nonnull static ApiUsageMetadata.Invocation method(@Nonnull String name)
      Convenience method to create a new method invocation.
      Parameters:
      name - method name
      Returns:
      A new instance of a method invocation.

    • arg

      @Nonnull static ApiUsageMetadata.MethodArgument arg(@Nonnull String code)
      Convenient method to add static argument code.
      Parameters:
      code - argument code, e.g. "5" or "\"String\""
      Returns:
      A new instance with an additional argument

    • arg

      @Nonnull static ApiUsageMetadata.MethodArgument arg(@Nonnull String code, @Nonnull Class<?> type)
      Convenient method to add static argument code.
      Parameters:
      code - argument code, e.g. "5" or "\"String\""
      type - argument type, e.g. java.lang.String
      Returns:
      A new instance with an additional argument