Blame - docs/dyn/gameservices_v1beta.projects.locations.realms.gameServerClusters.html - platform/external/python/google-api-python-client

2020-10-06 16:46:05 -0700

[diff] [blame^]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

81

<code><a href="#create">create(parent, body=None, gameServerClusterId=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Creates a new game server cluster in a given project and location.</p>

83

84

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

85

<p class="firstline">Deletes a single game server cluster.</p>

86

87

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

88

<p class="firstline">Gets details of a single game server cluster.</p>

89

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

90

<code><a href="#list">list(parent, pageToken=None, filter=None, orderBy=None, pageSize=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

91

<p class="firstline">Lists game server clusters in a given project and location.</p>

92

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

96

<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

97

<p class="firstline">Patches a single game server cluster.</p>

98

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

99

<code><a href="#previewCreate">previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, x__xgafv=None)</a></code></p>

100

<p class="firstline">Previews creation of a new game server cluster in a given project and location.</p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

101

102

<code><a href="#previewDelete">previewDelete(name, previewTime=None, x__xgafv=None)</a></code></p>

103

<p class="firstline">Previews deletion of a single game server cluster.</p>

104

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

105

<code><a href="#previewUpdate">previewUpdate(name, body=None, previewTime=None, updateMask=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

106

<p class="firstline">Previews updating a GameServerCluster.</p>

107

<h3>Method Details</h3>

108

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

109

<code class="details" id="close">close()</code>

110

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

114

<code class="details" id="create">create(parent, body=None, gameServerClusterId=None, x__xgafv=None)</code>

115

<pre>Creates a new game server cluster in a given project and location.

116

117

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

118

parent: string, Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}/realms/{realm-id}`. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

119

body: object, The request body.

120

The object takes the form of:

121

122

{ # A game server cluster resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

123

"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.

124

"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.

125

"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

126

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

127

"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

128

},

129

"name": "A String", # Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.

130

"updateTime": "A String", # Output only. The last-modified time.

131

"etag": "A String", # ETag of the resource.

132

"createTime": "A String", # Output only. The creation time.

133

"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.

134

"a_key": "A String",

135

},

136

"description": "A String", # Human readable description of the cluster.

137

}

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

138

139

gameServerClusterId: string, Required. The ID of the game server cluster resource to be created.

140

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

147

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

148

{ # This resource represents a long-running operation that is the result of a network API call.

149

"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.

150

"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`.

151

"a_key": "", # Properties of the object. Contains field @type with type URL.

152

},

153

"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.

154

"a_key": "", # Properties of the object. Contains field @type with type URL.

155

},

156

"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.

157

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

158

{

159

"a_key": "", # Properties of the object. Contains field @type with type URL.

160

},

161

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

162

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

163

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

164

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

165

"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}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

171

<pre>Deletes a single game server cluster.

172

173

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

174

name: string, Required. The name of the game server cluster to delete. Uses the form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

175

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

182

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

183

{ # This resource represents a long-running operation that is the result of a network API call.

184

"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.

185

"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`.

186

"a_key": "", # Properties of the object. Contains field @type with type URL.

187

},

188

"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.

189

"a_key": "", # Properties of the object. Contains field @type with type URL.

190

},

191

"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.

192

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

193

{

194

"a_key": "", # Properties of the object. Contains field @type with type URL.

195

},

196

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

197

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

198

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

199

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

200

"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}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

206

<pre>Gets details of a single game server cluster.

207

208

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

209

name: string, Required. The name of the game server cluster to retrieve. Uses the form: `projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

210

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

217

218

{ # A game server cluster resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

219

"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.

220

"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.

221

"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

222

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

223

"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

224

},

225

"name": "A String", # Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.

226

"updateTime": "A String", # Output only. The last-modified time.

227

"etag": "A String", # ETag of the resource.

228

"createTime": "A String", # Output only. The creation time.

229

"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.

230

"a_key": "A String",

231

},

232

"description": "A String", # Human readable description of the cluster.

233

}</pre>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

237

<code class="details" id="list">list(parent, pageToken=None, filter=None, orderBy=None, pageSize=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

238

<pre>Lists game server clusters in a given project and location.

239

240

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

241

parent: string, Required. The parent resource name. Uses the form: "projects/{project}/locations/{location}/realms/{realm}". (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

242

pageToken: string, Optional. The next_page_token value returned from a previous List request, if any.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

243

filter: string, Optional. The filter to apply to list results.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

244

orderBy: string, Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.

245

pageSize: integer, Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerClusters left to be queried.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

246

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

253

254

{ # Response message for GameServerClustersService.ListGameServerClusters.

255

"gameServerClusters": [ # The list of game server clusters.

256

{ # A game server cluster resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

257

"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.

258

"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.

259

"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

260

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

261

"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

262

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

263

"name": "A String", # Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.

264

"updateTime": "A String", # Output only. The last-modified time.

265

"etag": "A String", # ETag of the resource.

266

"createTime": "A String", # Output only. The creation time.

267

"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.

268

"a_key": "A String",

269

},

270

"description": "A String", # Human readable description of the cluster.

271

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

272

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

273

"unreachable": [ # List of locations that could not be reached.

274

"A String",

275

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

276

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

282

<pre>Retrieves the next page of results.

283

284

Args:

285

previous_request: The request for the previous page. (required)

286

previous_response: The response from the request for the previous page. (required)

287

288

Returns:

289

A request object that you can call 'execute()' on to request the next

290

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

296

<pre>Patches a single game server cluster.

297

298

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

299

name: string, Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

300

body: object, The request body.

301

The object takes the form of:

302

303

{ # A game server cluster resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

304

"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.

305

"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.

306

"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

307

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

308

"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

309

},

310

"name": "A String", # Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.

311

"updateTime": "A String", # Output only. The last-modified time.

312

"etag": "A String", # ETag of the resource.

313

"createTime": "A String", # Output only. The creation time.

314

"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.

315

"a_key": "A String",

316

},

317

"description": "A String", # Human readable description of the cluster.

318

}

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

319

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

320

updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

321

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

328

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

329

{ # This resource represents a long-running operation that is the result of a network API call.

330

"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.

331

"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`.

332

"a_key": "", # Properties of the object. Contains field @type with type URL.

333

},

334

"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.

335

"a_key": "", # Properties of the object. Contains field @type with type URL.

336

},

337

"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.

338

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

339

{

340

"a_key": "", # Properties of the object. Contains field @type with type URL.

341

},

342

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

343

"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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

344

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

345

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

346

"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}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

351

<code class="details" id="previewCreate">previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, x__xgafv=None)</code>

352

<pre>Previews creation of a new game server cluster in a given project and location.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

353

354

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

355

parent: string, Required. The parent resource name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}`. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

356

body: object, The request body.

357

The object takes the form of:

358

359

{ # A game server cluster resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

360

"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.

361

"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.

362

"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

363

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

364

"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

365

},

366

"name": "A String", # Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.

367

"updateTime": "A String", # Output only. The last-modified time.

368

"etag": "A String", # ETag of the resource.

369

"createTime": "A String", # Output only. The creation time.

370

"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.

371

"a_key": "A String",

372

},

373

"description": "A String", # Human readable description of the cluster.

374

}

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

375

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

376

gameServerClusterId: string, Required. The ID of the game server cluster resource to be created.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

377

previewTime: string, Optional. The target timestamp to compute the preview.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

378

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

385

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

386

{ # Response message for GameServerClustersService.PreviewCreateGameServerCluster.

387

"etag": "A String", # The ETag of the game server cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

388

"targetState": { # Encapsulates the Target state. # The target state.

389

"details": [ # Details about Agones fleets.

390

{ # Details about the Agones resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

391

"fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.

392

{ # Details of the target Agones fleet.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

393

"fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

394

"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.

395

"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.

396

"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

397

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

398

"name": "A String", # The name of the Agones fleet.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

399

},

400

"autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

401

"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.

402

"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.

403

"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

404

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

405

"name": "A String", # The name of the Agones autoscaler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

406

},

407

},

408

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

409

"gameServerDeploymentName": "A String", # The game server deployment name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.

410

"gameServerClusterName": "A String", # The game server cluster name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

}</pre>

</div>

<code class="details" id="previewDelete">previewDelete(name, previewTime=None, x__xgafv=None)</code>

419

<pre>Previews deletion of a single game server cluster.

420

421

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

422

name: string, Required. The name of the game server cluster to delete. Uses the form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

423

previewTime: string, Optional. The target timestamp to compute the preview.

424

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

431

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

432

{ # Response message for GameServerClustersService.PreviewDeleteGameServerCluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

433

"targetState": { # Encapsulates the Target state. # The target state.

434

"details": [ # Details about Agones fleets.

435

{ # Details about the Agones resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

436

"fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.

437

{ # Details of the target Agones fleet.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

438

"fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

439

"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.

440

"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.

441

"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

442

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

443

"name": "A String", # The name of the Agones fleet.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

444

},

445

"autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

446

"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.

447

"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.

448

"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

449

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

450

"name": "A String", # The name of the Agones autoscaler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

451

},

452

},

453

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

454

"gameServerDeploymentName": "A String", # The game server deployment name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.

455

"gameServerClusterName": "A String", # The game server cluster name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

456

},

457

],

458

},

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

459

"etag": "A String", # The ETag of the game server cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

464

<code class="details" id="previewUpdate">previewUpdate(name, body=None, previewTime=None, updateMask=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

465

<pre>Previews updating a GameServerCluster.

466

467

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

468

name: string, Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. (required)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

469

body: object, The request body.

470

The object takes the form of:

471

472

{ # A game server cluster resource.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

473

"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.

474

"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.

475

"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

476

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

477

"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.

478

},

479

"name": "A String", # Required. The resource name of the game server cluster. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.

480

"updateTime": "A String", # Output only. The last-modified time.

481

"etag": "A String", # ETag of the resource.

482

"createTime": "A String", # Output only. The creation time.

483

"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.

484

"a_key": "A String",

485

},

486

"description": "A String", # Human readable description of the cluster.

487

}

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

488

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

489

previewTime: string, Optional. The target timestamp to compute the preview.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

490

updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

491

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

498

499

{ # Response message for GameServerClustersService.PreviewUpdateGameServerCluster

500

"targetState": { # Encapsulates the Target state. # The target state.

501

"details": [ # Details about Agones fleets.

502

{ # Details about the Agones resources.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

503

"fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.

504

{ # Details of the target Agones fleet.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

505

"fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

506

"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.

507

"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.

508

"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

509

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

510

"name": "A String", # The name of the Agones fleet.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

511

},

512

"autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

513

"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.

514

"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.

515

"name": "A String", # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

516

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

517

"name": "A String", # The name of the Agones autoscaler.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

518

},

519

},

520

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

521

"gameServerDeploymentName": "A String", # The game server deployment name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.

522

"gameServerClusterName": "A String", # The game server cluster name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

523

},

524

],

525

},

Bu Sun Kim