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-27 12:20:54 -0700

[diff] [blame]

152

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

153

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

154

},

155

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

156

# given time.

157

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

158

"a_key": "A String",

159

},

160

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

161

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

162

# service.

163

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

164

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

165

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

166

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

167

#

168

# Handle an object changing in Google Cloud Storage:

169

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

170

#

171

# Handle a write to the Firebase Realtime Database:

172

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

173

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

174

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

175

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

176

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

177

# project (`projects/*`)

178

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

179

#

180

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

181

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

182

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

183

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

184

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

185

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

186

# A function execution will be retried on any failure.

187

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

188

# (capped at 10 seconds).

189

# Retried execution is charged as any other execution.

},

},

},

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

194

# by google.cloud.functions.v1beta2.GenerateUploadUrl

195

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

196

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

197

# timeout period. Defaults to 60 seconds.

198

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

199

# Defaults to 256MB.

200

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

201

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

202

# list of possible choices, see the

203

# [`gcloud` command

204

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

205

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

206

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

207

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

208

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

209

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

210

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

Bu Sun Kim

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

[diff] [blame]

211

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

212

# archive which contains the function.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

213

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

214

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

215

# connector resource. The format of this field is

216

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

217

#

218

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

219

# replace it.

220

#

221

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

222

# more information on connecting Cloud projects.

Bu Sun Kim

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

[diff] [blame]

223

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

224

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

225

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

226

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

227

# organization. The format of this field is either

228

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

229

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

230

# the short name of the network.

231

#

232

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

233

# by it.

234

#

235

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

236

# more information on connecting Cloud projects.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

237

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

238

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

239

# which the function should be fetched.

240

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

241

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

242

# contain the name of the repository.

243

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

244

# which the function should be fetched.

245

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

246

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

247

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

248

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

249

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

250

# equal to the revision specified by the user.

251

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

252

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

253

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

254

# repository.

255

},

256

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

257

"a_key": "A String",

258

},

Bu Sun Kim

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

[diff] [blame]

259

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

260

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

261

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

Bu Sun Kim

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

[diff] [blame]

262

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

Sai Cheemalapati

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

[diff] [blame]

263

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

264

# in `source_location`.

Bu Sun Kim

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

[diff] [blame]

265

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

266

# There are supported Cloud Source Repository URLs in the following

267

# formats:

268

#

269

# To refer to a specific commit:

270

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

271

# To refer to a moveable alias (branch):

272

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

273

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

274

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

275

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

276

#

277

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

Bu Sun Kim

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

[diff] [blame]

278

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

279

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

280

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

281

# active operation.

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-27 12:20:54 -0700

[diff] [blame]

294

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

295

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

296

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

297

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

298

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

299

},

Bu Sun Kim

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

[diff] [blame]

300

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

301

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

Sai Cheemalapati

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

[diff] [blame]

302

# available.

Bu Sun Kim

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

[diff] [blame]

303

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

304

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

305

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

306

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

307

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

308

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

309

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

310

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

311

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

Sai Cheemalapati

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

[diff] [blame]

312

},

Bu Sun Kim

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

[diff] [blame]

313

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

314

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

Bu Sun Kim

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

[diff] [blame]

315

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

Bu Sun Kim

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

[diff] [blame]

316

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

317

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

318

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

319

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

320

#

321

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

322

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

Bu Sun Kim

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

[diff] [blame]

323

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

324

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

325

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

326

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

327

# message types for APIs to use.

328

{

329

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

330

},

331

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

332

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

Bu Sun Kim

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

[diff] [blame]

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-27 12:20:54 -0700

[diff] [blame]

355

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

356

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

357

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

358

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

359

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

360

},

Bu Sun Kim

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

[diff] [blame]

361

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

362

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

Sai Cheemalapati

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

[diff] [blame]

363

# available.

Bu Sun Kim

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

[diff] [blame]

364

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

365

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

366

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

367

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

368

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

369

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

370

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

371

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

372

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

Sai Cheemalapati

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

[diff] [blame]

373

},

Bu Sun Kim

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

[diff] [blame]

374

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

375

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

Bu Sun Kim

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

[diff] [blame]

376

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

Bu Sun Kim

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

[diff] [blame]

377

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

378

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

379

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

380

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

381

#

382

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

383

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

Bu Sun Kim

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

[diff] [blame]

384

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

385

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

386

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

387

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

388

# message types for APIs to use.

389

{

390

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

391

},

392

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

393

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

Bu Sun Kim

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

[diff] [blame]

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-27 12:20:54 -0700

[diff] [blame]

498

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

499

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

500

},

501

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

502

# given time.

503

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

504

"a_key": "A String",

505

},

506

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

507

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

508

# service.

509

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

510

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

511

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

512

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

513

#

514

# Handle an object changing in Google Cloud Storage:

515

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

516

#

517

# Handle a write to the Firebase Realtime Database:

518

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

519

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

520

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

521

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

522

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

523

# project (`projects/*`)

524

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

525

#

526

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

527

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

528

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

529

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

530

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

531

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

532

# A function execution will be retried on any failure.

533

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

534

# (capped at 10 seconds).

535

# Retried execution is charged as any other execution.

},

},

},

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

540

# by google.cloud.functions.v1beta2.GenerateUploadUrl

541

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

542

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

543

# timeout period. Defaults to 60 seconds.

544

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

545

# Defaults to 256MB.

546

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

547

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

548

# list of possible choices, see the

549

# [`gcloud` command

550

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

551

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

552

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

553

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

554

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

555

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

556

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

Bu Sun Kim

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

[diff] [blame]

557

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

558

# archive which contains the function.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

559

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

560

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

561

# connector resource. The format of this field is

562

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

563

#

564

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

565

# replace it.

566

#

567

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

568

# more information on connecting Cloud projects.

Bu Sun Kim

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

[diff] [blame]

569

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

570

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

571

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

572

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

573

# organization. The format of this field is either

574

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

575

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

576

# the short name of the network.

577

#

578

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

579

# by it.

580

#

581

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

582

# more information on connecting Cloud projects.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

583

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

584

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

585

# which the function should be fetched.

586

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

587

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

588

# contain the name of the repository.

589

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

590

# which the function should be fetched.

591

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

592

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

593

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

594

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

595

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

596

# equal to the revision specified by the user.

597

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

598

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

599

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

600

# repository.

601

},

602

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

603

"a_key": "A String",

604

},

Bu Sun Kim

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

[diff] [blame]

605

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

606

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

607

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

Bu Sun Kim

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

[diff] [blame]

608

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

Sai Cheemalapati

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

[diff] [blame]

609

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

610

# in `source_location`.

Bu Sun Kim

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

[diff] [blame]

611

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

612

# There are supported Cloud Source Repository URLs in the following

613

# formats:

614

#

615

# To refer to a specific commit:

616

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

617

# To refer to a moveable alias (branch):

618

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

619

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

620

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

621

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

622

#

623

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

Bu Sun Kim

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

[diff] [blame]

624

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

625

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

626

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

627

# active operation.

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-27 12:20:54 -0700

[diff] [blame]

656

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

657

# functions from these locations.

658

"A String",

659

],

Bu Sun Kim

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

[diff] [blame]

660

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

Sai Cheemalapati

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

[diff] [blame]

661

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

662

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

663

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

664

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

665

},

666

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

667

# given time.

668

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

669

"a_key": "A String",

670

},

671

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

672

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

673

# service.

674

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

675

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

676

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

677

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

678

#

679

# Handle an object changing in Google Cloud Storage:

680

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

681

#

682

# Handle a write to the Firebase Realtime Database:

683

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

684

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

685

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

686

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

687

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

688

# project (`projects/*`)

689

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

690

#

691

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

692

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

693

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

694

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

695

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

696

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

697

# A function execution will be retried on any failure.

698

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

699

# (capped at 10 seconds).

700

# Retried execution is charged as any other execution.

},

},

},

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

705

# by google.cloud.functions.v1beta2.GenerateUploadUrl

706

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

707

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

708

# timeout period. Defaults to 60 seconds.

709

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

710

# Defaults to 256MB.

711

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

712

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

713

# list of possible choices, see the

714

# [`gcloud` command

715

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

716

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

717

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

718

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

719

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

720

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

721

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

Bu Sun Kim

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

[diff] [blame]

722

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

723

# archive which contains the function.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

724

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

725

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

726

# connector resource. The format of this field is

727

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

728

#

729

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

730

# replace it.

731

#

732

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

733

# more information on connecting Cloud projects.

Bu Sun Kim

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

[diff] [blame]

734

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

735

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

736

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

737

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

738

# organization. The format of this field is either

739

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

740

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

741

# the short name of the network.

742

#

743

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

744

# by it.

745

#

746

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

747

# more information on connecting Cloud projects.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

748

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

749

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

750

# which the function should be fetched.

751

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

752

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

753

# contain the name of the repository.

754

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

755

# which the function should be fetched.

756

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

757

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

758

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

759

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

760

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

761

# equal to the revision specified by the user.

762

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

763

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

764

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

765

# repository.

766

},

767

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

768

"a_key": "A String",

769

},

Bu Sun Kim

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

[diff] [blame]

770

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

771

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

772

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

Bu Sun Kim

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

[diff] [blame]

773

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

Sai Cheemalapati

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

[diff] [blame]

774

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

775

# in `source_location`.

Bu Sun Kim

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

[diff] [blame]

776

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

777

# There are supported Cloud Source Repository URLs in the following

778

# formats:

779

#

780

# To refer to a specific commit:

781

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

782

# To refer to a moveable alias (branch):

783

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

784

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

785

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

786

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

787

#

788

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

Bu Sun Kim

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

[diff] [blame]

789

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

790

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

791

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

792

# active operation.

Sai Cheemalapati

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

[diff] [blame]

793

},

794

],

Bu Sun Kim

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

[diff] [blame]

795

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

796

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

797

# google.cloud.functions.v1beta2.ListFunctionsRequest

798

# to get more functions.

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-27 12:20:54 -0700

[diff] [blame]

827

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

828

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

829

},

830

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

831

# given time.

832

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

833

"a_key": "A String",

834

},

835

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

836

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

837

# service.

838

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

839

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

840

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

841

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

842

#

843

# Handle an object changing in Google Cloud Storage:

844

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

845

#

846

# Handle a write to the Firebase Realtime Database:

847

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

848

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

849

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

850

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

851

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

852

# project (`projects/*`)

853

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

854

#

855

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

856

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

857

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

858

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

859

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

860

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

861

# A function execution will be retried on any failure.

862

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

863

# (capped at 10 seconds).

864

# Retried execution is charged as any other execution.

},

},

},

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

869

# by google.cloud.functions.v1beta2.GenerateUploadUrl

870

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

871

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

872

# timeout period. Defaults to 60 seconds.

873

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

874

# Defaults to 256MB.

875

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

876

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

877

# list of possible choices, see the

878

# [`gcloud` command

879

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

880

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

881

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

882

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

883

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

884

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

885

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

Bu Sun Kim

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

[diff] [blame]

886

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

887

# archive which contains the function.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

888

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

889

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

890

# connector resource. The format of this field is

891

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

892

#

893

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

894

# replace it.

895

#

896

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

897

# more information on connecting Cloud projects.

Bu Sun Kim

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

[diff] [blame]

898

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

899

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

900

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

901

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

902

# organization. The format of this field is either

903

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

904

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

905

# the short name of the network.

906

#

907

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

908

# by it.

909

#

910

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

911

# more information on connecting Cloud projects.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

912

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

913

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

914

# which the function should be fetched.

915

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

916

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

917

# contain the name of the repository.

918

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

919

# which the function should be fetched.

920

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

921

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

922

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

923

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

924

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

925

# equal to the revision specified by the user.

926

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

927

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

928

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

929

# repository.

930

},

931

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

932

"a_key": "A String",

933

},

Bu Sun Kim

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

[diff] [blame]

934

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

935

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

936

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

Bu Sun Kim

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

[diff] [blame]

937

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

Sai Cheemalapati

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

[diff] [blame]

938

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

939

# in `source_location`.

Bu Sun Kim

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

[diff] [blame]

940

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

941

# There are supported Cloud Source Repository URLs in the following

942

# formats:

943

#

944

# To refer to a specific commit:

945

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

946

# To refer to a moveable alias (branch):

947

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

948

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

949

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

950

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

951

#

952

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

Bu Sun Kim

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

[diff] [blame]

953

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

954

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

955

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

956

# active operation.

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-27 12:20:54 -0700

[diff] [blame]

969

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

970

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

971

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

972

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

973

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

974

},

Bu Sun Kim

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

[diff] [blame]

975

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

976

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

Sai Cheemalapati

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

[diff] [blame]

977

# available.

Bu Sun Kim

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

[diff] [blame]

978

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

979

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

980

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

981

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

982

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

983

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

984

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

985

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

986

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

Sai Cheemalapati

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

[diff] [blame]

987

},

Bu Sun Kim

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

[diff] [blame]

988

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

989

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

Bu Sun Kim

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

[diff] [blame]

990

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

Bu Sun Kim