All Implemented Interfaces:: kotlin.Comparable , org.gradle.api.Named , org.gradle.api.Task , org.gradle.api.internal.DynamicObjectAware , org.gradle.api.internal.TaskInternal , org.gradle.api.plugins.ExtensionAware , org.gradle.util.Configurable

@DisableCachingByDefault(because = "Operates against a running ICM server - the result depends on external server state and must never be taken from the build cache") 
public abstract class GenerateOpenAPIModel
extends AbstractICMASContainerTask<RedirectToLoggerCallback, RedirectToLoggerCallback, Long>

Task to execute the OpenAPI model generator on a running container.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`GenerateOpenAPIModel.FileOutputFormat`	Model file output formats.
`public class`	`GenerateOpenAPIModel.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`public final static String`	`TASK_NAME`
`public final static String`	`MAIN_CLASS`
`public final static String`	`SERVER_NAME`
`public final static String`	`ENV_INTERSHOP_PREPARATION_EMBEDDED`
`public final static String`	`WORKING_DIRECTORY`
`public final static String`	`CONTAINER_VOLUME`
`public final static String`	`MODELS_SUBDIRECTORY`
`public final static String`	`PROPERTIES_SUBDIRECTORY`
`private final Property<GenerateOpenAPIModel.FileOutputFormat>`	`fileOutputFormat`
`private final Property<String>`	`applicationsIDs`
`private final Property<Boolean>`	`embeddedDBPrepare`
`private final Property<DevelopmentConfiguration.DatabaseParameters>`	`databaseConfiguration`
`private final Property<DevelopmentConfiguration.WebserverConfiguration>`	`webserverConfiguration`
`private final Property<DevelopmentConfiguration.ASPortConfiguration>`	`portConfiguration`
`private final SetProperty<String>`	`cartridgeList`
`private final SetProperty<String>`	`testCartridgeList`
`private String`	`debug`
`private String`	`classpathLayout`
`private final Property<ContainerHandle>`	`container`
`private final TaskOutputsInternal`	`outputs`
`private final Property<String>`	`apiVersion`
`private final Spec<in TaskInternal>`	`onlyIf`
`private final Property<Duration>`	`timeout`
`private final TaskRequiredServices`	`requiredServices`
`private final TaskDependencyInternal`	`taskDependencies`
`private final Set<Object>`	`dependsOn`
`private final TaskDestroyables`	`destroyables`
`private final Logger`	`logger`
`private final String`	`path`
`private final Factory<File>`	`temporaryDirFactory`
`private final Optional<String>`	`reasonTaskIsIncompatibleWithConfigurationCache`
`private final TaskLocalState`	`localState`
`private final List<InputChangesAwareTaskAction>`	`taskActions`
`private final TaskDependencyInternal`	`lifecycleDependencies`
`private Boolean`	`isEnabled`
`private Boolean`	`impliesSubProjects`
`private final TaskInputsInternal`	`inputs`
`private Boolean`	`enabled`
`private final TaskStateInternal`	`state`
`private final Property<String>`	`url`
`private final TaskIdentity<?>`	`taskIdentity`
`private final TaskDependency`	`shouldRunAfter`
`private final ExtensionContainer`	`extensions`
`private final Boolean`	`isCompatibleWithConfigurationCache`
`private final TaskDependency`	`finalizedBy`
`private final AntBuilder`	`ant`
`private final List<ResourceLock>`	`sharedResources`
`private final DynamicObject`	`asDynamicObject`
`private Boolean`	`didWork`
`private final Property<DockerClientService>`	`dockerClientService`
`private final Optional<String>`	`reasonNotToTrackState`
`private String`	`group`
`private final Set<String>`	`reasonsNotToTrackState`
`private final Boolean`	`isHasCustomActions`
`private List<Action<in Task>>`	`actions`
`private final DirectoryProperty`	`certPath`
`private final String`	`name`
`private final File`	`temporaryDir`
`private final LoggingManager`	`logging`
`private final Path`	`identityPath`
`private final DockerClient`	`dockerClient`
`private final TaskDependency`	`mustRunAfter`
`private final StandardOutputCapture`	`standardOutputCapture`
`private final Project`	`project`
`private String`	`description`
`public final static GenerateOpenAPIModel.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`GenerateOpenAPIModel(ObjectFactory objectFactory, ProviderFactory providerFactory)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Property<GenerateOpenAPIModel.FileOutputFormat>`	`getFileOutputFormat()`	The model file output format property, if omitted YAML is used.
`final Property<String>`	`getApplicationsIDs()`	CLI option for application IDs property.
`final Property<Boolean>`	`getEmbeddedDBPrepare()`	CLI option for embedded dbPrepare property (default=false).
`List<GenerateOpenAPIModel.FileOutputFormat>`	`getAvailableFileOutputFormats()`	Returns a list of possible model file output formats for console help output.
`List<ResourceLock>`	`getSharedResources()`

Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractICMASContainerTask
getCartridgeList, getClasspathLayout, getDatabaseConfiguration, getDebug, getDebugOptionValues, getPortConfiguration, getTestCartridgeList, getWebserverConfiguration, runRemoteCommand, setClasspathLayout, setDebug
Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractContainerTask
currentContainerState, getContainer, getContainer
Methods inherited from class org.gradle.api.DefaultTask
getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, setActions, setDescription, setDidWork, setEnabled, setEnabled, setGroup
Methods inherited from class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
getApiVersion, getCertPath, getDockerClient, getDockerClientService, getUrl, onComplete, onError, onNext, start
Methods inherited from class org.gradle.api.internal.AbstractTask
getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getReasonsNotToTrackState, getRequiredServices, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, setImpliesSubProjects
Methods inherited from class com.intershop.gradle.icm.docker.tasks.GenerateOpenAPIModel
getSharedResources
Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractExistingContainerTask
executeUsing
Methods inherited from class org.gradle.api.Task
configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, doNotTrackState, finalizedBy, hasProperty, mustRunAfter, notCompatibleWithConfigurationCache, onlyIf, onlyIf, onlyIf, property, setDependsOn, setFinalizedBy, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService
Methods inherited from class kotlin.Comparable
compareTo
Methods inherited from class org.gradle.api.internal.TaskInternal
acceptServiceReferences, appendParallelSafeAction, doNotTrackStateIf, hasTaskActions, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GenerateOpenAPIModel

GenerateOpenAPIModel(ObjectFactory objectFactory, ProviderFactory providerFactory)

Method Detail
- getFileOutputFormat
```
@Input() final Property<GenerateOpenAPIModel.FileOutputFormat> getFileOutputFormat()
```
  The model file output format property, if omitted YAML is used.
- getApplicationsIDs
```
@Input()@Optional() final Property<String> getApplicationsIDs()
```
  CLI option for application IDs property.
- getEmbeddedDBPrepare
```
@Input()@Optional() final Property<Boolean> getEmbeddedDBPrepare()
```
  CLI option for embedded dbPrepare property (default=false).
- getAvailableFileOutputFormats
```
 List<GenerateOpenAPIModel.FileOutputFormat> getAvailableFileOutputFormats()
```
  Returns a list of possible model file output formats for console help output.
- getSharedResources
```
@Internal() List<ResourceLock> getSharedResources()
```

Class GenerateOpenAPIModel

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractICMASContainerTask

Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractContainerTask

Methods inherited from class org.gradle.api.DefaultTask

Methods inherited from class com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask

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

Methods inherited from class com.intershop.gradle.icm.docker.tasks.GenerateOpenAPIModel

Methods inherited from class com.intershop.gradle.icm.docker.tasks.AbstractExistingContainerTask

Methods inherited from class org.gradle.api.Task

Methods inherited from class kotlin.Comparable

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

Methods inherited from class java.lang.Object

Constructor Detail

GenerateOpenAPIModel

Method Detail

getFileOutputFormat

getApplicationsIDs

getEmbeddedDBPrepare

getAvailableFileOutputFormats

getSharedResources