Package io.swagger.v3.plugins.gradle.tasks

Class ResolveTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
io.swagger.v3.plugins.gradle.tasks.ResolveTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>
@CacheableTask public class ResolveTask extends org.gradle.api.DefaultTask

  • Field Details

    • outputFileName

      @Input @Optional public final org.gradle.api.provider.Property<String> outputFileName

    • outputDir

      @OutputDirectory public final org.gradle.api.file.DirectoryProperty outputDir

    • openApiFile

      @InputFile @Optional @PathSensitive(RELATIVE) public final org.gradle.api.file.RegularFileProperty openApiFile

    • outputFormat

      @Input @Optional public final org.gradle.api.provider.Property<ResolveTask.Format> outputFormat

    • resourcePackages

      @Input @Optional public final org.gradle.api.provider.SetProperty<String> resourcePackages

    • resourceClasses

      @Input @Optional public final org.gradle.api.provider.SetProperty<String> resourceClasses

    • filterClass

      @Input @Optional public final org.gradle.api.provider.Property<String> filterClass

    • readerClass

      @Input @Optional public final org.gradle.api.provider.Property<String> readerClass

    • scannerClass

      @Input @Optional public final org.gradle.api.provider.Property<String> scannerClass

    • prettyPrint

      @Input @Optional public final org.gradle.api.provider.Property<Boolean> prettyPrint

    • readAllResources

      @Input @Optional public final org.gradle.api.provider.Property<Boolean> readAllResources

    • ignoredRoutes

      @Input @Optional public final org.gradle.api.provider.SetProperty<String> ignoredRoutes

    • buildClasspath

      @Classpath @Optional public final org.gradle.api.file.ConfigurableFileCollection buildClasspath

    • classpath

      @Classpath public final org.gradle.api.file.ConfigurableFileCollection classpath

    • skip

      @Deprecated @Input @Optional public final org.gradle.api.provider.Property<Boolean> skip
      Deprecated.
      if you want to skip the task do not execute it in the first place or remove the task dependency that causes it to run
      Completely skips execution of the task.

    • encoding

      @Input @Optional public final org.gradle.api.provider.Property<String> encoding

    • modelConverterClasses

      @Input @Optional public final org.gradle.api.provider.SetProperty<String> modelConverterClasses
      Since:
      2.0.6

    • objectMapperProcessorClass

      @Input @Optional public final org.gradle.api.provider.Property<String> objectMapperProcessorClass

    • sortOutput

      @Input @Optional public final org.gradle.api.provider.Property<Boolean> sortOutput

    • alwaysResolveAppPath

      @Input @Optional public final org.gradle.api.provider.Property<Boolean> alwaysResolveAppPath

    • skipResolveAppPath

      @Input @Optional public final org.gradle.api.provider.Property<Boolean> skipResolveAppPath

    • contextId

      @Input @Optional public final org.gradle.api.provider.Property<String> contextId

    • openAPI31

      @Input @Optional public final org.gradle.api.provider.Property<Boolean> openAPI31

    • convertToOpenAPI31

      @Input @Optional public final org.gradle.api.provider.Property<Boolean> convertToOpenAPI31
      Since:
      2.2.12

    • schemaResolution

      @Input @Optional public final org.gradle.api.provider.Property<String> schemaResolution
      Since:
      2.2.24

    • defaultResponseCode

      @Input @Optional public final org.gradle.api.provider.Property<String> defaultResponseCode

    • validatorProcessorClass

      @Input @Optional public final org.gradle.api.provider.Property<String> validatorProcessorClass

    • groupsValidationStrategy

      @Input @Optional public final org.gradle.api.provider.Property<String> groupsValidationStrategy

  • Constructor Details

    • ResolveTask

      public ResolveTask()

  • Method Details

    • getOutputFileName

      public org.gradle.api.provider.Property<String> getOutputFileName()

    • getOpenApiFile

      public org.gradle.api.file.RegularFileProperty getOpenApiFile()

    • getOutputDir

      public org.gradle.api.file.DirectoryProperty getOutputDir()

    • setOutputDir

      public void setOutputDir(String outputPath)

    • setOutputFileName

      public void setOutputFileName(String outputFileName)

    • setOpenApiFile

      public void setOpenApiFile(File openApiFile)

    • getClasspath

      public org.gradle.api.file.ConfigurableFileCollection getClasspath()

    • setClasspath

      public void setClasspath(Iterable<File> classpath)

    • getBuildClasspath

      public org.gradle.api.file.ConfigurableFileCollection getBuildClasspath()

    • setBuildClasspath

      public void setBuildClasspath(Iterable<File> buildClasspath)

    • getOutputPath

      @Deprecated @Internal public org.gradle.api.provider.Provider<String> getOutputPath()
      Deprecated.
      Use outputDir instead.

    • setOutputPath

      @Deprecated public void setOutputPath(String outputPath)
      Deprecated.
      Use outputDir instead.

    • getOutputFormat

      public org.gradle.api.provider.Property<ResolveTask.Format> getOutputFormat()

    • setOutputFormat

      public void setOutputFormat(String outputFormat)

    • setOutputFormat

      public void setOutputFormat(ResolveTask.Format outputFormat)

    • getResourcePackages

      public org.gradle.api.provider.SetProperty<String> getResourcePackages()

    • setResourcePackages

      public void setResourcePackages(Set<String> resourcePackages)

    • getModelConverterClasses

      public org.gradle.api.provider.SetProperty<String> getModelConverterClasses()

    • setModelConverterClasses

      public void setModelConverterClasses(Set<String> modelConverterClasses)

    • getResourceClasses

      public org.gradle.api.provider.SetProperty<String> getResourceClasses()

    • setResourceClasses

      public void setResourceClasses(Set<String> resourceClasses)

    • getFilterClass

      public org.gradle.api.provider.Property<String> getFilterClass()

    • setFilterClass

      public void setFilterClass(String filterClass)

    • getReaderClass

      public org.gradle.api.provider.Property<String> getReaderClass()

    • setReaderClass

      public void setReaderClass(String readerClass)

    • getObjectMapperProcessorClass

      public org.gradle.api.provider.Property<String> getObjectMapperProcessorClass()

    • setObjectMapperProcessorClass

      public void setObjectMapperProcessorClass(String objectMapperProcessorClass)
      Since:
      2.0.6

    • getDefaultResponseCode

      public org.gradle.api.provider.Property<String> getDefaultResponseCode()
      Since:
      2.2.17

    • setDefaultResponseCode

      public void setDefaultResponseCode(String defaultResponseCode)
      Since:
      2.2.17

    • getValidatorProcessorClass

      public org.gradle.api.provider.Property<String> getValidatorProcessorClass()
      Since:
      2.2.29

    • setValidatorProcessorClass

      public void setValidatorProcessorClass(String validatorProcessorClass)
      Since:
      2.2.29

    • getGroupsValidationStrategy

      public org.gradle.api.provider.Property<String> getGroupsValidationStrategy()
      Since:
      2.2.29

    • setGroupsValidationStrategy

      public void setGroupsValidationStrategy(String groupsValidationStrategy)
      Since:
      2.2.29

    • getContextId

      public org.gradle.api.provider.Property<String> getContextId()

    • setContextId

      public void setContextId(String contextId)
      Since:
      2.0.6

    • getScannerClass

      public org.gradle.api.provider.Property<String> getScannerClass()

    • setScannerClass

      public void setScannerClass(String scannerClass)

    • getPrettyPrint

      public org.gradle.api.provider.Property<Boolean> getPrettyPrint()

    • setPrettyPrint

      public void setPrettyPrint(@Nullable @Nullable String prettyPrint)

    • setPrettyPrint

      public void setPrettyPrint(@Nullable @Nullable Boolean prettyPrint)

    • getReadAllResources

      public org.gradle.api.provider.Property<Boolean> getReadAllResources()

    • setReadAllResources

      public void setReadAllResources(Boolean readAllResources)

    • setReadAllResources

      public void setReadAllResources(@Nullable @Nullable String readAllResources)

    • getIgnoredRoutes

      public org.gradle.api.provider.SetProperty<String> getIgnoredRoutes()

    • setIgnoredRoutes

      public void setIgnoredRoutes(Collection<String> ignoredRoutes)

    • getSkip

      public org.gradle.api.provider.Property<Boolean> getSkip()

    • setSkip

      public void setSkip(Boolean skip)

    • getEncoding

      public org.gradle.api.provider.Property<String> getEncoding()

    • setEncoding

      public void setEncoding(String encoding)

    • getSortOutput

      public org.gradle.api.provider.Property<Boolean> getSortOutput()

    • setSortOutput

      public void setSortOutput(Boolean sortOutput)

    • getAlwaysResolveAppPath

      public org.gradle.api.provider.Property<Boolean> getAlwaysResolveAppPath()

    • setAlwaysResolveAppPath

      public void setAlwaysResolveAppPath(Boolean alwaysResolveAppPath)

    • setAlwaysResolveAppPath

      public void setAlwaysResolveAppPath(@Nullable @Nullable String alwaysResolveAppPath)

    • getSkipResolveAppPath

      public org.gradle.api.provider.Property<Boolean> getSkipResolveAppPath()

    • setSkipResolveAppPath

      public void setSkipResolveAppPath(Boolean skipResolveAppPath)
      Since:
      2.2.15

    • getOpenAPI31

      public org.gradle.api.provider.Property<Boolean> getOpenAPI31()

    • setOpenAPI31

      public void setOpenAPI31(Boolean openAPI31)

    • setOpenAPI31

      public void setOpenAPI31(@Nullable @Nullable String openAPI31)

    • getConvertToOpenAPI31

      public org.gradle.api.provider.Property<Boolean> getConvertToOpenAPI31()

    • setConvertToOpenAPI31

      public void setConvertToOpenAPI31(Boolean convertToOpenAPI31)

    • setConvertToOpenAPI31

      public void setConvertToOpenAPI31(@Nullable @Nullable String convertToOpenAPI31)

    • getSchemaResolution

      public org.gradle.api.provider.Property<String> getSchemaResolution()

    • setSchemaResolution

      public void setSchemaResolution(String schemaResolution)

    • getOpenAPIVersion

      public org.gradle.api.provider.Property<String> getOpenAPIVersion()

    • setOpenAPIVersion

      public void setOpenAPIVersion(String openAPIVersion)

    • resolve

      public void resolve() throws org.gradle.api.GradleException
      Throws:
      org.gradle.api.GradleException