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

<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.realms.html">realms</a> . <a href="gameservices_v1.projects.locations.realms.gameServerClusters.html">gameServerClusters</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

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

80

81

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

82

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

83

84

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

85

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

86

87

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

88

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

89

90

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

91

<p class="firstline">Retrieves the next page of results.</p>

92

93

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

94

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

95

96

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

97

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

98

99

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

100

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

101

102

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

103

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

104

<h3>Method Details</h3>

105

106

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

107

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

108

109

Args:

110

parent: string, Required. The parent resource name. Uses the form:

111

`projects/{project}/locations/{location}/realms/{realm-id}`. (required)

112

body: object, The request body.

113

The object takes the form of:

114

115

{ # A game server cluster resource.

116

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

117

"name": "A String", # Required. The resource name of the game server cluster. Uses the form:

118

#

119

# `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.

120

# For example,

121

#

122

# `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.

123

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

# key-value pair.

"a_key": "A String",

},

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

128

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

129

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

130

# manage game server clusters.

131

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

132

"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following

133

# forms:

134

# * `projects/{project}/locations/{location}/clusters/{cluster}`

135

# * `locations/{location}/clusters/{cluster}`

136

# * `{cluster}`

137

# If project and location are not specified, the project and location of the

138

# GameServerCluster resource are used to generate the full name of the

139

# GKE cluster.

140

},

141

"namespace": "A String", # Namespace designated on the game server cluster where the Agones game

142

# server instances will be created. Existence of the namespace will be

143

# validated during creation.

144

},

145

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

146

}

147

148

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

149

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

156

157

{ # This resource represents a long-running operation that is the result of a

158

# network API call.

159

"name": "A String", # The server-assigned name, which is only unique within the same service that

160

# originally returns it. If you use the default HTTP mapping, the

161

# `name` should be a resource name ending with `operations/{unique_id}`.

162

"metadata": { # Service-specific metadata associated with the operation. It typically

163

# contains progress information and common metadata such as create time.

164

# Some services might not provide such metadata. Any method that returns a

165

# long-running operation should document the metadata type, if any.

166

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

167

},

168

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

169

# different programming environments, including REST APIs and RPC APIs. It is

170

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

171

# three pieces of data: error code, error message, and error details.

172

#

173

# You can find out more about this error model and how to work with it in the

174

# [API Design Guide](https://cloud.google.com/apis/design/errors).

175

"message": "A String", # A developer-facing error message, which should be in English. Any

176

# user-facing error message should be localized and sent in the

177

# google.rpc.Status.details field, or localized by the client.

178

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

179

"details": [ # A list of messages that carry the error details. There is a common set of

180

# message types for APIs to use.

181

{

182

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

},

],

},

"done": True or False, # If the value is `false`, it means the operation is still in progress.

187

# If `true`, the operation is completed, and either `error` or `response` is

188

# available.

189

"response": { # The normal response of the operation in case of success. If the original

190

# method returns no data on success, such as `Delete`, the response is

191

# `google.protobuf.Empty`. If the original method is standard

192

# `Get`/`Create`/`Update`, the response should be the resource. For other

193

# methods, the response should have the type `XxxResponse`, where `Xxx`

194

# is the original method name. For example, if the original method name

195

# is `TakeSnapshot()`, the inferred response type is

196

# `TakeSnapshotResponse`.

197

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

},

}</pre>

</div>

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

204

<pre>Deletes a single game server cluster.

205

206

Args:

207

name: string, Required. The name of the game server cluster to delete. Uses the form:

208

`projects/{project}/locations/{location}/gameServerClusters/{cluster}`. (required)

209

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

216

217

{ # This resource represents a long-running operation that is the result of a

218

# network API call.

219

"name": "A String", # The server-assigned name, which is only unique within the same service that

220

# originally returns it. If you use the default HTTP mapping, the

221

# `name` should be a resource name ending with `operations/{unique_id}`.

222

"metadata": { # Service-specific metadata associated with the operation. It typically

223

# contains progress information and common metadata such as create time.

224

# Some services might not provide such metadata. Any method that returns a

225

# long-running operation should document the metadata type, if any.

226

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

227

},

228

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

229

# different programming environments, including REST APIs and RPC APIs. It is

230

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

231

# three pieces of data: error code, error message, and error details.

232

#

233

# You can find out more about this error model and how to work with it in the

234

# [API Design Guide](https://cloud.google.com/apis/design/errors).

235

"message": "A String", # A developer-facing error message, which should be in English. Any

236

# user-facing error message should be localized and sent in the

237

# google.rpc.Status.details field, or localized by the client.

238

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

239

"details": [ # A list of messages that carry the error details. There is a common set of

240

# message types for APIs to use.

241

{

242

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

},

],

},

"done": True or False, # If the value is `false`, it means the operation is still in progress.

247

# If `true`, the operation is completed, and either `error` or `response` is

248

# available.

249

"response": { # The normal response of the operation in case of success. If the original

250

# method returns no data on success, such as `Delete`, the response is

251

# `google.protobuf.Empty`. If the original method is standard

252

# `Get`/`Create`/`Update`, the response should be the resource. For other

253

# methods, the response should have the type `XxxResponse`, where `Xxx`

254

# is the original method name. For example, if the original method name

255

# is `TakeSnapshot()`, the inferred response type is

256

# `TakeSnapshotResponse`.

257

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

},

}</pre>

</div>

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

264

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

265

266

Args:

267

name: string, Required. The name of the game server cluster to retrieve. Uses the form:

268

269

`projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`. (required)

270

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

277

278

{ # A game server cluster resource.

279

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

280

"name": "A String", # Required. The resource name of the game server cluster. Uses the form:

281

#

282

# `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.

283

# For example,

284

#

285

# `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.

286

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

# key-value pair.

"a_key": "A String",

},

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

291

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

292

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

293

# manage game server clusters.

294

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

295

"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following

296

# forms:

297

# * `projects/{project}/locations/{location}/clusters/{cluster}`

298

# * `locations/{location}/clusters/{cluster}`

299

# * `{cluster}`

300

# If project and location are not specified, the project and location of the

301

# GameServerCluster resource are used to generate the full name of the

302

# GKE cluster.

303

},

304

"namespace": "A String", # Namespace designated on the game server cluster where the Agones game

305

# server instances will be created. Existence of the namespace will be

306

# validated during creation.

307

},

308

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

}</pre>

</div>

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

314

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

315

316

Args:

317

parent: string, Required. The parent resource name. Uses the form:

318

"projects/{project}/locations/{location}/realms/{realm}". (required)

319

orderBy: string, Optional. Specifies the ordering of results following syntax at

320

https://cloud.google.com/apis/design/design_patterns#sorting_order.

321

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

322

pageSize: integer, Optional. The maximum number of items to return. If unspecified, the server

323

will pick an appropriate default. The server may return fewer items than

324

requested. A caller should only rely on response's

325

next_page_token to

326

determine if there are more GameServerClusters left to be queried.

327

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

328

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

335

336

{ # Response message for GameServerClustersService.ListGameServerClusters.

337

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

338

"A String",

339

],

340

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

341

# results in the list.

342

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

343

{ # A game server cluster resource.

344

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

345

"name": "A String", # Required. The resource name of the game server cluster. Uses the form:

346

#

347

# `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.

348

# For example,

349

#

350

# `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.

351

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

# key-value pair.

"a_key": "A String",

},

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

356

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

357

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

358

# manage game server clusters.

359

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

360

"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following

361

# forms:

362

# * `projects/{project}/locations/{location}/clusters/{cluster}`

363

# * `locations/{location}/clusters/{cluster}`

364

# * `{cluster}`

365

# If project and location are not specified, the project and location of the

366

# GameServerCluster resource are used to generate the full name of the

367

# GKE cluster.

368

},

369

"namespace": "A String", # Namespace designated on the game server cluster where the Agones game

370

# server instances will be created. Existence of the namespace will be

371

# validated during creation.

372

},

373

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

},

],

}</pre>

</div>

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

381

<pre>Retrieves the next page of results.

382

383

Args:

384

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

385

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

386

387

Returns:

388

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

389

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>

395

<pre>Patches a single game server cluster.

396

397

Args:

398

name: string, Required. The resource name of the game server cluster. Uses the form:

399

400

`projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.

401

For example,

402

403

`projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. (required)

404

body: object, The request body.

405

The object takes the form of:

406

407

{ # A game server cluster resource.

408

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

409

"name": "A String", # Required. The resource name of the game server cluster. Uses the form:

410

#

411

# `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.

412

# For example,

413

#

414

# `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.

415

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

# key-value pair.

"a_key": "A String",

},

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

420

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

421

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

422

# manage game server clusters.

423

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

424

"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following

425

# forms:

426

# * `projects/{project}/locations/{location}/clusters/{cluster}`

427

# * `locations/{location}/clusters/{cluster}`

428

# * `{cluster}`

429

# If project and location are not specified, the project and location of the

430

# GameServerCluster resource are used to generate the full name of the

431

# GKE cluster.

432

},

433

"namespace": "A String", # Namespace designated on the game server cluster where the Agones game

434

# server instances will be created. Existence of the namespace will be

435

# validated during creation.

436

},

437

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

438

}

439

440

updateMask: string, Required. Mask of fields to update. At least one path must be supplied in

441

this field. For the `FieldMask` definition, see

442

443

https:

444

//developers.google.com/protocol-buffers

445

// /docs/reference/google.protobuf#fieldmask

446

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

453

454

{ # This resource represents a long-running operation that is the result of a

455

# network API call.

456

"name": "A String", # The server-assigned name, which is only unique within the same service that

457

# originally returns it. If you use the default HTTP mapping, the

458

# `name` should be a resource name ending with `operations/{unique_id}`.

459

"metadata": { # Service-specific metadata associated with the operation. It typically

460

# contains progress information and common metadata such as create time.

461

# Some services might not provide such metadata. Any method that returns a

462

# long-running operation should document the metadata type, if any.

463

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

464

},

465

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

466

# different programming environments, including REST APIs and RPC APIs. It is

467

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

468

# three pieces of data: error code, error message, and error details.

469

#

470

# You can find out more about this error model and how to work with it in the

471

# [API Design Guide](https://cloud.google.com/apis/design/errors).

472

"message": "A String", # A developer-facing error message, which should be in English. Any

473

# user-facing error message should be localized and sent in the

474

# google.rpc.Status.details field, or localized by the client.

475

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

476

"details": [ # A list of messages that carry the error details. There is a common set of

477

# message types for APIs to use.

478

{

479

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

},

],

},

"done": True or False, # If the value is `false`, it means the operation is still in progress.

484

# If `true`, the operation is completed, and either `error` or `response` is

485

# available.

486

"response": { # The normal response of the operation in case of success. If the original

487

# method returns no data on success, such as `Delete`, the response is

488

# `google.protobuf.Empty`. If the original method is standard

489

# `Get`/`Create`/`Update`, the response should be the resource. For other

490

# methods, the response should have the type `XxxResponse`, where `Xxx`

491

# is the original method name. For example, if the original method name

492

# is `TakeSnapshot()`, the inferred response type is

493

# `TakeSnapshotResponse`.

494

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

},

}</pre>

</div>

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

501

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

location.

Args:

parent: string, Required. The parent resource name. Uses the form:

506

`projects/{project}/locations/{location}/realms/{realm}`. (required)

507

body: object, The request body.

508

The object takes the form of:

509

510

{ # A game server cluster resource.

511

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

512

"name": "A String", # Required. The resource name of the game server cluster. Uses the form:

513

#

514

# `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.

515

# For example,

516

#

517

# `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.

518

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

# key-value pair.

"a_key": "A String",

},

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

523

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

524

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

525

# manage game server clusters.

526

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

527

"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following

528

# forms:

529

# * `projects/{project}/locations/{location}/clusters/{cluster}`

530

# * `locations/{location}/clusters/{cluster}`

531

# * `{cluster}`

532

# If project and location are not specified, the project and location of the

533

# GameServerCluster resource are used to generate the full name of the

534

# GKE cluster.

535

},

536

"namespace": "A String", # Namespace designated on the game server cluster where the Agones game

537

# server instances will be created. Existence of the namespace will be

538

# validated during creation.

539

},

540

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

541

}

542

543

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

544

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

545

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

552

553

{ # Response message for

554

# GameServerClustersService.PreviewCreateGameServerCluster.

555

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

556

"details": [ # Details about Agones fleets.

557

{ # Details about the Agones resources.

558

"gameServerDeploymentName": "A String", # The game server deployment name. Uses the form:

559

#

560

# `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.

561

"gameServerClusterName": "A String", # The game server cluster name. Uses the form:

562

#

563

# `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.

564

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

565

{ # Details of the target Agones fleet.

566

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

567

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

568

# Details about the Agones autoscaler spec.

569

"gameServerConfigName": "A String", # The game server config resource. Uses the form:

570

#

571

# `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.

572

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

573

# the Agones fleet or Agones autoscaler spec.

574

},

575

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

576

},

577

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

578

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

579

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

580

# The Agones fleet spec source.

581

"gameServerConfigName": "A String", # The game server config resource. Uses the form:

582

#

583

# `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.

584

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

585

# the Agones fleet or Agones autoscaler spec.

},

},

},

],

},

],

},

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

}</pre>

</div>

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

599

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

600

601

Args:

602

name: string, Required. The name of the game server cluster to delete. Uses the form:

603

`projects/{project}/locations/{location}/gameServerClusters/{cluster}`. (required)

604

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

605

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

612

613

{ # Response message for

614

# GameServerClustersService.PreviewDeleteGameServerCluster.

615

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

616

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

617

"details": [ # Details about Agones fleets.

618

{ # Details about the Agones resources.

619

"gameServerDeploymentName": "A String", # The game server deployment name. Uses the form:

620

#

621

# `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.

622

"gameServerClusterName": "A String", # The game server cluster name. Uses the form:

623

#

624

# `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.

625

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

626

{ # Details of the target Agones fleet.

627

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

628

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

629

# Details about the Agones autoscaler spec.

630

"gameServerConfigName": "A String", # The game server config resource. Uses the form:

631

#

632

# `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.

633

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

634

# the Agones fleet or Agones autoscaler spec.

635

},

636

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

637

},

638

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

639

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

640

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

641

# The Agones fleet spec source.

642

"gameServerConfigName": "A String", # The game server config resource. Uses the form:

643

#

644

# `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.

645

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

646

# the Agones fleet or Agones autoscaler spec.

},

},

},

],

},

],

},

}</pre>

</div>

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

659

<pre>Previews updating a GameServerCluster.

660

661

Args:

662

name: string, Required. The resource name of the game server cluster. Uses the form:

663

664

`projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.

665

For example,

666

667

`projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. (required)

668

body: object, The request body.

669

The object takes the form of:

670

671

{ # A game server cluster resource.

672

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

673

"name": "A String", # Required. The resource name of the game server cluster. Uses the form:

674

#

675

# `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.

676

# For example,

677

#

678

# `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.

679

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

# key-value pair.

"a_key": "A String",

},

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

684

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

685

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

686

# manage game server clusters.

687

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

688

"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following

689

# forms:

690

# * `projects/{project}/locations/{location}/clusters/{cluster}`

691

# * `locations/{location}/clusters/{cluster}`

692

# * `{cluster}`

693

# If project and location are not specified, the project and location of the

694

# GameServerCluster resource are used to generate the full name of the

695

# GKE cluster.

696

},

697

"namespace": "A String", # Namespace designated on the game server cluster where the Agones game

698

# server instances will be created. Existence of the namespace will be

699

# validated during creation.

700

},

701

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

702

}

703

704

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

705

updateMask: string, Required. Mask of fields to update. At least one path must be supplied in

706

this field. For the `FieldMask` definition, see

707

708

https:

709

//developers.google.com/protocol-buffers

710

// /docs/reference/google.protobuf#fieldmask

711

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

718

719

{ # Response message for GameServerClustersService.PreviewUpdateGameServerCluster

720

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

721

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

722

"details": [ # Details about Agones fleets.

723

{ # Details about the Agones resources.

724

"gameServerDeploymentName": "A String", # The game server deployment name. Uses the form:

725

#

726

# `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.

727

"gameServerClusterName": "A String", # The game server cluster name. Uses the form:

728

#

729

# `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.

730

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

731

{ # Details of the target Agones fleet.

732

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

733

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

734

# Details about the Agones autoscaler spec.

735

"gameServerConfigName": "A String", # The game server config resource. Uses the form:

736

#

737

# `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.

738

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

739

# the Agones fleet or Agones autoscaler spec.

740

},

741

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

742

},

743

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

744

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

745

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

746

# The Agones fleet spec source.

747

"gameServerConfigName": "A String", # The game server config resource. Uses the form:

748

#

749

# `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.

750

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

751

# the Agones fleet or Agones autoscaler spec.

},

},

},

],

},

],

},

}</pre>

</div>

</body></html>