EnvironmentDeploymentRuleAPI.md

\EnvironmentDeploymentRuleAPI

All URIs are relative to https://api.qovery.com

Method	HTTP request	Description
EditEnvironmentDeploymentRule	Put /environment/{environmentId}/deploymentRule/{deploymentRuleId}	Edit an environment deployment rule
GetEnvironmentDeploymentRule	Get /environment/{environmentId}/deploymentRule	Get environment deployment rule

EditEnvironmentDeploymentRule

EnvironmentDeploymentRule EditEnvironmentDeploymentRule(ctx, environmentId, deploymentRuleId).EnvironmentDeploymentRuleEditRequest(environmentDeploymentRuleEditRequest).Execute()

Edit an environment deployment rule

Example

package main

import (
	"context"
	"fmt"
	"os"
    "time"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	environmentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Environment ID
	deploymentRuleId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Deployment Rule ID
	environmentDeploymentRuleEditRequest := *openapiclient.NewEnvironmentDeploymentRuleEditRequest("UTC", time.Now(), time.Now(), []openapiclient.WeekdayEnum{openapiclient.WeekdayEnum("MONDAY")}) // EnvironmentDeploymentRuleEditRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnvironmentDeploymentRuleAPI.EditEnvironmentDeploymentRule(context.Background(), environmentId, deploymentRuleId).EnvironmentDeploymentRuleEditRequest(environmentDeploymentRuleEditRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnvironmentDeploymentRuleAPI.EditEnvironmentDeploymentRule``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `EditEnvironmentDeploymentRule`: EnvironmentDeploymentRule
	fmt.Fprintf(os.Stdout, "Response from `EnvironmentDeploymentRuleAPI.EditEnvironmentDeploymentRule`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
environmentId	string	Environment ID
deploymentRuleId	string	Deployment Rule ID

Other Parameters

Other parameters are passed through a pointer to a apiEditEnvironmentDeploymentRuleRequest struct via the builder pattern

Name	Type	Description	Notes

environmentDeploymentRuleEditRequest | EnvironmentDeploymentRuleEditRequest | |

Return type

EnvironmentDeploymentRule

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetEnvironmentDeploymentRule

EnvironmentDeploymentRule GetEnvironmentDeploymentRule(ctx, environmentId).Execute()

Get environment deployment rule

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/qovery/qovery-client-go"
)

func main() {
	environmentId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Environment ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.EnvironmentDeploymentRuleAPI.GetEnvironmentDeploymentRule(context.Background(), environmentId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `EnvironmentDeploymentRuleAPI.GetEnvironmentDeploymentRule``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetEnvironmentDeploymentRule`: EnvironmentDeploymentRule
	fmt.Fprintf(os.Stdout, "Response from `EnvironmentDeploymentRuleAPI.GetEnvironmentDeploymentRule`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
environmentId	string	Environment ID

Other Parameters

Other parameters are passed through a pointer to a apiGetEnvironmentDeploymentRuleRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

EnvironmentDeploymentRule

Authorization

ApiKeyAuth, bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]