Package io.micronaut.openapi.generator

Interface JavaMicronautClientOptionsBuilder

All Superinterfaces:
GeneratorOptionsBuilder
public interface JavaMicronautClientOptionsBuilder extends GeneratorOptionsBuilder
The client generator options builder.

  • Method Details

    • withAuthorization

      JavaMicronautClientOptionsBuilder withAuthorization(boolean useAuth)
      If set to true the client will be configured for authorization.
      Parameters:
      useAuth - the authorization flag
      Returns:
      this builder

    • withAuthorizationFilterPattern

      JavaMicronautClientOptionsBuilder withAuthorizationFilterPattern(String authorizationFilterPattern)
      Sets the authorization filter pattern.
      Parameters:
      authorizationFilterPattern - the filter pattern
      Returns:
      this builder

    • withClientId

      JavaMicronautClientOptionsBuilder withClientId(String clientId)
      Sets the client id.
      Parameters:
      clientId - the client id
      Returns:
      this builder

    • withAdditionalClientTypeAnnotations

      JavaMicronautClientOptionsBuilder withAdditionalClientTypeAnnotations(List<String> additionalClientTypeAnnotations)
      Sets annotations for client type (class level annotations).
      Parameters:
      additionalClientTypeAnnotations - the type annotations
      Returns:
      this builder

    • withBasePathSeparator

      JavaMicronautClientOptionsBuilder withBasePathSeparator(String basePathSeparator)
      Sets the separator to use between the application name and base path when referencing the property.
      Parameters:
      basePathSeparator - the base path separator
      Returns:
      this builder

    • withLombok

      JavaMicronautClientOptionsBuilder withLombok(boolean lombok)
      If set to true, generated code will be with lombok annotations.
      Parameters:
      lombok - generate code with lombok annotations or not
      Returns:
      this builder

    • withPlural

      JavaMicronautClientOptionsBuilder withPlural(boolean plural)
      If set to true, the generated code will pluralize parameters and properties for arrays.
      Parameters:
      plural - generate pluralized parameters and properties for arrays
      Returns:
      this builder

    • withFluxForArrays

      JavaMicronautClientOptionsBuilder withFluxForArrays(boolean fluxForArrays)
      If set to true, generated code will be with Flux<?> instead Mono<List<?>>.
      Parameters:
      fluxForArrays - generate code with Flux<?> instead Mono<List<?>> or not
      Returns:
      this builder

    • withGeneratedAnnotation

      JavaMicronautClientOptionsBuilder withGeneratedAnnotation(boolean generatedAnnotation)
      If set to true, generated code will be with jakarta.annotation.Generated annotation.
      Parameters:
      generatedAnnotation - generate code with jakarta.annotation.Generated annotation or not
      Returns:
      this builder

    • withClientPath

      JavaMicronautClientOptionsBuilder withClientPath(boolean clientPath)
      If set to true, Api annotation @Client will be with `path` attribute.
      Parameters:
      clientPath - do we need add path attribute to @Client annotation
      Returns:
      this builder