Package run.halo.gradle.openapi

Class OpenApiDocsGeneratorTask

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

run.halo.gradle.docker.AbstractDockerRemoteApiTask

run.halo.gradle.docker.DockerExistingImage

run.halo.gradle.openapi.AbstractOpenApiDocsTask

run.halo.gradle.openapi.OpenApiDocsGeneratorTask

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>

public class OpenApiDocsGeneratorTask
extends AbstractOpenApiDocsTask

Nested Class Summary

Nested classes/interfaces inherited from class run.halo.gradle.openapi.AbstractOpenApiDocsTask

AbstractOpenApiDocsTask.SpringDocGroupConfig

Nested classes/interfaces inherited from interface org.gradle.api.Task

org.gradle.api.Task.Namer

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTAINER_NAME
static final String	TASK_NAME

Fields inherited from class run.halo.gradle.openapi.AbstractOpenApiDocsTask

groupedApiMappings, outputDir

Fields inherited from interface org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor	Description
OpenApiDocsGeneratorTask()

Method Summary

Modifier and Type	Method	Description
org.gradle.api.provider.Property<String>	getContainerId()
org.gradle.api.provider.Property<String>	getPlatform()
org.gradle.api.provider.Property<Integer>	getPort()
org.gradle.api.provider.MapProperty<String,String>	getRequestHeaders()
org.gradle.api.provider.Property<String>	getTrustStore()
org.gradle.api.provider.Property<char[]>	getTrustStorePassword()
org.gradle.api.provider.Property<Boolean>	getUseExistingServer()
org.gradle.api.provider.Property<Integer>	getWaitTimeInSeconds()
void	runRemoteCommand()

Methods inherited from class run.halo.gradle.openapi.AbstractOpenApiDocsTask

generateSpringDocApplicationConfig, generateSpringDocConfigString, getApiDocsUrl, getApiDocsVersion, getGroupedApiMappings, getOutputDir, getPluginExtension, getSpringDocGroupConfigs

Methods inherited from class run.halo.gradle.docker.DockerExistingImage

getImageId, targetImageId, targetImageId, targetImageId

Methods inherited from class run.halo.gradle.docker.AbstractDockerRemoteApiTask

getApiVersion, getCertPath, getDockerClient, getDockerClientService, getNextHandler, getUrl, onComplete, onError, onNext, start

Methods inherited from class org.gradle.api.DefaultTask

compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

Methods inherited from class org.gradle.api.internal.AbstractTask

acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gradle.api.Task

doNotTrackState, getConvention, notCompatibleWithConfigurationCache

Field Details

CONTAINER_NAME

public static final String CONTAINER_NAME

See Also:

• Constant Field Values

TASK_NAME

public static final String TASK_NAME

See Also:

• Constant Field Values

Constructor Details

OpenApiDocsGeneratorTask

public OpenApiDocsGeneratorTask()

Method Details

runRemoteCommand

public void runRemoteCommand()
                      throws Exception

Specified by:

runRemoteCommand in class AbstractDockerRemoteApiTask

Throws:

Exception

getPlatform

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

getRequestHeaders

public org.gradle.api.provider.MapProperty<String,String> getRequestHeaders()

getTrustStore

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

getTrustStorePassword

public org.gradle.api.provider.Property<char[]> getTrustStorePassword()

getWaitTimeInSeconds

public org.gradle.api.provider.Property<Integer> getWaitTimeInSeconds()

getPort

public org.gradle.api.provider.Property<Integer> getPort()

getContainerId

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

getUseExistingServer

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