Blame - docs/dyn/gameservices_v1.projects.locations.realms.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></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="gameservices_v1.projects.locations.realms.gameServerClusters.html">gameServerClusters()</a></code>

79

</p>

80

<p class="firstline">Returns the gameServerClusters Resource.</p>

81

82

83

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

84

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

85

86

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

87

<p class="firstline">Deletes a single realm.</p>

88

89

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

90

<p class="firstline">Gets details of a single realm.</p>

91

92

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

93

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

94

95

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

96

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

97

98

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

99

<p class="firstline">Patches a single realm.</p>

100

101

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

102

<p class="firstline">Previews patches to a single realm.</p>

103

<h3>Method Details</h3>

104

105

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

106

<pre>Creates a new realm in a given project and location.

107

108

Args:

109

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

110

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

111

body: object, The request body.

112

The object takes the form of:

113

114

{ # A realm resource.

115

"name": "A String", # The resource name of the realm. Uses the form:

116

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

117

# example, `projects/my-project/locations/{location}/realms/my-realm`.

118

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

119

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

120

"timeZone": "A String", # Required. Time zone where all policies targeting this realm are evaluated. The value

121

# of this field must be from the IANA time zone database:

122

# https://www.iana.org/time-zones.

123

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

124

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

125

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

"a_key": "A String",

},

}

realmId: string, Required. The ID of the realm resource to be created.

131

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

138

139

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

140

# network API call.

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

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

149

},

150

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

151

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

152

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

153

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

154

#

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

# message types for APIs to use.

163

{

164

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

169

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

170

# available.

171

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

172

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

173

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

174

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

175

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

176

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

177

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

178

# `TakeSnapshotResponse`.

179

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

186

<pre>Deletes a single realm.

Args:

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

191

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

198

199

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

200

# network API call.

201

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

202

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

203

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

204

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

205

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

206

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

207

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

208

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

209

},

210

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

211

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

212

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

213

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

214

#

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

# message types for APIs to use.

223

{

224

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

229

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

230

# available.

231

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

232

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

233

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

234

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

235

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

236

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

237

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

238

# `TakeSnapshotResponse`.

239

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

246

<pre>Gets details of a single realm.

Args:

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

251

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

258

259

{ # A realm resource.

260

"name": "A String", # The resource name of the realm. Uses the form:

261

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

262

# example, `projects/my-project/locations/{location}/realms/my-realm`.

263

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

264

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

265

"timeZone": "A String", # Required. Time zone where all policies targeting this realm are evaluated. The value

266

# of this field must be from the IANA time zone database:

267

# https://www.iana.org/time-zones.

268

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

269

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

270

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

"a_key": "A String",

},

}</pre>

</div>

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

278

<pre>Lists realms in a given project and location.

279

280

Args:

281

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

282

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

283

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

284

if any.

285

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

286

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

287

will pick an appropriate default. Server may return fewer items than

288

requested. A caller should only rely on response's

289

next_page_token to

290

determine if there are more realms left to be queried.

291

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

292

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

293

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

300

301

{ # Response message for RealmsService.ListRealms.

302

"realms": [ # The list of realms.

303

{ # A realm resource.

304

"name": "A String", # The resource name of the realm. Uses the form:

305

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

306

# example, `projects/my-project/locations/{location}/realms/my-realm`.

307

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

308

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

309

"timeZone": "A String", # Required. Time zone where all policies targeting this realm are evaluated. The value

310

# of this field must be from the IANA time zone database:

311

# https://www.iana.org/time-zones.

312

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

313

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

314

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

"a_key": "A String",

},

},

],

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

320

"A String",

321

],

322

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

323

# results in the list.

}</pre>

</div>

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

329

<pre>Retrieves the next page of results.

330

331

Args:

332

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

333

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

334

335

Returns:

336

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

337

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>

343

<pre>Patches a single realm.

Args:

`projects/{project}/locations/{location}/realms/{realm}`. For

348

example, `projects/my-project/locations/{location}/realms/my-realm`. (required)

349

body: object, The request body.

350

The object takes the form of:

351

352

{ # A realm resource.

353

"name": "A String", # The resource name of the realm. Uses the form:

354

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

355

# example, `projects/my-project/locations/{location}/realms/my-realm`.

356

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

357

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

358

"timeZone": "A String", # Required. Time zone where all policies targeting this realm are evaluated. The value

359

# of this field must be from the IANA time zone database:

360

# https://www.iana.org/time-zones.

361

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

362

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

363

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

"a_key": "A String",

},

}

updateMask: string, Required. The update mask applies to the resource. For the `FieldMask`

definition, see

https:

//developers.google.com/protocol-buffers

373

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

374

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

381

382

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

383

# network API call.

384

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

385

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

386

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

387

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

388

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

389

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

390

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

391

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

392

},

393

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

394

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

395

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

396

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

397

#

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

# message types for APIs to use.

406

{

407

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

412

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

413

# available.

414

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

415

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

416

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

417

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

418

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

419

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

420

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

421

# `TakeSnapshotResponse`.

422

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

},

}</pre>

</div>

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

429

<pre>Previews patches to a single realm.

Args:

`projects/{project}/locations/{location}/realms/{realm}`. For

434

example, `projects/my-project/locations/{location}/realms/my-realm`. (required)

435

body: object, The request body.

436

The object takes the form of:

437

438

{ # A realm resource.

439

"name": "A String", # The resource name of the realm. Uses the form:

440

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

441

# example, `projects/my-project/locations/{location}/realms/my-realm`.

442

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

443

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

444

"timeZone": "A String", # Required. Time zone where all policies targeting this realm are evaluated. The value

445

# of this field must be from the IANA time zone database:

446

# https://www.iana.org/time-zones.

447

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

448

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

449

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

"a_key": "A String",

},

}

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

455

updateMask: string, Required. The update mask applies to the resource. For the `FieldMask`

definition, see

https:

//developers.google.com/protocol-buffers

460

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

461

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

468

469

{ # Response message for RealmsService.PreviewRealmUpdate.

470

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

471

"details": [ # Details about Agones fleets.

472

{ # Details about the Agones resources.

473

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

474

#

475

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

476

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

477

#

478

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

479

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

480

{ # Details of the target Agones fleet.

481

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

482

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

483

# Details about the Agones autoscaler spec.

484

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

485

#

486

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

487

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

488

# the Agones fleet or Agones autoscaler spec.

489

},

490

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

491

},

492

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

493

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

494

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

495

# The Agones fleet spec source.

496

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

497

#

498

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

499

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

500

# the Agones fleet or Agones autoscaler spec.

},

},

},

],

},

],

},

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

}</pre>

</div>

</body></html>