-
Notifications
You must be signed in to change notification settings - Fork 604
/
api_op_CancelJob.go
143 lines (116 loc) · 3.84 KB
/
api_op_CancelJob.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package elastictranscoder
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
"github.com/aws/aws-sdk-go-v2/private/protocol"
)
// The CancelJobRequest structure.
type CancelJobInput struct {
_ struct{} `type:"structure"`
// The identifier of the job that you want to cancel.
//
// To get a list of the jobs (including their jobId) that have a status of Submitted,
// use the ListJobsByStatus API action.
//
// Id is a required field
Id *string `location:"uri" locationName:"Id" type:"string" required:"true"`
}
// String returns the string representation
func (s CancelJobInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CancelJobInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "CancelJobInput"}
if s.Id == nil {
invalidParams.Add(aws.NewErrParamRequired("Id"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s CancelJobInput) MarshalFields(e protocol.FieldEncoder) error {
e.SetValue(protocol.HeaderTarget, "Content-Type", protocol.StringValue("application/json"), protocol.Metadata{})
if s.Id != nil {
v := *s.Id
metadata := protocol.Metadata{}
e.SetValue(protocol.PathTarget, "Id", protocol.QuotedValue{ValueMarshaler: protocol.StringValue(v)}, metadata)
}
return nil
}
// The response body contains a JSON object. If the job is successfully canceled,
// the value of Success is true.
type CancelJobOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s CancelJobOutput) String() string {
return awsutil.Prettify(s)
}
// MarshalFields encodes the AWS API shape using the passed in protocol encoder.
func (s CancelJobOutput) MarshalFields(e protocol.FieldEncoder) error {
return nil
}
const opCancelJob = "CancelJob"
// CancelJobRequest returns a request value for making API operation for
// Amazon Elastic Transcoder.
//
// The CancelJob operation cancels an unfinished job.
//
// You can only cancel a job that has a status of Submitted. To prevent a pipeline
// from starting to process a job while you're getting the job identifier, use
// UpdatePipelineStatus to temporarily pause the pipeline.
//
// // Example sending a request using CancelJobRequest.
// req := client.CancelJobRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
func (c *Client) CancelJobRequest(input *CancelJobInput) CancelJobRequest {
op := &aws.Operation{
Name: opCancelJob,
HTTPMethod: "DELETE",
HTTPPath: "/2012-09-25/jobs/{Id}",
}
if input == nil {
input = &CancelJobInput{}
}
req := c.newRequest(op, input, &CancelJobOutput{})
return CancelJobRequest{Request: req, Input: input, Copy: c.CancelJobRequest}
}
// CancelJobRequest is the request type for the
// CancelJob API operation.
type CancelJobRequest struct {
*aws.Request
Input *CancelJobInput
Copy func(*CancelJobInput) CancelJobRequest
}
// Send marshals and sends the CancelJob API request.
func (r CancelJobRequest) Send(ctx context.Context) (*CancelJobResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &CancelJobResponse{
CancelJobOutput: r.Request.Data.(*CancelJobOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// CancelJobResponse is the response type for the
// CancelJob API operation.
type CancelJobResponse struct {
*CancelJobOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// CancelJob request.
func (r *CancelJobResponse) SDKResponseMetdata() *aws.Response {
return r.response
}