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

<h1><a href="gameservices_v1beta.html">Game Services API</a> . <a href="gameservices_v1beta.projects.html">projects</a> . <a href="gameservices_v1beta.projects.locations.html">locations</a> . <a href="gameservices_v1beta.projects.locations.realms.html">realms</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="gameservices_v1beta.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, filter=None, pageToken=None, orderBy=None, pageSize=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, updateMask=None, previewTime=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

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

116

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

117

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

118

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

119

"a_key": "A String",

120

},

121

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

122

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

123

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

124

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

125

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

126

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

127

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

128

}

129

130

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

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

142

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

143

# available.

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

# `TakeSnapshotResponse`.

152

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

153

},

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

#

162

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

163

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

164

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

165

# message types for APIs to use.

166

{

167

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

168

},

169

],

170

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

171

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

172

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

173

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

174

},

175

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

176

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

177

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

178

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

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

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

202

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

203

# available.

204

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

205

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

206

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

207

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

208

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

209

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

210

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

211

# `TakeSnapshotResponse`.

212

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

213

},

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

#

222

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

223

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

224

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

225

# message types for APIs to use.

226

{

227

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

228

},

229

],

230

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

231

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

232

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

233

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

234

},

235

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

236

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

237

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

238

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

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

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

261

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

262

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

263

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

264

"a_key": "A String",

265

},

266

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

267

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

268

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

269

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

270

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

271

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

272

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

}</pre>

</div>

<code class="details" id="list">list(parent, filter=None, pageToken=None, orderBy=None, pageSize=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

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

284

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

285

if any.

286

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

287

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

288

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

289

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

290

requested. A caller should only rely on response's

291

next_page_token to

292

determine if there are more realms left to be queried.

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

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

303

# results in the list.

304

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

305

"A String",

306

],

307

"realms": [ # The list of realms.

308

{ # A realm resource.

309

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

310

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

311

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

312

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

313

"a_key": "A String",

314

},

315

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

316

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

317

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

318

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

319

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

320

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

321

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

},

],

}</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

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

354

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

355

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

356

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

357

"a_key": "A String",

358

},

359

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

360

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

361

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

362

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

363

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

364

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

365

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

366

}

367

368

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

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

385

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

386

# available.

387

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

388

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

389

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

390

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

391

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

392

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

393

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

394

# `TakeSnapshotResponse`.

395

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

396

},

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

#

405

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

406

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

407

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

408

# message types for APIs to use.

409

{

410

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

411

},

412

],

413

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

414

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

415

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

416

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

417

},

418

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

419

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

420

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

421

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

422

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

},

}</pre>

</div>

<code class="details" id="previewUpdate">previewUpdate(name, body=None, updateMask=None, previewTime=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

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

440

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

441

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

442

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

443

"a_key": "A String",

444

},

445

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

446

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

447

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

448

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

449

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

450

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

451

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

452

}

453

454

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

definition, see

https:

//developers.google.com/protocol-buffers

459

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

460

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

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

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

471

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

472

"details": [ # Details about Agones fleets.

473

{ # Details about the Agones resources.

474

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

475

#

476

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

477

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

478

#

479

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

480

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

481

{ # Details of the target Agones fleet.

482

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

483

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

484

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

485

# Details about the Agones autoscaler spec.

486

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

487

#

488

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

489

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

490

# the Agones fleet or Agones autoscaler spec.

491

},

492

},

493

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

494

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

495

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

496

# The Agones fleet spec source.

497

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

498

#

499

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

500

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

501

# the Agones fleet or Agones autoscaler spec.

},

},

},

],

},

],

},

}</pre>

</div>

</body></html>