ConfluentPluginExtension (gradle-confluent 0.9.18 API)

com.redpillanalytics.gradle.ConfluentPluginExtension

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`configEnv` The environment to pass when configuring configPath.
`java.lang.String`	`configPath` The path of the Streams configuration file.
`java.lang.Boolean`	`enableFunctions` Enable KSQL UD(A)F support.
`java.lang.Boolean`	`enablePipelines` Enable KSQL pipeline support.
`java.lang.Boolean`	`enableStreams` Enable Kafka Streams support.
`java.lang.String`	`functionArtifactName` If populated, the KSQL Function JAR file will be renamed to this value during the copy.
`java.lang.String`	`functionDeployName` The name of the Function deploy directory in the project build directory.
`java.lang.String`	`functionPattern` The pattern used for matching the function deployment artifact.
`java.lang.String`	`pipelineBuildName` The name of the Pipeline build directory in the project build directory.
`java.lang.String`	`pipelineCreateName` The name of the Pipeline deployment 'create' script, which contains all the persistent statements that need to be executed.
`java.lang.String`	`pipelineDeployName` The name of the Pipeline deploy directory in the project build directory.
`java.lang.String`	`pipelineEndpoint` RESTful endpoint for the KSQL Server.
`java.lang.String`	`pipelinePattern` The pattern used for matching the pipeline deployment artifact.
`java.lang.String`	`pipelineSourceName` Name of the Pipeline source directory that resides in the sourceBase directory.
`java.lang.String`	`pipelineSourcePath` Full path of the Pipeline source directory.
`java.lang.String`	`sourceBase` Base source directory for the Confluent plugin.
`java.lang.String`	`taskGroup` The group name to use for all tasks.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`getPipelinePath()` Provides the path for Pipeline source files.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - java.lang.String configEnv
    
    The environment to pass when configuring configPath. This uses the ConfigSlurper concept of default values with environmental overloads.
  - java.lang.String configPath
    
    The path of the Streams configuration file. A relative path will be resolved in the project directory, while absolute paths are resolved absolutely.
  - java.lang.Boolean enableFunctions
    
    Enable KSQL UD(A)F support.
  - java.lang.Boolean enablePipelines
    
    Enable KSQL pipeline support.
  - java.lang.Boolean enableStreams
    
    Enable Kafka Streams support.
  - java.lang.String functionArtifactName
    
    If populated, the KSQL Function JAR file will be renamed to this value during the copy. This makes it easy to hand-off to downstream deployment mechanisms.
  - java.lang.String functionDeployName
    
    The name of the Function deploy directory in the project build directory.
  - java.lang.String functionPattern
    
    The pattern used for matching the function deployment artifact.
  - java.lang.String pipelineBuildName
    
    The name of the Pipeline build directory in the project build directory.
  - java.lang.String pipelineCreateName
    
    The name of the Pipeline deployment 'create' script, which contains all the persistent statements that need to be executed.
  - java.lang.String pipelineDeployName
    
    The name of the Pipeline deploy directory in the project build directory.
  - java.lang.String pipelineEndpoint
    
    RESTful endpoint for the KSQL Server.
  - java.lang.String pipelinePattern
    
    The pattern used for matching the pipeline deployment artifact.
  - java.lang.String pipelineSourceName
    
    Name of the Pipeline source directory that resides in the sourceBase directory.
  - java.lang.String pipelineSourcePath
    
    Full path of the Pipeline source directory. When set, this overrides the values of sourceBase and pipelineSourceName.
  - java.lang.String sourceBase
    
    Base source directory for the Confluent plugin.
  - java.lang.String taskGroup
    
    The group name to use for all tasks.
- Method Detail
  - java.lang.String getPipelinePath()
    
    Provides the path for Pipeline source files.
    Returns:
    The full path of the Pipeline source files. Uses pipelineSourcePath first if it exists, and if it doesn't (the default), then it uses sourceBase and pipelineSourceName.

Summary:
Property
Method

| Detail:
Property
Method

Groovy Documentation

[Groovy] Class ConfluentPluginExtension

Properties Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.String configEnv

java.lang.String configPath

java.lang.Boolean enableFunctions

java.lang.Boolean enablePipelines

java.lang.Boolean enableStreams

java.lang.String functionArtifactName

java.lang.String functionDeployName

java.lang.String functionPattern

java.lang.String pipelineBuildName

java.lang.String pipelineCreateName

java.lang.String pipelineDeployName

java.lang.String pipelineEndpoint

java.lang.String pipelinePattern

java.lang.String pipelineSourceName

java.lang.String pipelineSourcePath

java.lang.String sourceBase

java.lang.String taskGroup

Method Detail

java.lang.String getPipelinePath()