Dagger
Search

confluence-updater

This module has been generated via dagger init and serves as a reference to
basic module structure as you get started with Dagger.

Two functions have been pre-created. You can modify, delete, or add to them,
as needed. They demonstrate usage of arguments and return types using simple
echo and grep commands. The functions can be called from the dagger CLI or
from one of the SDKs.

The first line in this comment block is a short description line and the
rest is a long description with more detail on the module's purpose or usage,
if appropriate. All modules should have a short description.

Installation

dagger install github.com/Kerwood/dagger-modules/confluence-updater@bb3c8bc33f3e5478074eb1c6cb8a525e5f76e31b

Entrypoint

Return Type
ConfluenceUpdater !
Arguments
NameTypeDefault ValueDescription
srcDirectoryDirectory -No description provided
userString ""No description provided
tokenSecret -No description provided
fqdnString ""No description provided
Example
dagger -m github.com/Kerwood/dagger-modules/confluence-updater@bb3c8bc33f3e5478074eb1c6cb8a525e5f76e31b call \
func (m *MyModule) Example() *dagger.ConfluenceUpdater  {
	return dag.
			ConfluenceUpdater()
}
@function
def example() -> dagger.ConfluenceUpdater:
	return (
		dag.confluence_updater()
	)
@func()
example(): ConfluenceUpdater {
	return dag
		.confluenceUpdater()
}

Types

ConfluenceUpdater 🔗

run() 🔗

Return Type
String !
Example
dagger -m github.com/Kerwood/dagger-modules/confluence-updater@bb3c8bc33f3e5478074eb1c6cb8a525e5f76e31b call \
 run
func (m *MyModule) Example(ctx context.Context) string  {
	return dag.
			ConfluenceUpdater().
			Run(ctx)
}
@function
async def example() -> str:
	return await (
		dag.confluence_updater()
		.run()
	)
@func()
async example(): Promise<string> {
	return dag
		.confluenceUpdater()
		.run()
}

user() 🔗

Return Type
ConfluenceUpdater !
Arguments
NameTypeDefault ValueDescription
userString !-No description provided
Example
dagger -m github.com/Kerwood/dagger-modules/confluence-updater@bb3c8bc33f3e5478074eb1c6cb8a525e5f76e31b call \
 user --user string
func (m *MyModule) Example(user string) *dagger.ConfluenceUpdater  {
	return dag.
			ConfluenceUpdater().
			User(user)
}
@function
def example(user: str) -> dagger.ConfluenceUpdater:
	return (
		dag.confluence_updater()
		.user(user)
	)
@func()
example(user: string): ConfluenceUpdater {
	return dag
		.confluenceUpdater()
		.user(user)
}

token() 🔗

Return Type
ConfluenceUpdater !
Arguments
NameTypeDefault ValueDescription
tokenSecret !-No description provided
Example
dagger -m github.com/Kerwood/dagger-modules/confluence-updater@bb3c8bc33f3e5478074eb1c6cb8a525e5f76e31b call \
 token --token env:MYSECRET
func (m *MyModule) Example(token *dagger.Secret) *dagger.ConfluenceUpdater  {
	return dag.
			ConfluenceUpdater().
			Token(token)
}
@function
def example(token: dagger.Secret) -> dagger.ConfluenceUpdater:
	return (
		dag.confluence_updater()
		.token(token)
	)
@func()
example(token: Secret): ConfluenceUpdater {
	return dag
		.confluenceUpdater()
		.token(token)
}

fqdn() 🔗

Return Type
ConfluenceUpdater !
Arguments
NameTypeDefault ValueDescription
fqdnString !-No description provided
Example
dagger -m github.com/Kerwood/dagger-modules/confluence-updater@bb3c8bc33f3e5478074eb1c6cb8a525e5f76e31b call \
 fqdn --fqdn string
func (m *MyModule) Example(fqdn string) *dagger.ConfluenceUpdater  {
	return dag.
			ConfluenceUpdater().
			Fqdn(fqdn)
}
@function
def example(fqdn: str) -> dagger.ConfluenceUpdater:
	return (
		dag.confluence_updater()
		.fqdn(fqdn)
	)
@func()
example(fqdn: string): ConfluenceUpdater {
	return dag
		.confluenceUpdater()
		.fqdn(fqdn)
}

sourceDirectory() 🔗

Return Type
ConfluenceUpdater !
Arguments
NameTypeDefault ValueDescription
srcDirectoryDirectory !-No description provided
Example
dagger -m github.com/Kerwood/dagger-modules/confluence-updater@bb3c8bc33f3e5478074eb1c6cb8a525e5f76e31b call \
 source-directory --src-directory DIR_PATH
func (m *MyModule) Example(srcDirectory *dagger.Directory) *dagger.ConfluenceUpdater  {
	return dag.
			ConfluenceUpdater().
			SourceDirectory(srcDirectory)
}
@function
def example(src_directory: dagger.Directory) -> dagger.ConfluenceUpdater:
	return (
		dag.confluence_updater()
		.source_directory(src_directory)
	)
@func()
example(srcDirectory: Directory): ConfluenceUpdater {
	return dag
		.confluenceUpdater()
		.sourceDirectory(srcDirectory)
}