github.com/goharbor/go-client@v0.210.0/pkg/sdk/v2.0/client/jobservice/stop_running_job_parameters.go (about) 1 // Code generated by go-swagger; DO NOT EDIT. 2 3 package jobservice 4 5 // This file was generated by the swagger tool. 6 // Editing this file might prove futile when you re-run the swagger generate command 7 8 import ( 9 "context" 10 "net/http" 11 "time" 12 13 "github.com/go-openapi/errors" 14 "github.com/go-openapi/runtime" 15 cr "github.com/go-openapi/runtime/client" 16 "github.com/go-openapi/strfmt" 17 ) 18 19 // NewStopRunningJobParams creates a new StopRunningJobParams object, 20 // with the default timeout for this client. 21 // 22 // Default values are not hydrated, since defaults are normally applied by the API server side. 23 // 24 // To enforce default values in parameter, use SetDefaults or WithDefaults. 25 func NewStopRunningJobParams() *StopRunningJobParams { 26 return &StopRunningJobParams{ 27 timeout: cr.DefaultTimeout, 28 } 29 } 30 31 // NewStopRunningJobParamsWithTimeout creates a new StopRunningJobParams object 32 // with the ability to set a timeout on a request. 33 func NewStopRunningJobParamsWithTimeout(timeout time.Duration) *StopRunningJobParams { 34 return &StopRunningJobParams{ 35 timeout: timeout, 36 } 37 } 38 39 // NewStopRunningJobParamsWithContext creates a new StopRunningJobParams object 40 // with the ability to set a context for a request. 41 func NewStopRunningJobParamsWithContext(ctx context.Context) *StopRunningJobParams { 42 return &StopRunningJobParams{ 43 Context: ctx, 44 } 45 } 46 47 // NewStopRunningJobParamsWithHTTPClient creates a new StopRunningJobParams object 48 // with the ability to set a custom HTTPClient for a request. 49 func NewStopRunningJobParamsWithHTTPClient(client *http.Client) *StopRunningJobParams { 50 return &StopRunningJobParams{ 51 HTTPClient: client, 52 } 53 } 54 55 /* 56 StopRunningJobParams contains all the parameters to send to the API endpoint 57 58 for the stop running job operation. 59 60 Typically these are written to a http.Request. 61 */ 62 type StopRunningJobParams struct { 63 64 /* XRequestID. 65 66 An unique ID for the request 67 */ 68 XRequestID *string 69 70 /* JobID. 71 72 The id of the job. 73 */ 74 JobID string 75 76 timeout time.Duration 77 Context context.Context 78 HTTPClient *http.Client 79 } 80 81 // WithDefaults hydrates default values in the stop running job params (not the query body). 82 // 83 // All values with no default are reset to their zero value. 84 func (o *StopRunningJobParams) WithDefaults() *StopRunningJobParams { 85 o.SetDefaults() 86 return o 87 } 88 89 // SetDefaults hydrates default values in the stop running job params (not the query body). 90 // 91 // All values with no default are reset to their zero value. 92 func (o *StopRunningJobParams) SetDefaults() { 93 // no default values defined for this parameter 94 } 95 96 // WithTimeout adds the timeout to the stop running job params 97 func (o *StopRunningJobParams) WithTimeout(timeout time.Duration) *StopRunningJobParams { 98 o.SetTimeout(timeout) 99 return o 100 } 101 102 // SetTimeout adds the timeout to the stop running job params 103 func (o *StopRunningJobParams) SetTimeout(timeout time.Duration) { 104 o.timeout = timeout 105 } 106 107 // WithContext adds the context to the stop running job params 108 func (o *StopRunningJobParams) WithContext(ctx context.Context) *StopRunningJobParams { 109 o.SetContext(ctx) 110 return o 111 } 112 113 // SetContext adds the context to the stop running job params 114 func (o *StopRunningJobParams) SetContext(ctx context.Context) { 115 o.Context = ctx 116 } 117 118 // WithHTTPClient adds the HTTPClient to the stop running job params 119 func (o *StopRunningJobParams) WithHTTPClient(client *http.Client) *StopRunningJobParams { 120 o.SetHTTPClient(client) 121 return o 122 } 123 124 // SetHTTPClient adds the HTTPClient to the stop running job params 125 func (o *StopRunningJobParams) SetHTTPClient(client *http.Client) { 126 o.HTTPClient = client 127 } 128 129 // WithXRequestID adds the xRequestID to the stop running job params 130 func (o *StopRunningJobParams) WithXRequestID(xRequestID *string) *StopRunningJobParams { 131 o.SetXRequestID(xRequestID) 132 return o 133 } 134 135 // SetXRequestID adds the xRequestId to the stop running job params 136 func (o *StopRunningJobParams) SetXRequestID(xRequestID *string) { 137 o.XRequestID = xRequestID 138 } 139 140 // WithJobID adds the jobID to the stop running job params 141 func (o *StopRunningJobParams) WithJobID(jobID string) *StopRunningJobParams { 142 o.SetJobID(jobID) 143 return o 144 } 145 146 // SetJobID adds the jobId to the stop running job params 147 func (o *StopRunningJobParams) SetJobID(jobID string) { 148 o.JobID = jobID 149 } 150 151 // WriteToRequest writes these params to a swagger request 152 func (o *StopRunningJobParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error { 153 154 if err := r.SetTimeout(o.timeout); err != nil { 155 return err 156 } 157 var res []error 158 159 if o.XRequestID != nil { 160 161 // header param X-Request-Id 162 if err := r.SetHeaderParam("X-Request-Id", *o.XRequestID); err != nil { 163 return err 164 } 165 } 166 167 // path param job_id 168 if err := r.SetPathParam("job_id", o.JobID); err != nil { 169 return err 170 } 171 172 if len(res) > 0 { 173 return errors.CompositeValidationError(res...) 174 } 175 return nil 176 }