Blame - docs/dyn/redis_v1.projects.locations.instances.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

78

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

79

<p class="firstline">Creates a Redis instance based on the specified tier and memory size.</p>

80

81

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

82

<p class="firstline">Deletes a specific Redis instance. Instance stops serving and data is</p>

83

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

84

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

85

<p class="firstline">Export Redis instance data into a Redis RDB format file in Cloud Storage.</p>

86

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

87

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<p class="firstline">Initiates a failover of the master node to current replica node for a</p>

89

90

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

91

<p class="firstline">Gets the details of a specific Redis instance.</p>

92

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

93

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

94

<p class="firstline">Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.</p>

95

Bu Sun Kim

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

[diff] [blame]

96

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

97

<p class="firstline">Lists all Redis instances owned by a project in either the specified</p>

98

99

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

100

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

101

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

102

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

103

<p class="firstline">Updates the metadata and configuration of a specific Redis instance.</p>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

104

105

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

106

<p class="firstline">Upgrades Redis instance to the newer Redis version specified in the</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

107

<h3>Method Details</h3>

108

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

109

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

110

<pre>Creates a Redis instance based on the specified tier and memory size.

111

Bu Sun Kim

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

[diff] [blame]

112

By default, the instance is accessible from the project's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

113

[default network](/compute/docs/networks-and-firewalls#networks).

114

115

The creation is executed asynchronously and callers may check the returned

116

operation to track its progress. Once the operation is completed the Redis

117

instance will be fully functional. Completed longrunning.Operation will

118

contain the new instance object in the response field.

119

120

The returned operation is automatically deleted after a few hours, so there

121

is no need to call DeleteOperation.

122

123

Args:

124

parent: string, Required. The resource name of the instance location using the form:

125

`projects/{project_id}/locations/{location_id}`

126

where `location_id` refers to a GCP region. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

127

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

128

The object takes the form of:

129

130

{ # A Google Cloud Redis instance.

Bu Sun Kim

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

[diff] [blame]

131

"displayName": "A String", # An arbitrary and optional user-provided name for the instance.

132

"locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,

133

# the service will choose a zone for the instance. For STANDARD_HA tier,

134

# instances will be created across two zones for protection against zonal

135

# failures. If alternative_location_id is also provided, it must be

136

# different from location_id.

137

"reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this

138

# instance. If not provided, the service will choose an unused /29 block,

139

# for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique

140

# and non-overlapping with existing subnets in an authorized network.

141

"currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic

142

# Tier instances, this will always be the same as the location_id

143

# provided by the user at creation time. For Standard Tier instances,

144

# this can be either location_id or alternative_location_id and can

145

# change after a failover event.

146

"alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance

147

# against zonal failures by provisioning it across two zones. If provided, it

148

# must be a different zone from the one provided in location_id.

149

"createTime": "A String", # Output only. The time the instance was created.

150

"labels": { # Resource labels to represent user provided metadata

151

"a_key": "A String",

152

},

153

"statusMessage": "A String", # Output only. Additional information about the current status of this

154

# instance, if available.

155

"authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine

156

# [network](/compute/docs/networks-and-firewalls#networks) to which the

157

# instance is connected. If left unspecified, the `default` network

158

# will be used.

159

"state": "A String", # Output only. The current state of this instance.

160

"name": "A String", # Required. Unique name of the resource in this scope including project and

161

# location using the form:

162

# `projects/{project_id}/locations/{location_id}/instances/{instance_id}`

163

#

164

# Note: Redis instances are managed and addressed at regional level so

165

# location_id here refers to a GCP region; however, users may choose which

166

# specific zone (or collection of zones for cross-zone instances) an instance

167

# should be provisioned in. Refer to location_id and

168

# alternative_location_id fields for more details.

169

"connectMode": "A String", # Optional. The network connect mode of the Redis instance.

170

# If not provided, the connect mode defaults to DIRECT_PEERING.

171

"persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to

172

# transfer data to/from Cloud Storage. Format is

173

# "serviceAccount:<service_account_email>". The value may change over time

174

# for a given instance so should be checked before each import/export

175

# operation.

176

"redisConfigs": { # Optional. Redis configuration parameters, according to

177

# http://redis.io/topics/config. Currently, the only supported parameters

178

# are:

179

#

180

# Redis version 3.2 and newer:

181

#

182

# * maxmemory-policy

183

# * notify-keyspace-events

184

#

185

# Redis version 4.0 and newer:

#

# * activedefrag

# * lfu-decay-time

# * lfu-log-factor

# * maxmemory-gb

#

# Redis version 5.0 and newer:

193

#

194

# * stream-node-max-bytes

195

# * stream-node-max-entries

196

"a_key": "A String",

197

},

198

"port": 42, # Output only. The port number of the exposed Redis endpoint.

199

"host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by

200

# clients to connect to the service.

201

"redisVersion": "A String", # Optional. The version of Redis software.

202

# If not provided, latest supported version will be used. Currently, the

203

# supported values are:

204

#

205

# * `REDIS_3_2` for Redis 3.2 compatibility

206

# * `REDIS_4_0` for Redis 4.0 compatibility (default)

207

# * `REDIS_5_0` for Redis 5.0 compatibility

208

"tier": "A String", # Required. The service tier of the instance.

209

"memorySizeGb": 42, # Required. Redis memory size in GiB.

210

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

211

212

instanceId: string, Required. The logical name of the Redis instance in the customer project

213

with the following restrictions:

214

215

* Must contain only lowercase letters, numbers, and hyphens.

216

* Must start with a letter.

217

* Must be between 1-40 characters.

218

* Must end with a number or a letter.

219

* Must be unique within the customer project / location

220

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

227

228

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

229

# network API call.

Bu Sun Kim

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

[diff] [blame]

230

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

231

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

232

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

233

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

234

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

235

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

236

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

237

#

238

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

239

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

240

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

241

# message types for APIs to use.

242

{

243

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

244

},

245

],

246

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

247

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

248

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

249

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

250

},

Bu Sun Kim

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

[diff] [blame]

251

"metadata": { # {

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

252

#

253

# `createTime`: The time the operation was created.

254

#

255

# `endTime`: The time the operation finished running.

256

#

257

# `target`: Server-defined resource path for the target of the operation.

258

#

259

# `verb`: Name of the verb executed by the operation.

260

#

261

# `statusDetail`: Human-readable status of the operation, if any.

262

#

263

# `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

264

#

265

# `apiVersion`: API version used to start the operation.

266

#

267

# }

Bu Sun Kim

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

[diff] [blame]

268

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

269

},

Bu Sun Kim

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

[diff] [blame]

270

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

271

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

272

# available.

Bu Sun Kim

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

[diff] [blame]

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

# `TakeSnapshotResponse`.

281

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

282

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

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

288

<pre>Deletes a specific Redis instance. Instance stops serving and data is

deleted.

Args:

`projects/{project_id}/locations/{location_id}/instances/{instance_id}`

294

where `location_id` refers to a GCP region. (required)

295

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

302

303

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

304

# network API call.

Bu Sun Kim

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

[diff] [blame]

305

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

306

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

307

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

308

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

309

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

310

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

311

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

312

#

313

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

314

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

315

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

316

# message types for APIs to use.

317

{

318

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

319

},

320

],

321

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

322

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

323

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

324

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

325

},

Bu Sun Kim

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

[diff] [blame]

326

"metadata": { # {

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

327

#

328

# `createTime`: The time the operation was created.

329

#

330

# `endTime`: The time the operation finished running.

331

#

332

# `target`: Server-defined resource path for the target of the operation.

333

#

334

# `verb`: Name of the verb executed by the operation.

335

#

336

# `statusDetail`: Human-readable status of the operation, if any.

337

#

338

# `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

339

#

340

# `apiVersion`: API version used to start the operation.

341

#

342

# }

Bu Sun Kim

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

[diff] [blame]

343

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

344

},

Bu Sun Kim

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

[diff] [blame]

345

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

346

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

347

# available.

Bu Sun Kim

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

[diff] [blame]

348

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

349

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

350

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

351

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

352

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

353

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

354

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

355

# `TakeSnapshotResponse`.

356

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

357

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

362

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

363

<pre>Export Redis instance data into a Redis RDB format file in Cloud Storage.

364

365

Redis will continue serving during this operation.

366

367

The returned operation is automatically deleted after a few hours, so

368

there is no need to call DeleteOperation.

Args:

`projects/{project_id}/locations/{location_id}/instances/{instance_id}`

373

where `location_id` refers to a GCP region. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

374

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

375

The object takes the form of:

376

377

{ # Request for Export.

Bu Sun Kim

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

[diff] [blame]

378

"outputConfig": { # The output content # Required. Specify data to be exported.

379

"gcsDestination": { # The Cloud Storage location for the output content # Google Cloud Storage destination for output content.

380

"uri": "A String", # Required. Data destination URI (e.g.

381

# 'gs://my_bucket/my_object'). Existing files will be overwritten.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

393

394

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

395

# network API call.

Bu Sun Kim

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

[diff] [blame]

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

#

404

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

405

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

406

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

407

# message types for APIs to use.

408

{

409

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

410

},

411

],

412

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

413

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

414

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

415

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

416

},

Bu Sun Kim

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

[diff] [blame]

417

"metadata": { # {

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

418

#

419

# `createTime`: The time the operation was created.

420

#

421

# `endTime`: The time the operation finished running.

422

#

423

# `target`: Server-defined resource path for the target of the operation.

424

#

425

# `verb`: Name of the verb executed by the operation.

426

#

427

# `statusDetail`: Human-readable status of the operation, if any.

428

#

429

# `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

430

#

431

# `apiVersion`: API version used to start the operation.

432

#

433

# }

Bu Sun Kim

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

[diff] [blame]

434

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

435

},

Bu Sun Kim

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

[diff] [blame]

436

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

437

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

438

# available.

Bu Sun Kim

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

[diff] [blame]

439

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

440

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

441

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

442

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

443

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

444

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

445

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

446

# `TakeSnapshotResponse`.

447

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

448

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

453

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

454

<pre>Initiates a failover of the master node to current replica node for a

455

specific STANDARD tier Cloud Memorystore for Redis instance.

Args:

`projects/{project_id}/locations/{location_id}/instances/{instance_id}`

460

where `location_id` refers to a GCP region. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

461

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

462

The object takes the form of:

463

464

{ # Request for Failover.

Bu Sun Kim

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

[diff] [blame]

465

"dataProtectionMode": "A String", # Optional. Available data protection modes that the user can choose. If it's

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

466

# unspecified, data protection mode will be LIMITED_DATA_LOSS by default.

467

}

468

469

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

476

477

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

478

# network API call.

Bu Sun Kim

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

[diff] [blame]

479

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

480

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

481

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

482

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

483

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

484

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

485

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

486

#

487

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

488

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

489

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

490

# message types for APIs to use.

491

{

492

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

493

},

494

],

495

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

496

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

497

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

498

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

499

},

Bu Sun Kim

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

[diff] [blame]

500

"metadata": { # {

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

501

#

502

# `createTime`: The time the operation was created.

503

#

504

# `endTime`: The time the operation finished running.

505

#

506

# `target`: Server-defined resource path for the target of the operation.

507

#

508

# `verb`: Name of the verb executed by the operation.

509

#

510

# `statusDetail`: Human-readable status of the operation, if any.

511

#

512

# `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

513

#

514

# `apiVersion`: API version used to start the operation.

515

#

516

# }

Bu Sun Kim

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

[diff] [blame]

517

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

518

},

Bu Sun Kim

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

[diff] [blame]

519

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

520

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

521

# available.

Bu Sun Kim

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

[diff] [blame]

522

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

523

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

524

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

525

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

526

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

527

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

528

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

529

# `TakeSnapshotResponse`.

530

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

531

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

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

537

<pre>Gets the details of a specific Redis instance.

Args:

`projects/{project_id}/locations/{location_id}/instances/{instance_id}`

542

where `location_id` refers to a GCP region. (required)

543

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

550

551

{ # A Google Cloud Redis instance.

Bu Sun Kim

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

[diff] [blame]

552

"displayName": "A String", # An arbitrary and optional user-provided name for the instance.

553

"locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,

554

# the service will choose a zone for the instance. For STANDARD_HA tier,

555

# instances will be created across two zones for protection against zonal

556

# failures. If alternative_location_id is also provided, it must be

557

# different from location_id.

558

"reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this

559

# instance. If not provided, the service will choose an unused /29 block,

560

# for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique

561

# and non-overlapping with existing subnets in an authorized network.

562

"currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic

563

# Tier instances, this will always be the same as the location_id

564

# provided by the user at creation time. For Standard Tier instances,

565

# this can be either location_id or alternative_location_id and can

566

# change after a failover event.

567

"alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance

568

# against zonal failures by provisioning it across two zones. If provided, it

569

# must be a different zone from the one provided in location_id.

570

"createTime": "A String", # Output only. The time the instance was created.

571

"labels": { # Resource labels to represent user provided metadata

572

"a_key": "A String",

573

},

574

"statusMessage": "A String", # Output only. Additional information about the current status of this

575

# instance, if available.

576

"authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine

577

# [network](/compute/docs/networks-and-firewalls#networks) to which the

578

# instance is connected. If left unspecified, the `default` network

579

# will be used.

580

"state": "A String", # Output only. The current state of this instance.

581

"name": "A String", # Required. Unique name of the resource in this scope including project and

582

# location using the form:

583

# `projects/{project_id}/locations/{location_id}/instances/{instance_id}`

584

#

585

# Note: Redis instances are managed and addressed at regional level so

586

# location_id here refers to a GCP region; however, users may choose which

587

# specific zone (or collection of zones for cross-zone instances) an instance

588

# should be provisioned in. Refer to location_id and

589

# alternative_location_id fields for more details.

590

"connectMode": "A String", # Optional. The network connect mode of the Redis instance.

591

# If not provided, the connect mode defaults to DIRECT_PEERING.

592

"persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to

593

# transfer data to/from Cloud Storage. Format is

594

# "serviceAccount:<service_account_email>". The value may change over time

595

# for a given instance so should be checked before each import/export

596

# operation.

597

"redisConfigs": { # Optional. Redis configuration parameters, according to

598

# http://redis.io/topics/config. Currently, the only supported parameters

599

# are:

600

#

601

# Redis version 3.2 and newer:

602

#

603

# * maxmemory-policy

604

# * notify-keyspace-events

605

#

606

# Redis version 4.0 and newer:

#

# * activedefrag

# * lfu-decay-time

# * lfu-log-factor

# * maxmemory-gb

#

# Redis version 5.0 and newer:

614

#

615

# * stream-node-max-bytes

616

# * stream-node-max-entries

617

"a_key": "A String",

618

},

619

"port": 42, # Output only. The port number of the exposed Redis endpoint.

620

"host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by

621

# clients to connect to the service.

622

"redisVersion": "A String", # Optional. The version of Redis software.

623

# If not provided, latest supported version will be used. Currently, the

624

# supported values are:

625

#

626

# * `REDIS_3_2` for Redis 3.2 compatibility

627

# * `REDIS_4_0` for Redis 4.0 compatibility (default)

628

# * `REDIS_5_0` for Redis 5.0 compatibility

629

"tier": "A String", # Required. The service tier of the instance.

630

"memorySizeGb": 42, # Required. Redis memory size in GiB.

631

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

635

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

636

<pre>Import a Redis RDB snapshot file from Cloud Storage into a Redis instance.

637

638

Redis may stop serving during this operation. Instance state will be

639

IMPORTING for entire operation. When complete, the instance will contain

640

only data from the imported file.

641

642

The returned operation is automatically deleted after a few hours, so

643

there is no need to call DeleteOperation.

Args:

`projects/{project_id}/locations/{location_id}/instances/{instance_id}`

648

where `location_id` refers to a GCP region. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

649

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

650

The object takes the form of:

651

652

{ # Request for Import.

Bu Sun Kim

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

[diff] [blame]

653

"inputConfig": { # The input content # Required. Specify data to be imported.

654

"gcsSource": { # The Cloud Storage location for the input content # Google Cloud Storage location where input content is located.

655

"uri": "A String", # Required. Source data URI. (e.g. 'gs://my_bucket/my_object').

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

667

668

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

669

# network API call.

Bu Sun Kim

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

[diff] [blame]

670

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

671

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

672

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

673

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

674

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

675

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

676

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

677

#

678

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

679

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

680

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

681

# message types for APIs to use.

682

{

683

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

684

},

685

],

686

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

687

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

688

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

689

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

690

},

Bu Sun Kim

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

[diff] [blame]

691

"metadata": { # {

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

692

#

693

# `createTime`: The time the operation was created.

694

#

695

# `endTime`: The time the operation finished running.

696

#

697

# `target`: Server-defined resource path for the target of the operation.

698

#

699

# `verb`: Name of the verb executed by the operation.

700

#

701

# `statusDetail`: Human-readable status of the operation, if any.

702

#

703

# `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

704

#

705

# `apiVersion`: API version used to start the operation.

706

#

707

# }

Bu Sun Kim

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

[diff] [blame]

708

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

709

},

Bu Sun Kim

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

[diff] [blame]

710

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

711

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

712

# available.

Bu Sun Kim

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

[diff] [blame]

713

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

714

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

715

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

716

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

717

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

718

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

719

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

720

# `TakeSnapshotResponse`.

721

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

722

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

727

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

728

<pre>Lists all Redis instances owned by a project in either the specified

729

location (region) or all locations.

730

731

The location should have the following format:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

732

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

733

* `projects/{project_id}/locations/{location_id}`

734

735

If `location_id` is specified as `-` (wildcard), then all regions

736

available to the project are queried, and the results are aggregated.

737

738

Args:

739

parent: string, Required. The resource name of the instance location using the form:

740

`projects/{project_id}/locations/{location_id}`

741

where `location_id` refers to a GCP region. (required)

Bu Sun Kim

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

[diff] [blame]

742

pageToken: string, The `next_page_token` value returned from a previous

743

ListInstances request, if any.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

744

pageSize: integer, The maximum number of items to return.

745

746

If not specified, a default value of 1000 will be used by the service.

747

Regardless of the page_size value, the response may include a partial list

Bu Sun Kim

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

[diff] [blame]

748

and a caller should only rely on response's

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

749

`next_page_token`

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

750

to determine if there are more instances left to be queried.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

751

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

758

759

{ # Response for ListInstances.

Bu Sun Kim

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

[diff] [blame]

760

"instances": [ # A list of Redis instances in the project in the specified location,

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

761

# or across all locations.

762

#

Bu Sun Kim

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

[diff] [blame]

763

# If the `location_id` in the parent field of the request is "-", all regions

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

764

# available to the project are queried, and the results aggregated.

765

# If in such an aggregated query a location is unavailable, a dummy Redis

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

766

# entry is included in the response with the `name` field set to a value of

767

# the form `projects/{project_id}/locations/{location_id}/instances/`- and

Bu Sun Kim

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

[diff] [blame]

768

# the `status` field set to ERROR and `status_message` field set to "location

769

# not available for ListInstances".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

770

{ # A Google Cloud Redis instance.

Bu Sun Kim

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

[diff] [blame]

771

"displayName": "A String", # An arbitrary and optional user-provided name for the instance.

772

"locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,

773

# the service will choose a zone for the instance. For STANDARD_HA tier,

774

# instances will be created across two zones for protection against zonal

775

# failures. If alternative_location_id is also provided, it must be

776

# different from location_id.

777

"reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this

778

# instance. If not provided, the service will choose an unused /29 block,

779

# for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique

780

# and non-overlapping with existing subnets in an authorized network.

781

"currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic

782

# Tier instances, this will always be the same as the location_id

783

# provided by the user at creation time. For Standard Tier instances,

784

# this can be either location_id or alternative_location_id and can

785

# change after a failover event.

786

"alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance

787

# against zonal failures by provisioning it across two zones. If provided, it

788

# must be a different zone from the one provided in location_id.

789

"createTime": "A String", # Output only. The time the instance was created.

790

"labels": { # Resource labels to represent user provided metadata

791

"a_key": "A String",

792

},

793

"statusMessage": "A String", # Output only. Additional information about the current status of this

794

# instance, if available.

795

"authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine

796

# [network](/compute/docs/networks-and-firewalls#networks) to which the

797

# instance is connected. If left unspecified, the `default` network

798

# will be used.

799

"state": "A String", # Output only. The current state of this instance.

800

"name": "A String", # Required. Unique name of the resource in this scope including project and

801

# location using the form:

802

# `projects/{project_id}/locations/{location_id}/instances/{instance_id}`

803

#

804

# Note: Redis instances are managed and addressed at regional level so

805

# location_id here refers to a GCP region; however, users may choose which

806

# specific zone (or collection of zones for cross-zone instances) an instance

807

# should be provisioned in. Refer to location_id and

808

# alternative_location_id fields for more details.

809

"connectMode": "A String", # Optional. The network connect mode of the Redis instance.

810

# If not provided, the connect mode defaults to DIRECT_PEERING.

811

"persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to

812

# transfer data to/from Cloud Storage. Format is

813

# "serviceAccount:<service_account_email>". The value may change over time

814

# for a given instance so should be checked before each import/export

815

# operation.

816

"redisConfigs": { # Optional. Redis configuration parameters, according to

817

# http://redis.io/topics/config. Currently, the only supported parameters

818

# are:

819

#

820

# Redis version 3.2 and newer:

821

#

822

# * maxmemory-policy

823

# * notify-keyspace-events

824

#

825

# Redis version 4.0 and newer:

#

# * activedefrag

# * lfu-decay-time

# * lfu-log-factor

# * maxmemory-gb

#

# Redis version 5.0 and newer:

833

#

834

# * stream-node-max-bytes

835

# * stream-node-max-entries

836

"a_key": "A String",

837

},

838

"port": 42, # Output only. The port number of the exposed Redis endpoint.

839

"host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by

840

# clients to connect to the service.

841

"redisVersion": "A String", # Optional. The version of Redis software.

842

# If not provided, latest supported version will be used. Currently, the

843

# supported values are:

844

#

845

# * `REDIS_3_2` for Redis 3.2 compatibility

846

# * `REDIS_4_0` for Redis 4.0 compatibility (default)

847

# * `REDIS_5_0` for Redis 5.0 compatibility

848

"tier": "A String", # Required. The service tier of the instance.

849

"memorySizeGb": 42, # Required. Redis memory size in GiB.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

850

},

Bu Sun Kim

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

[diff] [blame]

851

],

852

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

853

# results in the list.

854

"unreachable": [ # Locations that could not be reached.

855

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

],

}</pre>

</div>

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

862

<pre>Retrieves the next page of results.

863

864

Args:

865

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

866

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

867

868

Returns:

Bu Sun Kim

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

[diff] [blame]

869

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

870

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

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

875

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

876

<pre>Updates the metadata and configuration of a specific Redis instance.

877

878

Completed longrunning.Operation will contain the new instance object

879

in the response field. The returned operation is automatically deleted

880

after a few hours, so there is no need to call DeleteOperation.

881

882

Args:

883

name: string, Required. Unique name of the resource in this scope including project and

884

location using the form:

885

`projects/{project_id}/locations/{location_id}/instances/{instance_id}`

886

887

Note: Redis instances are managed and addressed at regional level so

888

location_id here refers to a GCP region; however, users may choose which

889

specific zone (or collection of zones for cross-zone instances) an instance

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

890

should be provisioned in. Refer to location_id and

891

alternative_location_id fields for more details. (required)

892

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

893

The object takes the form of:

894

895

{ # A Google Cloud Redis instance.

Bu Sun Kim

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

[diff] [blame]

896

"displayName": "A String", # An arbitrary and optional user-provided name for the instance.

897

"locationId": "A String", # Optional. The zone where the instance will be provisioned. If not provided,

898

# the service will choose a zone for the instance. For STANDARD_HA tier,

899

# instances will be created across two zones for protection against zonal

900

# failures. If alternative_location_id is also provided, it must be

901

# different from location_id.

902

"reservedIpRange": "A String", # Optional. The CIDR range of internal addresses that are reserved for this

903

# instance. If not provided, the service will choose an unused /29 block,

904

# for example, 10.0.0.0/29 or 192.168.0.0/29. Ranges must be unique

905

# and non-overlapping with existing subnets in an authorized network.

906

"currentLocationId": "A String", # Output only. The current zone where the Redis endpoint is placed. For Basic

907

# Tier instances, this will always be the same as the location_id

908

# provided by the user at creation time. For Standard Tier instances,

909

# this can be either location_id or alternative_location_id and can

910

# change after a failover event.

911

"alternativeLocationId": "A String", # Optional. Only applicable to STANDARD_HA tier which protects the instance

912

# against zonal failures by provisioning it across two zones. If provided, it

913

# must be a different zone from the one provided in location_id.

914

"createTime": "A String", # Output only. The time the instance was created.

915

"labels": { # Resource labels to represent user provided metadata

916

"a_key": "A String",

917

},

918

"statusMessage": "A String", # Output only. Additional information about the current status of this

919

# instance, if available.

920

"authorizedNetwork": "A String", # Optional. The full name of the Google Compute Engine

921

# [network](/compute/docs/networks-and-firewalls#networks) to which the

922

# instance is connected. If left unspecified, the `default` network

923

# will be used.

924

"state": "A String", # Output only. The current state of this instance.

925

"name": "A String", # Required. Unique name of the resource in this scope including project and

926

# location using the form:

927

# `projects/{project_id}/locations/{location_id}/instances/{instance_id}`

928

#

929

# Note: Redis instances are managed and addressed at regional level so

930

# location_id here refers to a GCP region; however, users may choose which

931

# specific zone (or collection of zones for cross-zone instances) an instance

932

# should be provisioned in. Refer to location_id and

933

# alternative_location_id fields for more details.

934

"connectMode": "A String", # Optional. The network connect mode of the Redis instance.

935

# If not provided, the connect mode defaults to DIRECT_PEERING.

936

"persistenceIamIdentity": "A String", # Output only. Cloud IAM identity used by import / export operations to

937

# transfer data to/from Cloud Storage. Format is

938

# "serviceAccount:<service_account_email>". The value may change over time

939

# for a given instance so should be checked before each import/export

940

# operation.

941

"redisConfigs": { # Optional. Redis configuration parameters, according to

942

# http://redis.io/topics/config. Currently, the only supported parameters

943

# are:

944

#

945

# Redis version 3.2 and newer:

946

#

947

# * maxmemory-policy

948

# * notify-keyspace-events

949

#

950

# Redis version 4.0 and newer:

#

# * activedefrag

# * lfu-decay-time

# * lfu-log-factor

# * maxmemory-gb

#

# Redis version 5.0 and newer:

958

#

959

# * stream-node-max-bytes

960

# * stream-node-max-entries

961

"a_key": "A String",

962

},

963

"port": 42, # Output only. The port number of the exposed Redis endpoint.

964

"host": "A String", # Output only. Hostname or IP address of the exposed Redis endpoint used by

965

# clients to connect to the service.

966

"redisVersion": "A String", # Optional. The version of Redis software.

967

# If not provided, latest supported version will be used. Currently, the

968

# supported values are:

969

#

970

# * `REDIS_3_2` for Redis 3.2 compatibility

971

# * `REDIS_4_0` for Redis 4.0 compatibility (default)

972

# * `REDIS_5_0` for Redis 5.0 compatibility

973

"tier": "A String", # Required. The service tier of the instance.

974

"memorySizeGb": 42, # Required. Redis memory size in GiB.

975

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

976

977

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

978

this field. The elements of the repeated paths field may only include these

979

fields from Instance:

* `displayName`

* `labels`

* `memorySizeGb`

* `redisConfig`

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

992

993

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

994

# network API call.

Bu Sun Kim

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

[diff] [blame]

995

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

996

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

997

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

998

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

999

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

1000

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

1001

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

1002

#

1003

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

1004

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

1005

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

1006

# message types for APIs to use.

1007

{

1008

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

1009

},

1010

],

1011

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

1012

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

1013

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

1014

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1015

},

Bu Sun Kim

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

[diff] [blame]

1016

"metadata": { # {

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1017

#

1018

# `createTime`: The time the operation was created.

1019

#

1020

# `endTime`: The time the operation finished running.

1021

#

1022

# `target`: Server-defined resource path for the target of the operation.

1023

#

1024

# `verb`: Name of the verb executed by the operation.

1025

#

1026

# `statusDetail`: Human-readable status of the operation, if any.

1027

#

1028

# `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

1029

#

1030

# `apiVersion`: API version used to start the operation.

1031

#

1032

# }

Bu Sun Kim

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

[diff] [blame]

1033

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1034

},

Bu Sun Kim

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

[diff] [blame]

1035

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1036

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

1037

# available.

Bu Sun Kim

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

[diff] [blame]

1038

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

1039

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

1040

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

1041

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

1042

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

1043

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

1044

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

1045

# `TakeSnapshotResponse`.

1046

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1047

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

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

1053

<pre>Upgrades Redis instance to the newer Redis version specified in the

request.

Args:

`projects/{project_id}/locations/{location_id}/instances/{instance_id}`

1059

where `location_id` refers to a GCP region. (required)

1060

body: object, The request body.

1061

The object takes the form of:

1062

1063

{ # Request for UpgradeInstance.

Bu Sun Kim

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

[diff] [blame]

1064

"redisVersion": "A String", # Required. Specifies the target version of Redis software to upgrade to.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1065

}

1066

1067

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1074

1075

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

1076

# network API call.

Bu Sun Kim

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

[diff] [blame]

1077

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

1078

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

1079

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

1080

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

1081

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

1082

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

1083

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

1084

#

1085

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

1086

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

1087

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

1088

# message types for APIs to use.

1089

{

1090

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

1091

},

1092

],

1093

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

1094

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

1095

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

1096

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1097

},

Bu Sun Kim

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

[diff] [blame]

1098

"metadata": { # {

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1099

#

1100

# `createTime`: The time the operation was created.

1101

#

1102

# `endTime`: The time the operation finished running.

1103

#

1104

# `target`: Server-defined resource path for the target of the operation.

1105

#

1106

# `verb`: Name of the verb executed by the operation.

1107

#

1108

# `statusDetail`: Human-readable status of the operation, if any.

1109

#

1110

# `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.

1111

#

1112

# `apiVersion`: API version used to start the operation.

1113

#

1114

# }

Bu Sun Kim