Blame - docs/dyn/compute_beta.globalNetworkEndpointGroups.html - platform/external/python/google-api-python-client

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

[diff] [blame]

97

<p class="firstline">Retrieves the list of network endpoint groups that are located in the specified project.</p>

98

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

99

<code><a href="#listNetworkEndpoints">listNetworkEndpoints(project, networkEndpointGroup, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

100

<p class="firstline">Lists the network endpoints in the specified network endpoint group.</p>

101

102

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

103

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

104

105

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

106

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

107

<h3>Method Details</h3>

108

109

<code class="details" id="attachNetworkEndpoints">attachNetworkEndpoints(project, networkEndpointGroup, body=None, requestId=None)</code>

110

<pre>Attach a network endpoint to the specified network endpoint group.

111

112

Args:

113

project: string, Project ID for this request. (required)

114

networkEndpointGroup: string, The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. (required)

115

body: object, The request body.

116

The object takes the form of:

117

118

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

119

"networkEndpoints": [ # The list of network endpoints to be attached.

120

{ # The network endpoint.

121

"annotations": { # Metadata defined as annotations on the network endpoint.

122

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

123

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

124

"fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.

125

"instance": "A String", # The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group.

126

#

127

# The name must be 1-63 characters long, and comply with RFC1035.

128

"ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

129

"port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

130

},

131

],

132

}

Bu Sun Kim

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

[diff] [blame]

133

134

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

135

136

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

137

138

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

139

140

Returns:

141

An object of the form:

142

143

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

144

#

145

# Google Compute Engine has three Operation resources:

146

#

147

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

148

#

149

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

150

#

151

# Operations can be global, regional or zonal.

152

# - For global operations, use the `globalOperations` resource.

153

# - For regional operations, use the `regionOperations` resource.

154

# - For zonal operations, use the `zonalOperations` resource.

155

#

156

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

157

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

158

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

159

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

160

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

161

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

162

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

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

[diff] [blame]

163

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

164

"code": "A String", # [Output Only] The error type identifier for this error.

165

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

166

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

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

[diff] [blame]

167

},

168

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

169

},

170

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

171

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

172

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

173

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

174

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

175

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

176

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

177

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

178

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

179

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

180

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

181

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

182

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

183

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

184

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

185

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

186

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

187

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

188

{

189

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

190

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

191

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

192

{

193

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

194

"value": "A String", # [Output Only] A warning data value corresponding to the key.

195

},

196

],

197

"message": "A String", # [Output Only] A human-readable description of the warning code.

198

},

199

],

200

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

201

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

205

<code class="details" id="close">close()</code>

206

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

210

<code class="details" id="delete">delete(project, networkEndpointGroup, requestId=None)</code>

211

<pre>Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it.

212

213

Args:

214

project: string, Project ID for this request. (required)

215

networkEndpointGroup: string, The name of the network endpoint group to delete. It should comply with RFC1035. (required)

216

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

217

218

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

219

220

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

221

222

Returns:

223

An object of the form:

224

225

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

226

#

227

# Google Compute Engine has three Operation resources:

228

#

229

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

230

#

231

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

232

#

233

# Operations can be global, regional or zonal.

234

# - For global operations, use the `globalOperations` resource.

235

# - For regional operations, use the `regionOperations` resource.

236

# - For zonal operations, use the `zonalOperations` resource.

237

#

238

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

239

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

240

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

241

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

242

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

243

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

244

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

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

[diff] [blame]

245

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

246

"code": "A String", # [Output Only] The error type identifier for this error.

247

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

248

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

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

[diff] [blame]

249

},

250

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

251

},

252

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

253

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

254

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

255

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

256

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

257

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

258

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

259

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

260

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

261

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

262

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

263

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

264

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

265

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

266

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

267

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

268

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

269

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

270

{

271

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

272

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

273

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

274

{

275

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

276

"value": "A String", # [Output Only] A warning data value corresponding to the key.

277

},

278

],

279

"message": "A String", # [Output Only] A human-readable description of the warning code.

280

},

281

],

282

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

283

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

<code class="details" id="detachNetworkEndpoints">detachNetworkEndpoints(project, networkEndpointGroup, body=None, requestId=None)</code>

288

<pre>Detach the network endpoint from the specified network endpoint group.

289

290

Args:

291

project: string, Project ID for this request. (required)

292

networkEndpointGroup: string, The name of the network endpoint group where you are removing network endpoints. It should comply with RFC1035. (required)

293

body: object, The request body.

294

The object takes the form of:

295

296

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

297

"networkEndpoints": [ # The list of network endpoints to be detached.

298

{ # The network endpoint.

299

"annotations": { # Metadata defined as annotations on the network endpoint.

300

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

301

},

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

302

"fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.

303

"instance": "A String", # The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group.

304

#

305

# The name must be 1-63 characters long, and comply with RFC1035.

306

"ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

307

"port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

308

},

309

],

310

}

Bu Sun Kim

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

[diff] [blame]

311

312

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

313

314

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

315

316

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

317

318

Returns:

319

An object of the form:

320

321

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

322

#

323

# Google Compute Engine has three Operation resources:

324

#

325

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

326

#

327

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

328

#

329

# Operations can be global, regional or zonal.

330

# - For global operations, use the `globalOperations` resource.

331

# - For regional operations, use the `regionOperations` resource.

332

# - For zonal operations, use the `zonalOperations` resource.

333

#

334

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

335

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

336

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

337

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

338

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

339

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

340

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

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

[diff] [blame]

341

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

342

"code": "A String", # [Output Only] The error type identifier for this error.

343

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

344

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

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

[diff] [blame]

345

},

346

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

347

},

348

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

349

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

350

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

351

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

352

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

353

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

354

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

355

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

356

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

357

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

358

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

359

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

360

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

361

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

362

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

363

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

364

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

365

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

366

{

367

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

368

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

369

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

370

{

371

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

372

"value": "A String", # [Output Only] A warning data value corresponding to the key.

373

},

374

],

375

"message": "A String", # [Output Only] A human-readable description of the warning code.

376

},

377

],

378

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

379

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

<code class="details" id="get">get(project, networkEndpointGroup)</code>

384

<pre>Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.

385

386

Args:

387

project: string, Project ID for this request. (required)

388

networkEndpointGroup: string, The name of the network endpoint group. It should comply with RFC1035. (required)

389

390

Returns:

391

An object of the form:

392

393

{ # Represents a collection of network endpoints.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

394

#

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

395

# A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs, see Setting up external HTTP(S) Load Balancing with internet NEGs, Setting up zonal NEGs, or Setting up external HTTP(S) Load Balancing with serverless NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==) (== resource_for {$api_version}.regionNetworkEndpointGroups ==)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

396

"annotations": { # Metadata defined as annotations on the network endpoint group.

397

"a_key": "A String",

398

},

399

"appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

Bu Sun Kim

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

[diff] [blame]

400

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

401

# Note: App Engine service must be in the same project and located in the same region as the Serverless NEG.

402

"service": "A String", # Optional serving service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

403

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

404

# The service name is case-sensitive and must be 1-63 characters long.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

405

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

406

# Example value: "default", "my-service".

407

"urlMask": "A String", # A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

408

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

409

# For example, the request URLs "foo1-dot-appname.appspot.com/v1" and "foo1-dot-appname.appspot.com/v2" can be backed by the same Serverless NEG with URL mask "-dot-appname.appspot.com/". The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively.

410

"version": "A String", # Optional serving version.

411

#

412

# The version name is case-sensitive and must be 1-100 characters long.

413

#

414

# Example value: "v1", "v2".

415

},

416

"cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

417

#

418

# Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG.

419

"function": "A String", # A user-defined name of the Cloud Function.

420

#

421

# The function name is case-sensitive and must be 1-63 characters long.

422

#

423

# Example value: "func1".

424

"urlMask": "A String", # A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services.

425

#

426

# For example, request URLs "mydomain.com/function1" and "mydomain.com/function2" can be backed by the same Serverless NEG with URL mask "/". The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively.

427

},

428

"cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

429

#

430

# Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG.

431

"service": "A String", # Cloud Run service is the main resource of Cloud Run.

432

#

433

# The service must be 1-63 characters long, and comply with RFC1035.

434

#

435

# Example value: "run-service".

436

"tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information.

437

#

438

# The tag must be 1-63 characters long, and comply with RFC1035.

439

#

440

# Example value: "revision-0010".

441

"urlMask": "A String", # A template to parse service and tag fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services.

442

#

443

# For example, request URLs "foo1.domain.com/bar1" and "foo1.domain.com/bar2" can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask ".domain.com/". The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively.

444

},

445

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

446

"defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.

447

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

448

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

449

"kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.

450

"loadBalancer": { # Load balancing specific fields for network endpoint group. # This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated.

451

"defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated.

452

"network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. [Deprecated] This field is deprecated.

453

"subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated.

454

"zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated.

455

},

456

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

457

"network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.

458

"networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, or SERVERLESS.

459

"region": "A String", # [Output Only] The URL of the region where the network endpoint group is located.

460

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

461

"size": 42, # [Output only] Number of network endpoints in the network endpoint group.

462

"subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong.

463

"zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located.

464

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

<code class="details" id="insert">insert(project, body=None, requestId=None)</code>

469

<pre>Creates a network endpoint group in the specified project using the parameters that are included in the request.

470

471

Args:

472

project: string, Project ID for this request. (required)

473

body: object, The request body.

474

The object takes the form of:

475

476

{ # Represents a collection of network endpoints.

477

#

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

478

# A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs, see Setting up external HTTP(S) Load Balancing with internet NEGs, Setting up zonal NEGs, or Setting up external HTTP(S) Load Balancing with serverless NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==) (== resource_for {$api_version}.regionNetworkEndpointGroups ==)

Bu Sun Kim

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

[diff] [blame]

479

"annotations": { # Metadata defined as annotations on the network endpoint group.

480

"a_key": "A String",

481

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

482

"appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

483

#

484

# Note: App Engine service must be in the same project and located in the same region as the Serverless NEG.

485

"service": "A String", # Optional serving service.

486

#

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

487

# The service name is case-sensitive and must be 1-63 characters long.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

488

#

489

# Example value: "default", "my-service".

490

"urlMask": "A String", # A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services.

491

#

492

# For example, the request URLs "foo1-dot-appname.appspot.com/v1" and "foo1-dot-appname.appspot.com/v2" can be backed by the same Serverless NEG with URL mask "-dot-appname.appspot.com/". The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively.

493

"version": "A String", # Optional serving version.

494

#

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

495

# The version name is case-sensitive and must be 1-100 characters long.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

496

#

497

# Example value: "v1", "v2".

498

},

499

"cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

500

#

501

# Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG.

502

"function": "A String", # A user-defined name of the Cloud Function.

503

#

504

# The function name is case-sensitive and must be 1-63 characters long.

505

#

506

# Example value: "func1".

507

"urlMask": "A String", # A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services.

508

#

509

# For example, request URLs "mydomain.com/function1" and "mydomain.com/function2" can be backed by the same Serverless NEG with URL mask "/". The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively.

510

},

511

"cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

512

#

513

# Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG.

514

"service": "A String", # Cloud Run service is the main resource of Cloud Run.

515

#

516

# The service must be 1-63 characters long, and comply with RFC1035.

517

#

518

# Example value: "run-service".

519

"tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information.

520

#

521

# The tag must be 1-63 characters long, and comply with RFC1035.

522

#

523

# Example value: "revision-0010".

524

"urlMask": "A String", # A template to parse service and tag fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services.

525

#

526

# For example, request URLs "foo1.domain.com/bar1" and "foo1.domain.com/bar2" can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask ".domain.com/". The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively.

527

},

Bu Sun Kim

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

[diff] [blame]

528

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

529

"defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.

530

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

531

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

532

"kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.

533

"loadBalancer": { # Load balancing specific fields for network endpoint group. # This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated.

534

"defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated.

535

"network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. [Deprecated] This field is deprecated.

536

"subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated.

537

"zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated.

538

},

539

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

540

"network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.

Dmitry Frenkel

3e17f89

2020-10-06 16:46:05 -0700

[diff] [blame]

541

"networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, or SERVERLESS.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

542

"region": "A String", # [Output Only] The URL of the region where the network endpoint group is located.

Bu Sun Kim

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

[diff] [blame]

543

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

544

"size": 42, # [Output only] Number of network endpoints in the network endpoint group.

545

"subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong.

546

"zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located.

547

}

548

549

requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

550

551

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

552

553

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

554

555

Returns:

556

An object of the form:

557

558

{ # Represents an Operation resource.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

559

#

560

# Google Compute Engine has three Operation resources:

561

#

562

# * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)

563

#

564

# You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

565

#

566

# Operations can be global, regional or zonal.

567

# - For global operations, use the `globalOperations` resource.

568

# - For regional operations, use the `regionOperations` resource.

569

# - For zonal operations, use the `zonalOperations` resource.

570

#

571

# For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)

572

"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.

573

"creationTimestamp": "A String", # [Deprecated] This field is deprecated.

574

"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.

575

"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.

576

"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.

577

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Bu Sun Kim

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

[diff] [blame]

578

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

579

"code": "A String", # [Output Only] The error type identifier for this error.

580

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

581

"message": "A String", # [Output Only] An optional, human-readable error message.

Bu Sun Kim

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

[diff] [blame]

582

},

583

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

584

},

585

"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.

586

"httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.

587

"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.

588

"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.

589

"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.

590

"name": "A String", # [Output Only] Name of the operation.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

591

"operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

592

"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.

593

"progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.

594

"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

595

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

596

"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.

597

"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.

598

"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.

599

"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

600

"targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.

601

"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.

602

"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.

603

{

604

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

605

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

606

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

607

{

608

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

609

"value": "A String", # [Output Only] A warning data value corresponding to the key.

610

},

611

],

612

"message": "A String", # [Output Only] A human-readable description of the warning code.

613

},

614

],

615

"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.

616

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

620

<code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

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

[diff] [blame]

621

<pre>Retrieves the list of network endpoint groups that are located in the specified project.

622

623

Args:

624

project: string, Project ID for this request. (required)

625

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

626

627

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

628

629

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

630

631

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

632

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

633

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

634

635

You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

636

637

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

638

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

639

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Bu Sun Kim

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

[diff] [blame]

640

641

Returns:

642

An object of the form:

643

644

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

645

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

646

"items": [ # A list of NetworkEndpointGroup resources.

647

{ # Represents a collection of network endpoints.

648

#

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

649

# A network endpoint group (NEG) defines how a set of endpoints should be reached, whether they are reachable, and where they are located. For more information about using NEGs, see Setting up external HTTP(S) Load Balancing with internet NEGs, Setting up zonal NEGs, or Setting up external HTTP(S) Load Balancing with serverless NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==) (== resource_for {$api_version}.regionNetworkEndpointGroups ==)

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

650

"annotations": { # Metadata defined as annotations on the network endpoint group.

651

"a_key": "A String",

652

},

653

"appEngine": { # Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

Bu Sun Kim

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

[diff] [blame]

654

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

655

# Note: App Engine service must be in the same project and located in the same region as the Serverless NEG.

656

"service": "A String", # Optional serving service.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

657

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

658

# The service name is case-sensitive and must be 1-63 characters long.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

659

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

660

# Example value: "default", "my-service".

661

"urlMask": "A String", # A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

662

#

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

663

# For example, the request URLs "foo1-dot-appname.appspot.com/v1" and "foo1-dot-appname.appspot.com/v2" can be backed by the same Serverless NEG with URL mask "-dot-appname.appspot.com/". The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively.

664

"version": "A String", # Optional serving version.

665

#

666

# The version name is case-sensitive and must be 1-100 characters long.

667

#

668

# Example value: "v1", "v2".

669

},

670

"cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

671

#

672

# Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG.

673

"function": "A String", # A user-defined name of the Cloud Function.

674

#

675

# The function name is case-sensitive and must be 1-63 characters long.

676

#

677

# Example value: "func1".

678

"urlMask": "A String", # A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services.

679

#

680

# For example, request URLs "mydomain.com/function1" and "mydomain.com/function2" can be backed by the same Serverless NEG with URL mask "/". The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively.

681

},

682

"cloudRun": { # Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. # Only valid when networkEndpointType is "SERVERLESS". Only one of cloudRun, appEngine or cloudFunction may be set.

683

#

684

# Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG.

685

"service": "A String", # Cloud Run service is the main resource of Cloud Run.

686

#

687

# The service must be 1-63 characters long, and comply with RFC1035.

688

#

689

# Example value: "run-service".

690

"tag": "A String", # Optional Cloud Run tag represents the "named-revision" to provide additional fine-grained traffic routing information.

691

#

692

# The tag must be 1-63 characters long, and comply with RFC1035.

693

#

694

# Example value: "revision-0010".

695

"urlMask": "A String", # A template to parse service and tag fields from a request URL. URL mask allows for routing to multiple Run services without having to create multiple network endpoint groups and backend services.

696

#

697

# For example, request URLs "foo1.domain.com/bar1" and "foo1.domain.com/bar2" can be backed by the same Serverless Network Endpoint Group (NEG) with URL mask ".domain.com/". The URL mask will parse them to { service="bar1", tag="foo1" } and { service="bar2", tag="foo2" } respectively.

698

},

699

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

700

"defaultPort": 42, # The default port used if the port number is not specified in the network endpoint.

701

"description": "A String", # An optional description of this resource. Provide this property when you create the resource.

702

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

703

"kind": "compute#networkEndpointGroup", # [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group.

704

"loadBalancer": { # Load balancing specific fields for network endpoint group. # This field is only valid when the network endpoint group is used for load balancing. [Deprecated] This field is deprecated.

705

"defaultPort": 42, # The default port used if the port number is not specified in the network endpoint. [Deprecated] This field is deprecated.

706

"network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. [Deprecated] This field is deprecated.

707

"subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong. [Deprecated] This field is deprecated.

708

"zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located. [Deprecated] This field is deprecated.

709

},

710

"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

711

"network": "A String", # The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified.

712

"networkEndpointType": "A String", # Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, or SERVERLESS.

713

"region": "A String", # [Output Only] The URL of the region where the network endpoint group is located.

714

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

715

"size": 42, # [Output only] Number of network endpoints in the network endpoint group.

716

"subnetwork": "A String", # Optional URL of the subnetwork to which all network endpoints in the NEG belong.

717

"zone": "A String", # [Output Only] The URL of the zone where the network endpoint group is located.

718

},

719

],

720

"kind": "compute#networkEndpointGroupList", # [Output Only] The resource type, which is always compute#networkEndpointGroupList for network endpoint group lists.

721

"nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.

722

"selfLink": "A String", # [Output Only] Server-defined URL for this resource.

723

"warning": { # [Output Only] Informational warning message.

724

"code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.

725

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

726

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

727

{

728

"key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).

729

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Bu Sun Kim

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

[diff] [blame]

730

},

731

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

732

"message": "A String", # [Output Only] A human-readable description of the warning code.

733

},

734

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

738

<code class="details" id="listNetworkEndpoints">listNetworkEndpoints(project, networkEndpointGroup, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None)</code>

Bu Sun Kim

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

[diff] [blame]

739

<pre>Lists the network endpoints in the specified network endpoint group.

740

741

Args:

742

project: string, Project ID for this request. (required)

743

networkEndpointGroup: string, The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. (required)

744

filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`.

745

746

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

747

748

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

749

750

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

751

maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)

752

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

753

754

You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

755

756

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

757

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

758

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.

Bu Sun Kim

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

[diff] [blame]

759

760

Returns:

761

An object of the form:

762

763

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

764

"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.

765

"items": [ # A list of NetworkEndpointWithHealthStatus resources.

766

{

767

"healths": [ # [Output only] The health status of network endpoint;

Bu Sun Kim

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

[diff] [blame]

768

{

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

769

"backendService": { # URL of the backend service associated with the health state of the network endpoint.

770

"backendService": "A String",

771

},

772

"forwardingRule": { # URL of the forwarding rule associated with the health state of the network endpoint.

773

"forwardingRule": "A String",

774

},

775

"healthCheck": { # A full or valid partial URL to a health check. For example, the following are valid URLs: # URL of the health check associated with the health state of the network endpoint.

776

# - https://www.googleapis.com/compute/beta/projects/project-id/global/httpHealthChecks/health-check

777

# - projects/project-id/global/httpHealthChecks/health-check

778

# - global/httpHealthChecks/health-check

779

"healthCheck": "A String",

780

},

781

"healthCheckService": { # A full or valid partial URL to a health check service. For example, the following are valid URLs: # URL of the health check service associated with the health state of the network endpoint.

782

# - https://www.googleapis.com/compute/beta/projects/project-id/regions/us-west1/healthCheckServices/health-check-service

783

# - projects/project-id/regions/us-west1/healthCheckServices/health-check-service

784

# - regions/us-west1/healthCheckServices/health-check-service

785

"healthCheckService": "A String",

786

},

787

"healthState": "A String", # Health state of the network endpoint determined based on the health checks configured.

Bu Sun Kim

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

[diff] [blame]

788

},

789

],

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

790

"networkEndpoint": { # The network endpoint. # [Output only] The network endpoint;

791

"annotations": { # Metadata defined as annotations on the network endpoint.

792

"a_key": "A String",

793

},

794

"fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.

795

"instance": "A String", # The name for a specific VM instance that the IP address belongs to. This is required for network endpoints of type GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group.

796

#

797

# The name must be 1-63 characters long, and comply with RFC1035.

798

"ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used.

yoshi-code-bot

2021-03-02 11:49:08 -0800

[diff] [blame]

799

"port": 42, # Optional port number of network endpoint. If not specified, the defaultPort for the network endpoint group will be used.

Yoshi Automation Bot

2021-01-15 07:10:04 -0800

[diff] [blame]

800

},

Bu Sun Kim

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

[diff] [blame]

801

},

Yoshi Automation Bot