Blame - docs/dyn/cloudfunctions_v1beta2.projects.locations.functions.html - platform/external/python/google-api-python-client

<h1><a href="cloudfunctions_v1beta2.html">Google Cloud Functions API</a> . <a href="cloudfunctions_v1beta2.projects.html">projects</a> . <a href="cloudfunctions_v1beta2.projects.locations.html">locations</a> . <a href="cloudfunctions_v1beta2.projects.locations.functions.html">functions</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

<p class="firstline">Invokes synchronously deployed function. To be used for testing, very</p>

80

Thomas Coffee

2f24537

2017-03-27 10:39:26 -0700

[diff] [blame]

81

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

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

82

<p class="firstline">Creates a new function. If a function with the given name already exists in</p>

83

84

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

85

<p class="firstline">Deletes a function with the given name from the specified project. If the</p>

86

87

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

88

<p class="firstline">Returns a function with the given name from the requested project.</p>

89

Thomas Coffee

2f24537

2017-03-27 10:39:26 -0700

[diff] [blame]

90

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

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

91

<p class="firstline">Returns a list of functions that belong to the requested project.</p>

92

93

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

94

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

95

96

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

97

<p class="firstline">Updates existing function.</p>

98

<h3>Method Details</h3>

99

100

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

101

<pre>Invokes synchronously deployed function. To be used for testing, very

102

limited traffic allowed.

Args:

body: object, The request body. (required)

107

The object takes the form of:

108

109

{ # Request for the `CallFunction` method.

110

"data": "A String", # Input to be passed to the function.

111

}

112

113

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

120

121

{ # Response of `CallFunction` method.

122

"executionId": "A String", # Execution id of function invocation.

123

"result": "A String", # Result populated for successful execution of synchronous function. Will

124

# not be populated if function does not return a result through context.

125

"error": "A String", # Either system or user-function generated error. Set if execution

126

# was not successful.

}</pre>

</div>

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

131

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

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

132

<pre>Creates a new function. If a function with the given name already exists in

133

the specified project, the long running operation will return

134

`ALREADY_EXISTS` error.

135

136

Args:

137

location: string, The project and location in which the function should be created, specified

138

in the format `projects/*/locations/*` (required)

139

body: object, The request body. (required)

140

The object takes the form of:

141

142

{ # Describes a Cloud Function that contains user computation executed in

143

# response to an event. It encapsulate function and triggers configurations.

144

"eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service.

145

# service.

146

"eventType": "A String", # `event_type` names contain the service that is sending an event and the

147

# kind of event that was fired. Must be of the form

148

# `providers/*/eventTypes/*` e.g. Directly handle a Message published to

149

# Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`

150

#

151

# Handle an object changing in Google Cloud Storage

152

# `providers/cloud.storage/eventTypes/object.change`

153

#

154

# Handle a write to the Firebase Realtime Database

155

# `providers/firebase.database/eventTypes/data.write`

156

"resource": "A String", # Which instance of the source's service should send events. E.g. for Pub/Sub

157

# this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud

158

# Storage this would be a bucket at `projects/*/buckets/*`. For any source

159

# that only supports one instance per-project, this should be the name of the

160

# project (`projects/*`)

161

},

162

"status": "A String", # Output only. Status of the function deployment.

163

"updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.

164

"name": "A String", # A user-defined name of the function. Function names must be unique

165

# globally and match pattern `projects/*/locations/*/functions/*`

166

"sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined.

167

"repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in

168

# https://source.developers.google.com domain are supported. The path should

169

# contain the name of the repository.

170

"sourcePath": "A String", # The path within the repository where the function is defined. The path

171

# should point to the directory where Cloud Functions files are located. Use

172

# "/" if the function is defined directly in the root directory of a

173

# repository.

174

"deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of

175

# function creation or update. For example when a user deployed from a

176

# branch, it will be the revision id of the latest change on this branch at

177

# that time. If user deployed from revision then this value will be always

178

# equal to the revision specified by the user.

179

"tag": "A String", # The name of the tag that captures the state of the repository from

180

# which the function should be fetched.

181

"branch": "A String", # The name of the branch from which the function should be fetched.

182

"revision": "A String", # The id of the revision that captures the state of the repository from

183

# which the function should be fetched.

184

},

185

"availableMemoryMb": 42, # The amount of memory in MB available for a function.

186

# Defaults to 256MB.

187

"httpsTrigger": { # Describes HTTPSTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL.

188

"url": "A String", # Output only. The deployed url for the function.

189

},

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

190

"sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip

191

# archive which contains the function.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

192

"serviceAccount": "A String", # Output only. The service account of the function.

193

"entryPoint": "A String", # The name of the function (as defined in source code) that will be

194

# executed. Defaults to the resource name suffix, if not specified. For

195

# backward compatibility, if function with given name is not found, then the

196

# system will try to use function named "function".

197

# For Node.js this is name of a function exported by the module specified

198

# in `source_location`.

199

"timeout": "A String", # The function execution timeout. Execution is considered failed and

200

# can be terminated if the function is not completed at the end of the

201

# timeout period. Defaults to 60 seconds.

202

"latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If

203

# the function status is `DEPLOYING` or `DELETING`, then it points to the

# active operation.

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

214

215

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

216

# network API call.

217

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

218

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

219

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

220

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

221

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

222

},

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

223

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

224

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

225

# [gRPC](https://github.com/grpc). The error model is designed to be:

226

#

227

# - Simple to use and understand for most users

228

# - Flexible enough to meet unexpected needs

#

# # Overview

#

# The `Status` message contains three pieces of data: error code, error message,

233

# and error details. The error code should be an enum value of

234

# google.rpc.Code, but it may accept additional error codes if needed. The

235

# error message should be a developer-facing English message that helps

236

# developers *understand* and *resolve* the error. If a localized user-facing

237

# error message is needed, put the localized message in the error details or

238

# localize it in the client. The optional error details may contain arbitrary

239

# information about the error. There is a predefined set of error detail types

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

240

# in the package `google.rpc` that can be used for common error conditions.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

#

# # Language mapping

#

# The `Status` message is the logical representation of the error model, but it

245

# is not necessarily the actual wire format. When the `Status` message is

246

# exposed in different client libraries and different wire protocols, it can be

247

# mapped differently. For example, it will likely be mapped to some exceptions

248

# in Java, but more likely mapped to some error codes in C.

#

# # Other uses

#

# The error model and the `Status` message can be used in a variety of

253

# environments, either with or without APIs, to provide a

254

# consistent developer experience across different environments.

255

#

256

# Example uses of this error model include:

257

#

258

# - Partial errors. If a service needs to return partial errors to the client,

259

# it may embed the `Status` in the normal response to indicate the partial

260

# errors.

261

#

262

# - Workflow errors. A typical workflow has multiple steps. Each step may

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

263

# have a `Status` message for error reporting.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

264

#

265

# - Batch operations. If a client uses batch request and batch response, the

266

# `Status` message should be used directly inside batch response, one for

267

# each error sub-response.

268

#

269

# - Asynchronous operations. If an API call embeds asynchronous operation

270

# results in its response, the status of those operations should be

271

# represented directly using the `Status` message.

272

#

273

# - Logging. If some API errors are stored in logs, the message `Status` could

274

# be used directly after any stripping needed for security/privacy reasons.

275

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

276

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

277

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

278

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

279

"details": [ # A list of messages that carry the error details. There will be a

280

# common set of message types for APIs to use.

281

{

282

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

283

},

284

],

285

},

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

286

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

287

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

288

# available.

289

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

290

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

291

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

292

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

293

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

294

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

295

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

296

# `TakeSnapshotResponse`.

297

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

298

},

299

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

300

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

301

# `name` should have the format of `operations/some/unique/name`.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

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

307

<pre>Deletes a function with the given name from the specified project. If the

308

given function is used by some trigger, the trigger will be updated to

309

remove this function.

Args:

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

320

321

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

322

# network API call.

323

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

324

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

325

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

326

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

327

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

328

},

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

329

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

330

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

331

# [gRPC](https://github.com/grpc). The error model is designed to be:

332

#

333

# - Simple to use and understand for most users

334

# - Flexible enough to meet unexpected needs

#

# # Overview

#

# The `Status` message contains three pieces of data: error code, error message,

339

# and error details. The error code should be an enum value of

340

# google.rpc.Code, but it may accept additional error codes if needed. The

341

# error message should be a developer-facing English message that helps

342

# developers *understand* and *resolve* the error. If a localized user-facing

343

# error message is needed, put the localized message in the error details or

344

# localize it in the client. The optional error details may contain arbitrary

345

# information about the error. There is a predefined set of error detail types

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

346

# in the package `google.rpc` that can be used for common error conditions.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

#

# # Language mapping

#

# The `Status` message is the logical representation of the error model, but it

351

# is not necessarily the actual wire format. When the `Status` message is

352

# exposed in different client libraries and different wire protocols, it can be

353

# mapped differently. For example, it will likely be mapped to some exceptions

354

# in Java, but more likely mapped to some error codes in C.

#

# # Other uses

#

# The error model and the `Status` message can be used in a variety of

359

# environments, either with or without APIs, to provide a

360

# consistent developer experience across different environments.

361

#

362

# Example uses of this error model include:

363

#

364

# - Partial errors. If a service needs to return partial errors to the client,

365

# it may embed the `Status` in the normal response to indicate the partial

366

# errors.

367

#

368

# - Workflow errors. A typical workflow has multiple steps. Each step may

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

369

# have a `Status` message for error reporting.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

370

#

371

# - Batch operations. If a client uses batch request and batch response, the

372

# `Status` message should be used directly inside batch response, one for

373

# each error sub-response.

374

#

375

# - Asynchronous operations. If an API call embeds asynchronous operation

376

# results in its response, the status of those operations should be

377

# represented directly using the `Status` message.

378

#

379

# - Logging. If some API errors are stored in logs, the message `Status` could

380

# be used directly after any stripping needed for security/privacy reasons.

381

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

382

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

383

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

384

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

385

"details": [ # A list of messages that carry the error details. There will be a

386

# common set of message types for APIs to use.

387

{

388

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

389

},

390

],

391

},

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

392

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

393

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

394

# available.

395

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

396

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

397

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

398

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

399

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

400

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

401

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

402

# `TakeSnapshotResponse`.

403

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

404

},

405

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

406

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

407

# `name` should have the format of `operations/some/unique/name`.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

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

413

<pre>Returns a function with the given name from the requested project.

414

415

Args:

416

name: string, The name of the function which details should be obtained. (required)

417

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

424

425

{ # Describes a Cloud Function that contains user computation executed in

426

# response to an event. It encapsulate function and triggers configurations.

427

"eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service.

428

# service.

429

"eventType": "A String", # `event_type` names contain the service that is sending an event and the

430

# kind of event that was fired. Must be of the form

431

# `providers/*/eventTypes/*` e.g. Directly handle a Message published to

432

# Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`

433

#

434

# Handle an object changing in Google Cloud Storage

435

# `providers/cloud.storage/eventTypes/object.change`

436

#

437

# Handle a write to the Firebase Realtime Database

438

# `providers/firebase.database/eventTypes/data.write`

439

"resource": "A String", # Which instance of the source's service should send events. E.g. for Pub/Sub

440

# this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud

441

# Storage this would be a bucket at `projects/*/buckets/*`. For any source

442

# that only supports one instance per-project, this should be the name of the

443

# project (`projects/*`)

444

},

445

"status": "A String", # Output only. Status of the function deployment.

446

"updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.

447

"name": "A String", # A user-defined name of the function. Function names must be unique

448

# globally and match pattern `projects/*/locations/*/functions/*`

449

"sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined.

450

"repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in

451

# https://source.developers.google.com domain are supported. The path should

452

# contain the name of the repository.

453

"sourcePath": "A String", # The path within the repository where the function is defined. The path

454

# should point to the directory where Cloud Functions files are located. Use

455

# "/" if the function is defined directly in the root directory of a

456

# repository.

457

"deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of

458

# function creation or update. For example when a user deployed from a

459

# branch, it will be the revision id of the latest change on this branch at

460

# that time. If user deployed from revision then this value will be always

461

# equal to the revision specified by the user.

462

"tag": "A String", # The name of the tag that captures the state of the repository from

463

# which the function should be fetched.

464

"branch": "A String", # The name of the branch from which the function should be fetched.

465

"revision": "A String", # The id of the revision that captures the state of the repository from

466

# which the function should be fetched.

467

},

468

"availableMemoryMb": 42, # The amount of memory in MB available for a function.

469

# Defaults to 256MB.

470

"httpsTrigger": { # Describes HTTPSTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL.

471

"url": "A String", # Output only. The deployed url for the function.

472

},

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

473

"sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip

474

# archive which contains the function.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

475

"serviceAccount": "A String", # Output only. The service account of the function.

476

"entryPoint": "A String", # The name of the function (as defined in source code) that will be

477

# executed. Defaults to the resource name suffix, if not specified. For

478

# backward compatibility, if function with given name is not found, then the

479

# system will try to use function named "function".

480

# For Node.js this is name of a function exported by the module specified

481

# in `source_location`.

482

"timeout": "A String", # The function execution timeout. Execution is considered failed and

483

# can be terminated if the function is not completed at the end of the

484

# timeout period. Defaults to 60 seconds.

485

"latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If

486

# the function status is `DEPLOYING` or `DELETING`, then it points to the

# active operation.

}</pre>

</div>

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

492

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

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

493

<pre>Returns a list of functions that belong to the requested project.

494

495

Args:

496

location: string, The project and location from which the function should be listed,

497

specified in the format `projects/*/locations/*`

498

If you want to list functions in all locations, use "-" in place of a

499

location. (required)

500

pageSize: integer, Maximum number of functions to return per call.

501

pageToken: string, The value returned by the last

502

`ListFunctionsResponse`; indicates that

503

this is a continuation of a prior `ListFunctions` call, and that the

504

system should return the next page of data.

505

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

512

513

{ # Response for the `ListFunctions` method.

514

"nextPageToken": "A String", # If not empty, indicates that there may be more functions that match

515

# the request; this value should be passed in a new

516

# google.cloud.functions.v1beta2.ListFunctionsRequest

517

# to get more functions.

518

"functions": [ # The functions that match the request.

519

{ # Describes a Cloud Function that contains user computation executed in

520

# response to an event. It encapsulate function and triggers configurations.

521

"eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service.

522

# service.

523

"eventType": "A String", # `event_type` names contain the service that is sending an event and the

524

# kind of event that was fired. Must be of the form

525

# `providers/*/eventTypes/*` e.g. Directly handle a Message published to

526

# Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`

527

#

528

# Handle an object changing in Google Cloud Storage

529

# `providers/cloud.storage/eventTypes/object.change`

530

#

531

# Handle a write to the Firebase Realtime Database

532

# `providers/firebase.database/eventTypes/data.write`

533

"resource": "A String", # Which instance of the source's service should send events. E.g. for Pub/Sub

534

# this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud

535

# Storage this would be a bucket at `projects/*/buckets/*`. For any source

536

# that only supports one instance per-project, this should be the name of the

537

# project (`projects/*`)

538

},

539

"status": "A String", # Output only. Status of the function deployment.

540

"updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.

541

"name": "A String", # A user-defined name of the function. Function names must be unique

542

# globally and match pattern `projects/*/locations/*/functions/*`

543

"sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined.

544

"repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in

545

# https://source.developers.google.com domain are supported. The path should

546

# contain the name of the repository.

547

"sourcePath": "A String", # The path within the repository where the function is defined. The path

548

# should point to the directory where Cloud Functions files are located. Use

549

# "/" if the function is defined directly in the root directory of a

550

# repository.

551

"deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of

552

# function creation or update. For example when a user deployed from a

553

# branch, it will be the revision id of the latest change on this branch at

554

# that time. If user deployed from revision then this value will be always

555

# equal to the revision specified by the user.

556

"tag": "A String", # The name of the tag that captures the state of the repository from

557

# which the function should be fetched.

558

"branch": "A String", # The name of the branch from which the function should be fetched.

559

"revision": "A String", # The id of the revision that captures the state of the repository from

560

# which the function should be fetched.

561

},

562

"availableMemoryMb": 42, # The amount of memory in MB available for a function.

563

# Defaults to 256MB.

564

"httpsTrigger": { # Describes HTTPSTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL.

565

"url": "A String", # Output only. The deployed url for the function.

566

},

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

567

"sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip

568

# archive which contains the function.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

569

"serviceAccount": "A String", # Output only. The service account of the function.

570

"entryPoint": "A String", # The name of the function (as defined in source code) that will be

571

# executed. Defaults to the resource name suffix, if not specified. For

572

# backward compatibility, if function with given name is not found, then the

573

# system will try to use function named "function".

574

# For Node.js this is name of a function exported by the module specified

575

# in `source_location`.

576

"timeout": "A String", # The function execution timeout. Execution is considered failed and

577

# can be terminated if the function is not completed at the end of the

578

# timeout period. Defaults to 60 seconds.

579

"latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If

580

# the function status is `DEPLOYING` or `DELETING`, then it points to the

# active operation.

},

],

}</pre>

</div>

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

589

<pre>Retrieves the next page of results.

590

591

Args:

592

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

593

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

594

595

Returns:

596

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

597

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

</pre>

</div>

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

603

<pre>Updates existing function.

Args:

body: object, The request body. (required)

608

The object takes the form of:

609

610

{ # Describes a Cloud Function that contains user computation executed in

611

# response to an event. It encapsulate function and triggers configurations.

612

"eventTrigger": { # Describes EventTrigger, used to request events be sent from another # A source that fires events in response to a condition in another service.

613

# service.

614

"eventType": "A String", # `event_type` names contain the service that is sending an event and the

615

# kind of event that was fired. Must be of the form

616

# `providers/*/eventTypes/*` e.g. Directly handle a Message published to

617

# Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`

618

#

619

# Handle an object changing in Google Cloud Storage

620

# `providers/cloud.storage/eventTypes/object.change`

621

#

622

# Handle a write to the Firebase Realtime Database

623

# `providers/firebase.database/eventTypes/data.write`

624

"resource": "A String", # Which instance of the source's service should send events. E.g. for Pub/Sub

625

# this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud

626

# Storage this would be a bucket at `projects/*/buckets/*`. For any source

627

# that only supports one instance per-project, this should be the name of the

628

# project (`projects/*`)

629

},

630

"status": "A String", # Output only. Status of the function deployment.

631

"updateTime": "A String", # Output only. The last update timestamp of a Cloud Function.

632

"name": "A String", # A user-defined name of the function. Function names must be unique

633

# globally and match pattern `projects/*/locations/*/functions/*`

634

"sourceRepository": { # Describes the location of the function source in a remote repository. # The hosted repository where the function is defined.

635

"repositoryUrl": "A String", # URL to the hosted repository where the function is defined. Only paths in

636

# https://source.developers.google.com domain are supported. The path should

637

# contain the name of the repository.

638

"sourcePath": "A String", # The path within the repository where the function is defined. The path

639

# should point to the directory where Cloud Functions files are located. Use

640

# "/" if the function is defined directly in the root directory of a

641

# repository.

642

"deployedRevision": "A String", # Output only. The id of the revision that was resolved at the moment of

643

# function creation or update. For example when a user deployed from a

644

# branch, it will be the revision id of the latest change on this branch at

645

# that time. If user deployed from revision then this value will be always

646

# equal to the revision specified by the user.

647

"tag": "A String", # The name of the tag that captures the state of the repository from

648

# which the function should be fetched.

649

"branch": "A String", # The name of the branch from which the function should be fetched.

650

"revision": "A String", # The id of the revision that captures the state of the repository from

651

# which the function should be fetched.

652

},

653

"availableMemoryMb": 42, # The amount of memory in MB available for a function.

654

# Defaults to 256MB.

655

"httpsTrigger": { # Describes HTTPSTrigger, could be used to connect web hooks to function. # An HTTPS endpoint type of source that can be triggered via URL.

656

"url": "A String", # Output only. The deployed url for the function.

657

},

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

658

"sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with gs://, pointing to the zip

659

# archive which contains the function.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

660

"serviceAccount": "A String", # Output only. The service account of the function.

661

"entryPoint": "A String", # The name of the function (as defined in source code) that will be

662

# executed. Defaults to the resource name suffix, if not specified. For

663

# backward compatibility, if function with given name is not found, then the

664

# system will try to use function named "function".

665

# For Node.js this is name of a function exported by the module specified

666

# in `source_location`.

667

"timeout": "A String", # The function execution timeout. Execution is considered failed and

668

# can be terminated if the function is not completed at the end of the

669

# timeout period. Defaults to 60 seconds.

670

"latestOperation": "A String", # Output only. Name of the most recent operation modifying the function. If

671

# the function status is `DEPLOYING` or `DELETING`, then it points to the

# active operation.

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

682

683

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

684

# network API call.

685

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

686

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

687

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

688

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

689

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

690

},

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

691

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

692

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

693

# [gRPC](https://github.com/grpc). The error model is designed to be:

694

#

695

# - Simple to use and understand for most users

696

# - Flexible enough to meet unexpected needs

#

# # Overview

#

# The `Status` message contains three pieces of data: error code, error message,

701

# and error details. The error code should be an enum value of

702

# google.rpc.Code, but it may accept additional error codes if needed. The

703

# error message should be a developer-facing English message that helps

704

# developers *understand* and *resolve* the error. If a localized user-facing

705

# error message is needed, put the localized message in the error details or

706

# localize it in the client. The optional error details may contain arbitrary

707

# information about the error. There is a predefined set of error detail types

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

708

# in the package `google.rpc` that can be used for common error conditions.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

#

# # Language mapping

#

# The `Status` message is the logical representation of the error model, but it

713

# is not necessarily the actual wire format. When the `Status` message is

714

# exposed in different client libraries and different wire protocols, it can be

715

# mapped differently. For example, it will likely be mapped to some exceptions

716

# in Java, but more likely mapped to some error codes in C.

#

# # Other uses

#

# The error model and the `Status` message can be used in a variety of

721

# environments, either with or without APIs, to provide a

722

# consistent developer experience across different environments.

723

#

724

# Example uses of this error model include:

725

#

726

# - Partial errors. If a service needs to return partial errors to the client,

727

# it may embed the `Status` in the normal response to indicate the partial

728

# errors.

729

#

730

# - Workflow errors. A typical workflow has multiple steps. Each step may

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

731

# have a `Status` message for error reporting.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

732

#

733

# - Batch operations. If a client uses batch request and batch response, the

734

# `Status` message should be used directly inside batch response, one for

735

# each error sub-response.

736

#

737

# - Asynchronous operations. If an API call embeds asynchronous operation

738

# results in its response, the status of those operations should be

739

# represented directly using the `Status` message.

740

#

741

# - Logging. If some API errors are stored in logs, the message `Status` could

742

# be used directly after any stripping needed for security/privacy reasons.

743

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

744

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

745

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

746

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

747

"details": [ # A list of messages that carry the error details. There will be a

748

# common set of message types for APIs to use.

749

{

750

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

751

},

752

],

753

},

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

754

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

755

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

756

# available.

757

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

758

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

759

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

760

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

761

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

762

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

763

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

764

# `TakeSnapshotResponse`.

765

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

766

},

767

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

768

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

769

# `name` should have the format of `operations/some/unique/name`.

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

</body></html>