SnowflakeExtension (gradle-snowflake-plugin 2.1.22 API)

io.github.stewartbryson.SnowflakeExtension

```
@groovy.util.logging.Slf4j
class SnowflakeExtension
extends java.lang.Object
```
The plugin configuration extension that is applied to the Gradle project as 'snowflake'.

Properties Summary

Properties
Type	Name and description
`java.lang.String`	`artifactId` Optional: specify an artifactId when using the 'maven-publish' plugin.
`java.lang.String`	`connection` The credentials connection to use.
`java.lang.String`	`ephemeralName` The name of the cloned Snowflake database.
`java.lang.String`	`groupId` Optional: specify an artifact groupId when using the 'maven-publish' plugin.
`java.lang.Boolean`	`keepEphemeral` Don't drop the ephemeral Snowflake clone at the end of the build.
`java.lang.String`	`publishUrl` Optional: specify the URL of stage if it is external.
`java.lang.String`	`stage` The Snowflake stage to upload to.
`java.lang.String`	`testSuite` Name of the functional test suite to use for testing UDFs against Snowflake.
`java.lang.Boolean`	`useCustomMaven` Optional: do not automatically apply 'maven-publish' and allow the user to apply that plugin in the 'build.gradle' file.
`java.lang.Boolean`	`useEphemeral` Create and use an ephemeral Snowflake clone for the entire build.

Constructor Summary

Constructors
Constructor and description
`SnowflakeExtension (org.gradle.api.Project project)` Constructor.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.String`	`getPublishTask()` Return the name of the Maven publication task associated with the external stage.
	`java.lang.String`	`getSnowflakeCloneName()` Return the database clone name based on GitHub actions when available.
	`java.lang.Boolean`	`isCI()` Informs whether the plugin is running inside a CICD environment.
	`java.lang.Boolean`	`isPR()` Informs whether the plugin is running against a pull request.
	`java.lang.Boolean`	`isTag()` Informs whether the plugin is running against a tag.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#wait(long), 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 artifactId
    
    Optional: specify an artifactId when using the 'maven-publish' plugin.
  - java.lang.String connection
    
    The credentials connection to use. Default: use the base connection info in credentials config.
  - java.lang.String ephemeralName
    
    The name of the cloned Snowflake database. Default: auto-generated. The autogenerated value is always prefixed with 'EPHEMERAL__', followed by pull request, tag or branch information when running in CICD environemnts. Otherwise, the suffix is autogenerated.
  - java.lang.String groupId
    
    Optional: specify an artifact groupId when using the 'maven-publish' plugin.
  - java.lang.Boolean keepEphemeral
    
    Don't drop the ephemeral Snowflake clone at the end of the build. Default: false
  - java.lang.String publishUrl
    
    Optional: specify the URL of stage if it is external. The plugin will apply the 'maven-publish' plugin and handle publishing artifacts there.
  - java.lang.String stage
    
    The Snowflake stage to upload to. Default: 'maven'.
  - java.lang.String testSuite
    
    Name of the functional test suite to use for testing UDFs against Snowflake. Default: 'functionalTest'.
  - java.lang.Boolean useCustomMaven
    
    Optional: do not automatically apply 'maven-publish' and allow the user to apply that plugin in the 'build.gradle' file.
  - java.lang.Boolean useEphemeral
    
    Create and use an ephemeral Snowflake clone for the entire build. Useful for CI/CD processes. Default: false
- Constructor Detail
  - SnowflakeExtension(org.gradle.api.Project project)
    
    Constructor.
    Parameters:
    project
- Method Detail
  - java.lang.String getPublishTask()
    
    Return the name of the Maven publication task associated with the external stage.
  - java.lang.String getSnowflakeCloneName()
    
    Return the database clone name based on GitHub actions when available.
  - java.lang.Boolean isCI()
    
    Informs whether the plugin is running inside a CICD environment.
    Returns:
    whether the plugin is running inside a CICD environment.
  - java.lang.Boolean isPR()
    
    Informs whether the plugin is running against a pull request.
    Returns:
    whether the plugin is running against a pull request.
  - java.lang.Boolean isTag()
    
    Informs whether the plugin is running against a tag.
    Returns:
    whether the plugin is running against a tag.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class SnowflakeExtension

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.lang.String artifactId

java.lang.String connection

java.lang.String ephemeralName

java.lang.String groupId

java.lang.Boolean keepEphemeral

java.lang.String publishUrl

java.lang.String stage

java.lang.String testSuite

java.lang.Boolean useCustomMaven

java.lang.Boolean useEphemeral

Constructor Detail

SnowflakeExtension(org.gradle.api.Project project)

Method Detail

java.lang.String getPublishTask()

java.lang.String getSnowflakeCloneName()

java.lang.Boolean isCI()

java.lang.Boolean isPR()

java.lang.Boolean isTag()