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
```
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 Property<String>`	`url`
`private final DirectoryProperty`	`certPath`
`private final Property<String>`	`apiVersion`
`private final Property<DockerClientService>`	`dockerClientService`
`private Boolean`	`enabled`
`private String`	`description`
`private String`	`group`
`private final Property<Duration>`	`timeout`
`private final TaskStateInternal`	`state`
`private Boolean`	`impliesSubProjects`
`private final Boolean`	`hasCustomActions`
`public final static GenerateOpenAPIModel.Companion`	`Companion`

Constructor Summary

Constructors
Constructor	Description
`GenerateOpenAPIModel(Project project)`

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 com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask
getApiVersion, getCertPath, getDockerClient, getDockerClientService, getUrl, onComplete, onError, onNext, start
Methods inherited from class org.gradle.api.internal.AbstractTask
acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects
Methods inherited from class org.gradle.api.DefaultTask
compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, 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 com.intershop.gradle.icm.docker.tasks.AbstractExistingContainerTask
executeUsing
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GenerateOpenAPIModel
```
GenerateOpenAPIModel(Project project)
```
- 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 com.bmuschko.gradle.docker.tasks.AbstractDockerRemoteApiTask

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

Methods inherited from class org.gradle.api.DefaultTask

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

Methods inherited from class java.lang.Object

Constructor Detail

GenerateOpenAPIModel

Method Detail

getFileOutputFormat

getApplicationsIDs

getEmbeddedDBPrepare

getAvailableFileOutputFormats

getSharedResources