Skip to content

Latest commit

 

History

History
152 lines (96 loc) · 4.27 KB

JobConfigurationAPI.md

File metadata and controls

152 lines (96 loc) · 4.27 KB
Raw

\JobConfigurationAPI

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

Method HTTP request Description
EditJobAdvancedSettings Put /job/{jobId}/advancedSettings Edit advanced settings
GetJobAdvancedSettings Get /job/{jobId}/advancedSettings Get advanced settings

EditJobAdvancedSettings

JobAdvancedSettings EditJobAdvancedSettings(ctx, jobId).JobAdvancedSettings(jobAdvancedSettings).Execute()

Edit advanced settings

Example

package main

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

func main() {
	jobId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | Job ID
	jobAdvancedSettings := *openapiclient.NewJobAdvancedSettings() // JobAdvancedSettings |  (optional)

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

jobAdvancedSettings | JobAdvancedSettings | |

Return type

JobAdvancedSettings

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]

GetJobAdvancedSettings

JobAdvancedSettings GetJobAdvancedSettings(ctx, jobId).Execute()

Get advanced settings

Example

package main

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

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

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

Path Parameters

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

Other Parameters

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

Name Type Description Notes

Return type

JobAdvancedSettings

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]