1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="gameservices_v1.html">Game Services API</a> . <a href="gameservices_v1.projects.html">projects</a> . <a href="gameservices_v1.projects.locations.html">locations</a> . <a href="gameservices_v1.projects.locations.gameServerDeployments.html">gameServerDeployments</a> . <a href="gameservices_v1.projects.locations.gameServerDeployments.configs.html">configs</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, configId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets details of a single game server config.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists game server configs in a given project, location, and game server deployment.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="create">create(parent, body=None, configId=None, x__xgafv=None)</code> 103 <pre>Creates a new game server config in a given project, location, and game server deployment. Game server configs are immutable, and are not applied until referenced in the game server deployment rollout resource. 104 105Args: 106 parent: string, Required. The parent resource name, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/`. (required) 107 body: object, The request body. 108 The object takes the form of: 109 110{ # A game server config resource. 111 "createTime": "A String", # Output only. The creation time. 112 "description": "A String", # The description of the game server config. 113 "fleetConfigs": [ # FleetConfig contains a list of Agones fleet specs. Only one FleetConfig is allowed. 114 { # Fleet configs for Agones. 115 "fleetSpec": "A String", # Agones fleet spec. Example spec: `https://agones.dev/site/docs/reference/fleet/`. 116 "name": "A String", # The name of the FleetConfig. 117 }, 118 ], 119 "labels": { # The labels associated with this game server config. Each label is a key-value pair. 120 "a_key": "A String", 121 }, 122 "name": "A String", # The resource name of the game server config, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`. 123 "scalingConfigs": [ # The autoscaling settings. 124 { # Autoscaling config for an Agones fleet. 125 "fleetAutoscalerSpec": "A String", # Required. Agones fleet autoscaler spec. Example spec: https://agones.dev/site/docs/reference/fleetautoscaler/ 126 "name": "A String", # Required. The name of the Scaling Config 127 "schedules": [ # The schedules to which this Scaling Config applies. 128 { # The schedule of a recurring or one time event. The event's time span is specified by start_time and end_time. If the scheduled event's timespan is larger than the cron_spec + cron_job_duration, the event will be recurring. If only cron_spec + cron_job_duration are specified, the event is effective starting at the local time specified by cron_spec, and is recurring. ``` start_time|-------[cron job]-------[cron job]-------[cron job]---|end_time cron job: cron spec start time + duration ``` 129 "cronJobDuration": "A String", # The duration for the cron job event. The duration of the event is effective after the cron job's start time. 130 "cronSpec": "A String", # The cron definition of the scheduled event. See https://en.wikipedia.org/wiki/Cron. Cron spec specifies the local time as defined by the realm. 131 "endTime": "A String", # The end time of the event. 132 "startTime": "A String", # The start time of the event. 133 }, 134 ], 135 "selectors": [ # Labels used to identify the game server clusters to which this Agones scaling config applies. A game server cluster is subject to this Agones scaling config if its labels match any of the selector entries. 136 { # The label selector, used to group labels on the resources. 137 "labels": { # Resource labels for this selector. 138 "a_key": "A String", 139 }, 140 }, 141 ], 142 }, 143 ], 144 "updateTime": "A String", # Output only. The last-modified time. 145} 146 147 configId: string, Required. The ID of the game server config resource to be created. 148 x__xgafv: string, V1 error format. 149 Allowed values 150 1 - v1 error format 151 2 - v2 error format 152 153Returns: 154 An object of the form: 155 156 { # This resource represents a long-running operation that is the result of a network API call. 157 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 158 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 159 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 160 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 161 { 162 "a_key": "", # Properties of the object. Contains field @type with type URL. 163 }, 164 ], 165 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 166 }, 167 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 168 "a_key": "", # Properties of the object. Contains field @type with type URL. 169 }, 170 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 171 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 172 "a_key": "", # Properties of the object. Contains field @type with type URL. 173 }, 174}</pre> 175</div> 176 177<div class="method"> 178 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 179 <pre>Deletes a single game server config. The deletion will fail if the game server config is referenced in a game server deployment rollout. 180 181Args: 182 name: string, Required. The name of the game server config to delete, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. (required) 183 x__xgafv: string, V1 error format. 184 Allowed values 185 1 - v1 error format 186 2 - v2 error format 187 188Returns: 189 An object of the form: 190 191 { # This resource represents a long-running operation that is the result of a network API call. 192 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 193 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 194 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 195 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 196 { 197 "a_key": "", # Properties of the object. Contains field @type with type URL. 198 }, 199 ], 200 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 201 }, 202 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 203 "a_key": "", # Properties of the object. Contains field @type with type URL. 204 }, 205 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 206 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 207 "a_key": "", # Properties of the object. Contains field @type with type URL. 208 }, 209}</pre> 210</div> 211 212<div class="method"> 213 <code class="details" id="get">get(name, x__xgafv=None)</code> 214 <pre>Gets details of a single game server config. 215 216Args: 217 name: string, Required. The name of the game server config to retrieve, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. (required) 218 x__xgafv: string, V1 error format. 219 Allowed values 220 1 - v1 error format 221 2 - v2 error format 222 223Returns: 224 An object of the form: 225 226 { # A game server config resource. 227 "createTime": "A String", # Output only. The creation time. 228 "description": "A String", # The description of the game server config. 229 "fleetConfigs": [ # FleetConfig contains a list of Agones fleet specs. Only one FleetConfig is allowed. 230 { # Fleet configs for Agones. 231 "fleetSpec": "A String", # Agones fleet spec. Example spec: `https://agones.dev/site/docs/reference/fleet/`. 232 "name": "A String", # The name of the FleetConfig. 233 }, 234 ], 235 "labels": { # The labels associated with this game server config. Each label is a key-value pair. 236 "a_key": "A String", 237 }, 238 "name": "A String", # The resource name of the game server config, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`. 239 "scalingConfigs": [ # The autoscaling settings. 240 { # Autoscaling config for an Agones fleet. 241 "fleetAutoscalerSpec": "A String", # Required. Agones fleet autoscaler spec. Example spec: https://agones.dev/site/docs/reference/fleetautoscaler/ 242 "name": "A String", # Required. The name of the Scaling Config 243 "schedules": [ # The schedules to which this Scaling Config applies. 244 { # The schedule of a recurring or one time event. The event's time span is specified by start_time and end_time. If the scheduled event's timespan is larger than the cron_spec + cron_job_duration, the event will be recurring. If only cron_spec + cron_job_duration are specified, the event is effective starting at the local time specified by cron_spec, and is recurring. ``` start_time|-------[cron job]-------[cron job]-------[cron job]---|end_time cron job: cron spec start time + duration ``` 245 "cronJobDuration": "A String", # The duration for the cron job event. The duration of the event is effective after the cron job's start time. 246 "cronSpec": "A String", # The cron definition of the scheduled event. See https://en.wikipedia.org/wiki/Cron. Cron spec specifies the local time as defined by the realm. 247 "endTime": "A String", # The end time of the event. 248 "startTime": "A String", # The start time of the event. 249 }, 250 ], 251 "selectors": [ # Labels used to identify the game server clusters to which this Agones scaling config applies. A game server cluster is subject to this Agones scaling config if its labels match any of the selector entries. 252 { # The label selector, used to group labels on the resources. 253 "labels": { # Resource labels for this selector. 254 "a_key": "A String", 255 }, 256 }, 257 ], 258 }, 259 ], 260 "updateTime": "A String", # Output only. The last-modified time. 261}</pre> 262</div> 263 264<div class="method"> 265 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 266 <pre>Lists game server configs in a given project, location, and game server deployment. 267 268Args: 269 parent: string, Required. The parent resource name, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/*`. (required) 270 filter: string, Optional. The filter to apply to list results. 271 orderBy: string, Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order. 272 pageSize: integer, Optional. The maximum number of items to return. If unspecified, server will pick an appropriate default. Server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerConfigs left to be queried. 273 pageToken: string, Optional. The next_page_token value returned from a previous list request, if any. 274 x__xgafv: string, V1 error format. 275 Allowed values 276 1 - v1 error format 277 2 - v2 error format 278 279Returns: 280 An object of the form: 281 282 { # Response message for GameServerConfigsService.ListGameServerConfigs. 283 "gameServerConfigs": [ # The list of game server configs. 284 { # A game server config resource. 285 "createTime": "A String", # Output only. The creation time. 286 "description": "A String", # The description of the game server config. 287 "fleetConfigs": [ # FleetConfig contains a list of Agones fleet specs. Only one FleetConfig is allowed. 288 { # Fleet configs for Agones. 289 "fleetSpec": "A String", # Agones fleet spec. Example spec: `https://agones.dev/site/docs/reference/fleet/`. 290 "name": "A String", # The name of the FleetConfig. 291 }, 292 ], 293 "labels": { # The labels associated with this game server config. Each label is a key-value pair. 294 "a_key": "A String", 295 }, 296 "name": "A String", # The resource name of the game server config, in the following form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`. For example, `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`. 297 "scalingConfigs": [ # The autoscaling settings. 298 { # Autoscaling config for an Agones fleet. 299 "fleetAutoscalerSpec": "A String", # Required. Agones fleet autoscaler spec. Example spec: https://agones.dev/site/docs/reference/fleetautoscaler/ 300 "name": "A String", # Required. The name of the Scaling Config 301 "schedules": [ # The schedules to which this Scaling Config applies. 302 { # The schedule of a recurring or one time event. The event's time span is specified by start_time and end_time. If the scheduled event's timespan is larger than the cron_spec + cron_job_duration, the event will be recurring. If only cron_spec + cron_job_duration are specified, the event is effective starting at the local time specified by cron_spec, and is recurring. ``` start_time|-------[cron job]-------[cron job]-------[cron job]---|end_time cron job: cron spec start time + duration ``` 303 "cronJobDuration": "A String", # The duration for the cron job event. The duration of the event is effective after the cron job's start time. 304 "cronSpec": "A String", # The cron definition of the scheduled event. See https://en.wikipedia.org/wiki/Cron. Cron spec specifies the local time as defined by the realm. 305 "endTime": "A String", # The end time of the event. 306 "startTime": "A String", # The start time of the event. 307 }, 308 ], 309 "selectors": [ # Labels used to identify the game server clusters to which this Agones scaling config applies. A game server cluster is subject to this Agones scaling config if its labels match any of the selector entries. 310 { # The label selector, used to group labels on the resources. 311 "labels": { # Resource labels for this selector. 312 "a_key": "A String", 313 }, 314 }, 315 ], 316 }, 317 ], 318 "updateTime": "A String", # Output only. The last-modified time. 319 }, 320 ], 321 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. 322 "unreachable": [ # List of locations that could not be reached. 323 "A String", 324 ], 325}</pre> 326</div> 327 328<div class="method"> 329 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 330 <pre>Retrieves the next page of results. 331 332Args: 333 previous_request: The request for the previous page. (required) 334 previous_response: The response from the request for the previous page. (required) 335 336Returns: 337 A request object that you can call 'execute()' on to request the next 338 page. Returns None if there are no more items in the collection. 339 </pre> 340</div> 341 342</body></html>