-
Notifications
You must be signed in to change notification settings - Fork 604
/
api_op_StopMatchmaking.go
143 lines (120 loc) · 3.94 KB
/
api_op_StopMatchmaking.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 gamelift
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
)
// Represents the input for a request action.
type StopMatchmakingInput struct {
_ struct{} `type:"structure"`
// A unique identifier for a matchmaking ticket.
//
// TicketId is a required field
TicketId *string `type:"string" required:"true"`
}
// String returns the string representation
func (s StopMatchmakingInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *StopMatchmakingInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "StopMatchmakingInput"}
if s.TicketId == nil {
invalidParams.Add(aws.NewErrParamRequired("TicketId"))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
type StopMatchmakingOutput struct {
_ struct{} `type:"structure"`
}
// String returns the string representation
func (s StopMatchmakingOutput) String() string {
return awsutil.Prettify(s)
}
const opStopMatchmaking = "StopMatchmaking"
// StopMatchmakingRequest returns a request value for making API operation for
// Amazon GameLift.
//
// Cancels a matchmaking ticket or match backfill ticket that is currently being
// processed. To stop the matchmaking operation, specify the ticket ID. If successful,
// work on the ticket is stopped, and the ticket status is changed to CANCELLED.
//
// This call is also used to turn off automatic backfill for an individual game
// session. This is for game sessions that are created with a matchmaking configuration
// that has automatic backfill enabled. The ticket ID is included in the MatchmakerData
// of an updated game session object, which is provided to the game server.
//
// If the action is successful, the service sends back an empty JSON struct
// with the HTTP 200 response (not an empty HTTP body).
//
// Learn more
//
// Add FlexMatch to a Game Client (https://docs.aws.amazon.com/gamelift/latest/developerguide/match-client.html)
//
// Related operations
//
// * StartMatchmaking
//
// * DescribeMatchmaking
//
// * StopMatchmaking
//
// * AcceptMatch
//
// * StartMatchBackfill
//
// // Example sending a request using StopMatchmakingRequest.
// req := client.StopMatchmakingRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StopMatchmaking
func (c *Client) StopMatchmakingRequest(input *StopMatchmakingInput) StopMatchmakingRequest {
op := &aws.Operation{
Name: opStopMatchmaking,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &StopMatchmakingInput{}
}
req := c.newRequest(op, input, &StopMatchmakingOutput{})
return StopMatchmakingRequest{Request: req, Input: input, Copy: c.StopMatchmakingRequest}
}
// StopMatchmakingRequest is the request type for the
// StopMatchmaking API operation.
type StopMatchmakingRequest struct {
*aws.Request
Input *StopMatchmakingInput
Copy func(*StopMatchmakingInput) StopMatchmakingRequest
}
// Send marshals and sends the StopMatchmaking API request.
func (r StopMatchmakingRequest) Send(ctx context.Context) (*StopMatchmakingResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &StopMatchmakingResponse{
StopMatchmakingOutput: r.Request.Data.(*StopMatchmakingOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// StopMatchmakingResponse is the response type for the
// StopMatchmaking API operation.
type StopMatchmakingResponse struct {
*StopMatchmakingOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// StopMatchmaking request.
func (r *StopMatchmakingResponse) SDKResponseMetdata() *aws.Response {
return r.response
}