Dagger
Search

curl

No long description provided.

Installation

dagger install github.com/felipepimentel/daggerverse/essentials/curl@v0.0.0

Entrypoint

Return Type 
Curl !
Example
dagger -m github.com/felipepimentel/daggerverse/essentials/curl@6bcdbd5ff36901cf40d24f715adf3796b6c3ab14 call \

func (m *MyModule) Example() *dagger.Curl  {
	return dag.
			Curl()
}
@function
def example() -> dagger.Curl:
	return (
		dag.curl()
	)
@func()
example(): Curl {
	return dag
		.curl()
}

Types

Curl 🔗

Curl provides functionality for making HTTP requests

request() 🔗

Request makes an HTTP request with the specified configuration

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
configRequestConfig !-No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(config *dagger.CurlRequestConfig) *dagger.Container  {
	return dag.
			Curl().
			Request(config)
}
@function
def example(config: dagger.CurlRequestConfig) -> dagger.Container:
	return (
		dag.curl()
		.request(config)
	)
@func()
example(config: CurlRequestConfig): Container {
	return dag
		.curl()
		.request(config)
}

head() 🔗

Head makes a HEAD request to check endpoint availability

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
urlString !-No description provided
Example
dagger -m github.com/felipepimentel/daggerverse/essentials/curl@6bcdbd5ff36901cf40d24f715adf3796b6c3ab14 call \
 head --url string
func (m *MyModule) Example(url string) *dagger.Container  {
	return dag.
			Curl().
			Head(url)
}
@function
def example(url: str) -> dagger.Container:
	return (
		dag.curl()
		.head(url)
	)
@func()
example(url: string): Container {
	return dag
		.curl()
		.head(url)
}

get() 🔗

Get makes a GET request to retrieve content

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
urlString !-No description provided
Example
dagger -m github.com/felipepimentel/daggerverse/essentials/curl@6bcdbd5ff36901cf40d24f715adf3796b6c3ab14 call \
 get --url string
func (m *MyModule) Example(url string) *dagger.Container  {
	return dag.
			Curl().
			Get(url)
}
@function
def example(url: str) -> dagger.Container:
	return (
		dag.curl()
		.get(url)
	)
@func()
example(url: string): Container {
	return dag
		.curl()
		.get(url)
}

healthCheck() 🔗

HealthCheck performs a health check on an endpoint

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
urlString !-No description provided
Example
dagger -m github.com/felipepimentel/daggerverse/essentials/curl@6bcdbd5ff36901cf40d24f715adf3796b6c3ab14 call \
 health-check --url string
func (m *MyModule) Example(url string) *dagger.Container  {
	return dag.
			Curl().
			HealthCheck(url)
}
@function
def example(url: str) -> dagger.Container:
	return (
		dag.curl()
		.health_check(url)
	)
@func()
example(url: string): Container {
	return dag
		.curl()
		.healthCheck(url)
}

RequestConfig 🔗

RequestConfig holds configuration for making HTTP requests

url() 🔗

Return Type 
String !
Example
Function CurlRequestConfig.url is not accessible from the curl module
Function CurlRequestConfig.url is not accessible from the curl module
Function CurlRequestConfig.url is not accessible from the curl module
Function CurlRequestConfig.url is not accessible from the curl module

method() 🔗

Return Type 
String !
Example
Function CurlRequestConfig.method is not accessible from the curl module
Function CurlRequestConfig.method is not accessible from the curl module
Function CurlRequestConfig.method is not accessible from the curl module
Function CurlRequestConfig.method is not accessible from the curl module

headers() 🔗

Return Type 
[Header ! ] !
Example
Function CurlRequestConfig.headers is not accessible from the curl module
Function CurlRequestConfig.headers is not accessible from the curl module
Function CurlRequestConfig.headers is not accessible from the curl module
Function CurlRequestConfig.headers is not accessible from the curl module

followRedirect() 🔗

Return Type 
Boolean !
Example
Function CurlRequestConfig.followRedirect is not accessible from the curl module
Function CurlRequestConfig.followRedirect is not accessible from the curl module
Function CurlRequestConfig.followRedirect is not accessible from the curl module
Function CurlRequestConfig.followRedirect is not accessible from the curl module

insecure() 🔗

Return Type 
Boolean !
Example
Function CurlRequestConfig.insecure is not accessible from the curl module
Function CurlRequestConfig.insecure is not accessible from the curl module
Function CurlRequestConfig.insecure is not accessible from the curl module
Function CurlRequestConfig.insecure is not accessible from the curl module

output() 🔗

Return Type 
String !
Example
Function CurlRequestConfig.output is not accessible from the curl module
Function CurlRequestConfig.output is not accessible from the curl module
Function CurlRequestConfig.output is not accessible from the curl module
Function CurlRequestConfig.output is not accessible from the curl module

timeout() 🔗

Return Type 
Integer !
Example
Function CurlRequestConfig.timeout is not accessible from the curl module
Function CurlRequestConfig.timeout is not accessible from the curl module
Function CurlRequestConfig.timeout is not accessible from the curl module
Function CurlRequestConfig.timeout is not accessible from the curl module

retryAttempts() 🔗

Return Type 
Integer !
Example
Function CurlRequestConfig.retryAttempts is not accessible from the curl module
Function CurlRequestConfig.retryAttempts is not accessible from the curl module
Function CurlRequestConfig.retryAttempts is not accessible from the curl module
Function CurlRequestConfig.retryAttempts is not accessible from the curl module

retryDelay() 🔗

Return Type 
Integer !
Example
Function CurlRequestConfig.retryDelay is not accessible from the curl module
Function CurlRequestConfig.retryDelay is not accessible from the curl module
Function CurlRequestConfig.retryDelay is not accessible from the curl module
Function CurlRequestConfig.retryDelay is not accessible from the curl module

Header 🔗

Header represents an HTTP header

key() 🔗

Return Type 
String !
Example
Function CurlHeader.key is not accessible from the curl module
Function CurlHeader.key is not accessible from the curl module
Function CurlHeader.key is not accessible from the curl module
Function CurlHeader.key is not accessible from the curl module

value() 🔗

Return Type 
String !
Example
Function CurlHeader.value is not accessible from the curl module
Function CurlHeader.value is not accessible from the curl module
Function CurlHeader.value is not accessible from the curl module
Function CurlHeader.value is not accessible from the curl module