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

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Dan O'Meara

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

[diff] [blame]

78

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

Bu Sun Kim

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

[diff] [blame]

79

<p class="firstline">Synchronously invokes a deployed Cloud Function. To be used for testing</p>

Sai Cheemalapati

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

[diff] [blame]

80

Dan O'Meara

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

[diff] [blame]

81

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

Sai Cheemalapati

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

Dan O'Meara

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

[diff] [blame]

87

<code><a href="#generateDownloadUrl">generateDownloadUrl(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">Returns a signed URL for downloading deployed function source code.</p>

89

90

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

91

<p class="firstline">Returns a signed URL for uploading a function source code.</p>

92

Sai Cheemalapati

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

[diff] [blame]

93

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

94

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

95

Bu Sun Kim

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

[diff] [blame]

96

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

Sai Cheemalapati

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

[diff] [blame]

97

<p class="firstline">Returns a list of functions that belong to the requested project.</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="#update">update(name, body=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

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

[diff] [blame]

103

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

104

<h3>Method Details</h3>

105

Dan O'Meara

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

[diff] [blame]

106

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

Bu Sun Kim

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

[diff] [blame]

107

<pre>Synchronously invokes a deployed Cloud Function. To be used for testing

108

purposes as very limited traffic is allowed. For more information on

109

the actual limits refer to [API Calls](

110

https://cloud.google.com/functions/quotas#rate_limits).

Sai Cheemalapati

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

[diff] [blame]

111

112

Args:

Dan O'Meara

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

[diff] [blame]

113

name: string, Required. The name of the function to be called. (required)

114

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

115

The object takes the form of:

116

117

{ # Request for the `CallFunction` method.

Bu Sun Kim

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

[diff] [blame]

118

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

Sai Cheemalapati

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

[diff] [blame]

119

}

120

121

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

128

129

{ # Response of `CallFunction` method.

Bu Sun Kim

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

[diff] [blame]

130

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

131

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

Sai Cheemalapati

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

[diff] [blame]

132

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

Bu Sun Kim

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

[diff] [blame]

133

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

Sai Cheemalapati

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

[diff] [blame]

134

# was not successful.

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

139

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

Sai Cheemalapati

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

[diff] [blame]

140

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

141

the specified project, the long running operation will return

142

`ALREADY_EXISTS` error.

143

144

Args:

Dan O'Meara

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

[diff] [blame]

145

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

Sai Cheemalapati

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

[diff] [blame]

146

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

Dan O'Meara

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

[diff] [blame]

147

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

148

The object takes the form of:

149

150

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

151

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

Bu Sun Kim

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

[diff] [blame]

152

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

153

# archive which contains the function.

154

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

155

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

156

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

157

# contain the name of the repository.

158

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

159

# which the function should be fetched.

160

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

161

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

162

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

163

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

164

# repository.

165

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

166

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

167

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

168

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

169

# equal to the revision specified by the user.

170

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

171

# which the function should be fetched.

Sai Cheemalapati

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

[diff] [blame]

172

},

Bu Sun Kim

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

[diff] [blame]

173

"network": "A String", # The VPC Network that this cloud function can connect to. It can be

Dan O'Meara

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

[diff] [blame]

174

# either the fully-qualified URI, or the short name of the network resource.

175

# If the short network name is used, the network must belong to the same

176

# project. Otherwise, it must belong to a project within the same

177

# organization. The format of this field is either

178

# `projects/{project}/global/networks/{network}` or `{network}`, where

179

# {project} is a project id where the network is defined, and {network} is

180

# the short name of the network.

181

#

182

# This field is mutually exclusive with `vpc_connector` and will be replaced

183

# by it.

184

#

185

# See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for

186

# more information on connecting Cloud projects.

Bu Sun Kim

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

[diff] [blame]

187

"vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can

Dan O'Meara

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

[diff] [blame]

188

# be either the fully-qualified URI, or the short name of the network

189

# connector resource. The format of this field is

190

# `projects/*/locations/*/connectors/*`

191

#

192

# This field is mutually exclusive with `network` field and will eventually

193

# replace it.

194

#

195

# See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for

196

# more information on connecting Cloud projects.

Bu Sun Kim

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

[diff] [blame]

197

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

Sai Cheemalapati

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

[diff] [blame]

198

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

199

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

Bu Sun Kim

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

[diff] [blame]

200

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

Sai Cheemalapati

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

[diff] [blame]

201

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

202

# in `source_location`.

Bu Sun Kim

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

[diff] [blame]

203

"labels": { # Labels associated with this Cloud Function.

204

"a_key": "A String",

205

},

206

"sourceRepositoryUrl": "A String", # The URL pointing to the hosted repository where the function is defined.

Bu Sun Kim

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

[diff] [blame]

207

# There are supported Cloud Source Repository URLs in the following

208

# formats:

209

#

210

# To refer to a specific commit:

211

# `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`

212

# To refer to a moveable alias (branch):

213

# `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`

214

# In particular, to refer to HEAD use `master` moveable alias.

215

# To refer to a specific fixed alias (tag):

216

# `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`

217

#

218

# You may omit `paths/*` if you want to use the main directory.

Bu Sun Kim

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

[diff] [blame]

219

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

220

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

221

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

222

# active operation.

223

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

224

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

225

},

226

"maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a

227

# given time.

228

"environmentVariables": { # Environment variables that shall be available during function execution.

229

"a_key": "A String",

230

},

231

"sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated

232

# by google.cloud.functions.v1beta2.GenerateUploadUrl

233

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

234

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

235

# timeout period. Defaults to 60 seconds.

236

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

237

# service.

238

"service": "A String", # The hostname of the service that should be observed.

239

#

240

# If no string is provided, the default service implementing the API will

241

# be used. For example, `storage.googleapis.com` is the default for all

242

# event types in the `google.storage` namespace.

243

"failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions.

244

# If empty, then defaults to ignoring failures (i.e. not retrying them).

245

"retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a failure.

246

# A function execution will be retried on any failure.

247

# A failed execution will be retried up to 7 days with an exponential backoff

248

# (capped at 10 seconds).

249

# Retried execution is charged as any other execution.

250

},

251

},

252

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

253

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

254

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

255

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

256

#

257

# Handle an object changing in Google Cloud Storage:

258

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

259

#

260

# Handle a write to the Firebase Realtime Database:

261

# `providers/google.firebase.database/eventTypes/ref.write`

262

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

263

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

264

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

265

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

266

# project (`projects/*`)

267

},

268

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

269

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

270

# Defaults to 256MB.

271

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

272

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

273

"runtime": "A String", # The runtime in which to run the function. Required when deploying a new

Dan O'Meara

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

[diff] [blame]

274

# function, optional when updating an existing function. For a complete

275

# list of possible choices, see the

276

# [`gcloud` command

277

# reference](/sdk/gcloud/reference/functions/deploy#--runtime).

Bu Sun Kim

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

[diff] [blame]

278

"versionId": "A String", # Output only. The version identifier of the Cloud Function. Each deployment attempt

279

# results in a new version of a function being created.

280

"serviceAccount": "A String", # The email of the function's service account. If empty, defaults to

281

# `{project_id}@appspot.gserviceaccount.com`.

Sai Cheemalapati

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

[diff] [blame]

282

}

283

284

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

291

292

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

293

# network API call.

Bu Sun Kim

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

[diff] [blame]

294

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

Bu Sun Kim

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

[diff] [blame]

295

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

Sai Cheemalapati

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

[diff] [blame]

296

# available.

Bu Sun Kim

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

[diff] [blame]

297

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

Sai Cheemalapati

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

[diff] [blame]

298

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

299

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

300

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

301

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

302

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

303

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

304

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

305

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

Sai Cheemalapati

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

[diff] [blame]

306

},

Bu Sun Kim

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

[diff] [blame]

307

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

Sai Cheemalapati

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

[diff] [blame]

308

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

Bu Sun Kim

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

[diff] [blame]

309

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

Bu Sun Kim

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

[diff] [blame]

310

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

311

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

312

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

313

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

314

#

315

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

316

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

317

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

318

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

319

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

320

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

321

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

322

# message types for APIs to use.

323

{

324

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

},

],

},

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

329

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

330

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

331

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

332

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

333

},

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

339

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

340

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

341

remove this function.

342

343

Args:

Dan O'Meara

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

[diff] [blame]

344

name: string, Required. The name of the function which should be deleted. (required)

Sai Cheemalapati

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

[diff] [blame]

345

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

352

353

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

354

# network API call.

Bu Sun Kim

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

[diff] [blame]

355

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

Bu Sun Kim

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

[diff] [blame]

356

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

Sai Cheemalapati

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

[diff] [blame]

357

# available.

Bu Sun Kim

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

[diff] [blame]

358

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

Sai Cheemalapati

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

[diff] [blame]

359

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

360

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

361

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

362

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

363

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

364

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

365

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

366

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

Sai Cheemalapati

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

[diff] [blame]

367

},

Bu Sun Kim

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

[diff] [blame]

368

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

Sai Cheemalapati

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

[diff] [blame]

369

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

Bu Sun Kim

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

[diff] [blame]

370

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

Bu Sun Kim

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

[diff] [blame]

371

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

372

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

373

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

374

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

375

#

376

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

377

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

378

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

379

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

380

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

381

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

382

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

383

# message types for APIs to use.

384

{

385

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

},

],

},

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

390

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

391

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

392

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

393

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

394

},

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]

399

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

Bu Sun Kim

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

[diff] [blame]

400

<pre>Returns a signed URL for downloading deployed function source code.

401

The URL is only valid for a limited period and should be used within

402

minutes after generation.

403

For more information about the signed URL usage see:

404

https://cloud.google.com/storage/docs/access-control/signed-urls

405

406

Args:

407

name: string, The name of function for which source code Google Cloud Storage signed

408

URL should be generated. (required)

Dan O'Meara

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

[diff] [blame]

409

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

410

The object takes the form of:

411

412

{ # Request of `GenerateDownloadUrl` method.

Bu Sun Kim

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

[diff] [blame]

413

"versionId": "A String", # The optional version of function.

Bu Sun Kim

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

[diff] [blame]

414

}

415

416

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

423

424

{ # Response of `GenerateDownloadUrl` method.

Bu Sun Kim

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

[diff] [blame]

425

"downloadUrl": "A String", # The generated Google Cloud Storage signed URL that should be used for

Bu Sun Kim

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

[diff] [blame]

426

# function source code download.

}</pre>

</div>

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

432

<pre>Returns a signed URL for uploading a function source code.

433

For more information about the signed URL usage see:

434

https://cloud.google.com/storage/docs/access-control/signed-urls

435

Once the function source code upload is complete, the used signed

436

URL should be provided in CreateFunction or UpdateFunction request

437

as a reference to the function source code.

438

439

When uploading source code to the generated signed URL, please follow

440

these restrictions:

441

442

* Source file type should be a zip file.

443

* Source file size should not exceed 100MB limit.

444

* No credentials should be attached - the signed URLs provide access to the

445

target bucket using internal service identity; if credentials were

446

attached, the identity from the credentials would be used, but that

447

identity does not have permissions to upload files to the URL.

448

449

When making a HTTP PUT request, these two headers need to be specified:

450

451

* `content-type: application/zip`

452

* `x-goog-content-length-range: 0,104857600`

453

454

And this header SHOULD NOT be specified:

455

456

* `Authorization: Bearer YOUR_TOKEN`

457

458

Args:

459

parent: string, The project and location in which the Google Cloud Storage signed URL

460

should be generated, specified in the format `projects/*/locations/*`. (required)

461

body: object, The request body.

462

The object takes the form of:

463

464

{ # Request of `GenerateUploadUrl` method.

465

}

466

467

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

474

475

{ # Response of `GenerateUploadUrl` method.

Bu Sun Kim

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

[diff] [blame]

476

"uploadUrl": "A String", # The generated Google Cloud Storage signed URL that should be used for a

Bu Sun Kim

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

[diff] [blame]

477

# function source code upload. The uploaded file should be a zip archive

478

# which contains a function.

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

484

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

485

486

Args:

Dan O'Meara

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

[diff] [blame]

487

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

Sai Cheemalapati

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

[diff] [blame]

488

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

495

496

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

497

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

Bu Sun Kim

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

[diff] [blame]

498

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

499

# archive which contains the function.

500

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

501

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

502

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

503

# contain the name of the repository.

504

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

505

# which the function should be fetched.

506

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

507

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

508

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

509

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

510

# repository.

511

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

512

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

513

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

514

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

515

# equal to the revision specified by the user.

516

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

517

# which the function should be fetched.

Sai Cheemalapati

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

[diff] [blame]

518

},

Bu Sun Kim

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

[diff] [blame]

519

"network": "A String", # The VPC Network that this cloud function can connect to. It can be

Dan O'Meara

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

[diff] [blame]

520

# either the fully-qualified URI, or the short name of the network resource.

521

# If the short network name is used, the network must belong to the same

522

# project. Otherwise, it must belong to a project within the same

523

# organization. The format of this field is either

524

# `projects/{project}/global/networks/{network}` or `{network}`, where

525

# {project} is a project id where the network is defined, and {network} is

526

# the short name of the network.

527

#

528

# This field is mutually exclusive with `vpc_connector` and will be replaced

529

# by it.

530

#

531

# See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for

532

# more information on connecting Cloud projects.

Bu Sun Kim

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

[diff] [blame]

533

"vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can

Dan O'Meara

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

[diff] [blame]

534

# be either the fully-qualified URI, or the short name of the network

535

# connector resource. The format of this field is

536

# `projects/*/locations/*/connectors/*`

537

#

538

# This field is mutually exclusive with `network` field and will eventually

539

# replace it.

540

#

541

# See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for

542

# more information on connecting Cloud projects.

Bu Sun Kim

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

[diff] [blame]

543

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

Sai Cheemalapati

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

[diff] [blame]

544

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

545

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

Bu Sun Kim

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

[diff] [blame]

546

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

Sai Cheemalapati

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

[diff] [blame]

547

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

548

# in `source_location`.

Bu Sun Kim

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

[diff] [blame]

549

"labels": { # Labels associated with this Cloud Function.

550

"a_key": "A String",

551

},

552

"sourceRepositoryUrl": "A String", # The URL pointing to the hosted repository where the function is defined.

Bu Sun Kim

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

[diff] [blame]

553

# There are supported Cloud Source Repository URLs in the following

554

# formats:

555

#

556

# To refer to a specific commit:

557

# `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`

558

# To refer to a moveable alias (branch):

559

# `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`

560

# In particular, to refer to HEAD use `master` moveable alias.

561

# To refer to a specific fixed alias (tag):

562

# `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`

563

#

564

# You may omit `paths/*` if you want to use the main directory.

Bu Sun Kim

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

[diff] [blame]

565

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

566

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

567

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

568

# active operation.

569

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

570

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

571

},

572

"maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a

573

# given time.

574

"environmentVariables": { # Environment variables that shall be available during function execution.

575

"a_key": "A String",

576

},

577

"sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated

578

# by google.cloud.functions.v1beta2.GenerateUploadUrl

579

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

580

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

581

# timeout period. Defaults to 60 seconds.

582

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

583

# service.

584

"service": "A String", # The hostname of the service that should be observed.

585

#

586

# If no string is provided, the default service implementing the API will

587

# be used. For example, `storage.googleapis.com` is the default for all

588

# event types in the `google.storage` namespace.

589

"failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions.

590

# If empty, then defaults to ignoring failures (i.e. not retrying them).

591

"retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a failure.

592

# A function execution will be retried on any failure.

593

# A failed execution will be retried up to 7 days with an exponential backoff

594

# (capped at 10 seconds).

595

# Retried execution is charged as any other execution.

596

},

597

},

598

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

599

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

600

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

601

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

602

#

603

# Handle an object changing in Google Cloud Storage:

604

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

605

#

606

# Handle a write to the Firebase Realtime Database:

607

# `providers/google.firebase.database/eventTypes/ref.write`

608

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

609

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

610

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

611

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

612

# project (`projects/*`)

613

},

614

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

615

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

616

# Defaults to 256MB.

617

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

618

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

619

"runtime": "A String", # The runtime in which to run the function. Required when deploying a new

Dan O'Meara

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

[diff] [blame]

620

# function, optional when updating an existing function. For a complete

621

# list of possible choices, see the

622

# [`gcloud` command

623

# reference](/sdk/gcloud/reference/functions/deploy#--runtime).

Bu Sun Kim

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

[diff] [blame]

624

"versionId": "A String", # Output only. The version identifier of the Cloud Function. Each deployment attempt

625

# results in a new version of a function being created.

626

"serviceAccount": "A String", # The email of the function's service account. If empty, defaults to

627

# `{project_id}@appspot.gserviceaccount.com`.

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

632

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

Sai Cheemalapati

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

[diff] [blame]

633

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

634

635

Args:

Dan O'Meara

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

[diff] [blame]

636

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

Sai Cheemalapati

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

[diff] [blame]

637

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

Bu Sun Kim

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

[diff] [blame]

638

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

Dan O'Meara

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

[diff] [blame]

639

location. When listing functions in all locations, if one or more

640

location(s) are unreachable, the response will contain functions from all

641

reachable locations along with the names of any unreachable locations. (required)

Sai Cheemalapati

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

[diff] [blame]

642

pageToken: string, The value returned by the last

643

`ListFunctionsResponse`; indicates that

644

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

645

system should return the next page of data.

Bu Sun Kim

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

[diff] [blame]

646

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

Sai Cheemalapati

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

[diff] [blame]

647

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

654

655

{ # Response for the `ListFunctions` method.

Bu Sun Kim

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

[diff] [blame]

656

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

Sai Cheemalapati

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

[diff] [blame]

657

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

658

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

Bu Sun Kim

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

[diff] [blame]

659

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

660

# archive which contains the function.

661

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

662

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

663

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

664

# contain the name of the repository.

665

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

666

# which the function should be fetched.

667

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

668

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

669

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

670

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

671

# repository.

672

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

673

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

674

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

675

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

676

# equal to the revision specified by the user.

677

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

678

# which the function should be fetched.

Sai Cheemalapati

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

[diff] [blame]

679

},

Bu Sun Kim

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

[diff] [blame]

680

"network": "A String", # The VPC Network that this cloud function can connect to. It can be

Dan O'Meara

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

[diff] [blame]

681

# either the fully-qualified URI, or the short name of the network resource.

682

# If the short network name is used, the network must belong to the same

683

# project. Otherwise, it must belong to a project within the same

684

# organization. The format of this field is either

685

# `projects/{project}/global/networks/{network}` or `{network}`, where

686

# {project} is a project id where the network is defined, and {network} is

687

# the short name of the network.

688

#

689

# This field is mutually exclusive with `vpc_connector` and will be replaced

690

# by it.

691

#

692

# See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for

693

# more information on connecting Cloud projects.

Bu Sun Kim

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

[diff] [blame]

694

"vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can

Dan O'Meara

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

[diff] [blame]

695

# be either the fully-qualified URI, or the short name of the network

696

# connector resource. The format of this field is

697

# `projects/*/locations/*/connectors/*`

698

#

699

# This field is mutually exclusive with `network` field and will eventually

700

# replace it.

701

#

702

# See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for

703

# more information on connecting Cloud projects.

Bu Sun Kim

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

[diff] [blame]

704

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

Sai Cheemalapati

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

[diff] [blame]

705

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

706

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

Bu Sun Kim

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

[diff] [blame]

707

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

Sai Cheemalapati

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

[diff] [blame]

708

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

709

# in `source_location`.

Bu Sun Kim

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

[diff] [blame]

710

"labels": { # Labels associated with this Cloud Function.

711

"a_key": "A String",

712

},

713

"sourceRepositoryUrl": "A String", # The URL pointing to the hosted repository where the function is defined.

Bu Sun Kim

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

[diff] [blame]

714

# There are supported Cloud Source Repository URLs in the following

715

# formats:

716

#

717

# To refer to a specific commit:

718

# `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`

719

# To refer to a moveable alias (branch):

720

# `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`

721

# In particular, to refer to HEAD use `master` moveable alias.

722

# To refer to a specific fixed alias (tag):

723

# `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`

724

#

725

# You may omit `paths/*` if you want to use the main directory.

Bu Sun Kim

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

[diff] [blame]

726

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

727

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

728

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

729

# active operation.

730

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

731

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

732

},

733

"maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a

734

# given time.

735

"environmentVariables": { # Environment variables that shall be available during function execution.

736

"a_key": "A String",

737

},

738

"sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated

739

# by google.cloud.functions.v1beta2.GenerateUploadUrl

740

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

741

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

742

# timeout period. Defaults to 60 seconds.

743

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

744

# service.

745

"service": "A String", # The hostname of the service that should be observed.

746

#

747

# If no string is provided, the default service implementing the API will

748

# be used. For example, `storage.googleapis.com` is the default for all

749

# event types in the `google.storage` namespace.

750

"failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions.

751

# If empty, then defaults to ignoring failures (i.e. not retrying them).

752

"retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a failure.

753

# A function execution will be retried on any failure.

754

# A failed execution will be retried up to 7 days with an exponential backoff

755

# (capped at 10 seconds).

756

# Retried execution is charged as any other execution.

757

},

758

},

759

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

760

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

761

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

762

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

763

#

764

# Handle an object changing in Google Cloud Storage:

765

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

766

#

767

# Handle a write to the Firebase Realtime Database:

768

# `providers/google.firebase.database/eventTypes/ref.write`

769

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

770

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

771

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

772

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

773

# project (`projects/*`)

774

},

775

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

776

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

777

# Defaults to 256MB.

778

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

779

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

780

"runtime": "A String", # The runtime in which to run the function. Required when deploying a new

Dan O'Meara

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

[diff] [blame]

781

# function, optional when updating an existing function. For a complete

782

# list of possible choices, see the

783

# [`gcloud` command

784

# reference](/sdk/gcloud/reference/functions/deploy#--runtime).

Bu Sun Kim

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

[diff] [blame]

785

"versionId": "A String", # Output only. The version identifier of the Cloud Function. Each deployment attempt

786

# results in a new version of a function being created.

787

"serviceAccount": "A String", # The email of the function's service account. If empty, defaults to

788

# `{project_id}@appspot.gserviceaccount.com`.

Sai Cheemalapati

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

[diff] [blame]

789

},

790

],

Bu Sun Kim

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

[diff] [blame]

791

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

792

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

793

# google.cloud.functions.v1beta2.ListFunctionsRequest

794

# to get more functions.

795

"unreachable": [ # Locations that could not be reached. The response does not include any

796

# functions from these locations.

797

"A String",

798

],

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

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

804

<pre>Retrieves the next page of results.

805

806

Args:

807

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

808

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

809

810

Returns:

Bu Sun Kim

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

[diff] [blame]

811

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

Sai Cheemalapati

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

[diff] [blame]

812

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]

817

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

Sai Cheemalapati

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

[diff] [blame]

818

<pre>Updates existing function.

819

820

Args:

Dan O'Meara

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

[diff] [blame]

821

name: string, Required. The name of the function to be updated. (required)

822

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

823

The object takes the form of:

824

825

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

826

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

Bu Sun Kim

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

[diff] [blame]

827

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

828

# archive which contains the function.

829

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

830

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

831

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

832

# contain the name of the repository.

833

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

834

# which the function should be fetched.

835

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

836

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

837

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

838

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

839

# repository.

840

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

841

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

842

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

843

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

844

# equal to the revision specified by the user.

845

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

846

# which the function should be fetched.

Sai Cheemalapati

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

[diff] [blame]

847

},

Bu Sun Kim

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

[diff] [blame]

848

"network": "A String", # The VPC Network that this cloud function can connect to. It can be

Dan O'Meara

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

[diff] [blame]

849

# either the fully-qualified URI, or the short name of the network resource.

850

# If the short network name is used, the network must belong to the same

851

# project. Otherwise, it must belong to a project within the same

852

# organization. The format of this field is either

853

# `projects/{project}/global/networks/{network}` or `{network}`, where

854

# {project} is a project id where the network is defined, and {network} is

855

# the short name of the network.

856

#

857

# This field is mutually exclusive with `vpc_connector` and will be replaced

858

# by it.

859

#

860

# See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for

861

# more information on connecting Cloud projects.

Bu Sun Kim

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

[diff] [blame]

862

"vpcConnector": "A String", # The VPC Network Connector that this cloud function can connect to. It can

Dan O'Meara

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

[diff] [blame]

863

# be either the fully-qualified URI, or the short name of the network

864

# connector resource. The format of this field is

865

# `projects/*/locations/*/connectors/*`

866

#

867

# This field is mutually exclusive with `network` field and will eventually

868

# replace it.

869

#

870

# See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for

871

# more information on connecting Cloud projects.

Bu Sun Kim

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

[diff] [blame]

872

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

Sai Cheemalapati

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

[diff] [blame]

873

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

874

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

Bu Sun Kim

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

[diff] [blame]

875

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

Sai Cheemalapati

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

[diff] [blame]

876

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

877

# in `source_location`.

Bu Sun Kim

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

[diff] [blame]

878

"labels": { # Labels associated with this Cloud Function.

879

"a_key": "A String",

880

},

881

"sourceRepositoryUrl": "A String", # The URL pointing to the hosted repository where the function is defined.

Bu Sun Kim

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

[diff] [blame]

882

# There are supported Cloud Source Repository URLs in the following

883

# formats:

884

#

885

# To refer to a specific commit:

886

# `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`

887

# To refer to a moveable alias (branch):

888

# `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`

889

# In particular, to refer to HEAD use `master` moveable alias.

890

# To refer to a specific fixed alias (tag):

891

# `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`

892

#

893

# You may omit `paths/*` if you want to use the main directory.

Bu Sun Kim

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

[diff] [blame]

894

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

895

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

896

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

897

# active operation.

898

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

899

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

900

},

901

"maxInstances": 42, # The limit on the maximum number of function instances that may coexist at a

902

# given time.

903

"environmentVariables": { # Environment variables that shall be available during function execution.

904

"a_key": "A String",

905

},

906

"sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated

907

# by google.cloud.functions.v1beta2.GenerateUploadUrl

908

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

909

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

910

# timeout period. Defaults to 60 seconds.

911

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

912

# service.

913

"service": "A String", # The hostname of the service that should be observed.

914

#

915

# If no string is provided, the default service implementing the API will

916

# be used. For example, `storage.googleapis.com` is the default for all

917

# event types in the `google.storage` namespace.

918

"failurePolicy": { # Describes the policy in case of function's execution failure. # Specifies policy for failed executions.

919

# If empty, then defaults to ignoring failures (i.e. not retrying them).

920

"retry": { # Describes the retry policy in case of function's execution failure. # If specified, then the function will be retried in case of a failure.

921

# A function execution will be retried on any failure.

922

# A failed execution will be retried up to 7 days with an exponential backoff

923

# (capped at 10 seconds).

924

# Retried execution is charged as any other execution.

925

},

926

},

927

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

928

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

929

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

930

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

931

#

932

# Handle an object changing in Google Cloud Storage:

933

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

934

#

935

# Handle a write to the Firebase Realtime Database:

936

# `providers/google.firebase.database/eventTypes/ref.write`

937

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

938

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

939

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

940

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

941

# project (`projects/*`)

942

},

943

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

944

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

945

# Defaults to 256MB.

946

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

947

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

948

"runtime": "A String", # The runtime in which to run the function. Required when deploying a new

Dan O'Meara

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

[diff] [blame]

949

# function, optional when updating an existing function. For a complete

950

# list of possible choices, see the

951

# [`gcloud` command

952

# reference](/sdk/gcloud/reference/functions/deploy#--runtime).

Bu Sun Kim

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

[diff] [blame]

953

"versionId": "A String", # Output only. The version identifier of the Cloud Function. Each deployment attempt

954

# results in a new version of a function being created.

955

"serviceAccount": "A String", # The email of the function's service account. If empty, defaults to

956

# `{project_id}@appspot.gserviceaccount.com`.

Sai Cheemalapati

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

[diff] [blame]

957

}

958

959

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

966

967

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

968

# network API call.

Bu Sun Kim

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

[diff] [blame]

969

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

Bu Sun Kim

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

[diff] [blame]

970

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

Sai Cheemalapati

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

[diff] [blame]

971

# available.

Bu Sun Kim

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

[diff] [blame]

972

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

Sai Cheemalapati

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

[diff] [blame]

973

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

974

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

975

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

976

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

977

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

978

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

979

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

980

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

Sai Cheemalapati

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

[diff] [blame]

981

},

Bu Sun Kim

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

[diff] [blame]

982

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

Sai Cheemalapati

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

[diff] [blame]

983

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

Bu Sun Kim

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

[diff] [blame]

984

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

Bu Sun Kim