Blame - docs/dyn/compute_v1.networkEndpointGroups.html - platform/external/python/google-api-python-client

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

[diff] [blame]

79

<p class="firstline">Retrieves the list of network endpoint groups and sorts them by zone.</p>

80

81

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

82

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

83

Dan O'Meara

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

[diff] [blame]

84

<code><a href="#attachNetworkEndpoints">attachNetworkEndpoints(project, zone, networkEndpointGroup, body=None, requestId=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

85

<p class="firstline">Attach a list of network endpoints to the specified network endpoint group.</p>

86

Dmitry Frenkel

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

[diff] [blame]

87

<code><a href="#close">close()</a></code></p>

88

<p class="firstline">Close httplib2 connections.</p>

89

Bu Sun Kim

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

[diff] [blame]

90

<code><a href="#delete">delete(project, zone, networkEndpointGroup, requestId=None)</a></code></p>

91

<p class="firstline">Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.</p>

92

Dan O'Meara

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

[diff] [blame]

93

<code><a href="#detachNetworkEndpoints">detachNetworkEndpoints(project, zone, networkEndpointGroup, body=None, requestId=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

94

<p class="firstline">Detach a list of network endpoints from the specified network endpoint group.</p>

95

96

<code><a href="#get">get(project, zone, networkEndpointGroup)</a></code></p>

97

<p class="firstline">Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request.</p>

98

Dan O'Meara

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

[diff] [blame]

99

<code><a href="#insert">insert(project, zone, body=None, requestId=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

100

<p class="firstline">Creates a network endpoint group in the specified project using the parameters that are included in the request.</p>

101

Dmitry Frenkel

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

[diff] [blame]

102

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

Bu Sun Kim

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

[diff] [blame]

103

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

104

Dmitry Frenkel

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

[diff] [blame]

105

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

Bu Sun Kim

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

[diff] [blame]

106

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

107

108

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

109

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

110

111

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

112

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

113

Dan O'Meara

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

[diff] [blame]

114

<code><a href="#testIamPermissions">testIamPermissions(project, zone, resource, body=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

115

<p class="firstline">Returns permissions that a caller has on the specified resource.</p>

116

<h3>Method Details</h3>

117

Dmitry Frenkel

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

[diff] [blame]

118

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

Bu Sun Kim

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

[diff] [blame]

119

<pre>Retrieves the list of network endpoint groups and sorts them by zone.

120

121

Args:

122

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

Dan O'Meara

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

[diff] [blame]

123

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

Bu Sun Kim

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

[diff] [blame]

124

Dan O'Meara

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

[diff] [blame]

125

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

Bu Sun Kim

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

[diff] [blame]

126

Dan O'Meara

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

[diff] [blame]

127

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.

Bu Sun Kim

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

[diff] [blame]

128

Bu Sun Kim

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

[diff] [blame]

129

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) ```

Dan O'Meara

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

[diff] [blame]

130

includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.

Bu Sun Kim

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

[diff] [blame]

131

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`)

132

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

133

134

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.

135

136

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

137

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.

Dmitry Frenkel

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

[diff] [blame]

138

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Bu Sun Kim

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

[diff] [blame]

139

140

Returns:

141

An object of the form:

142

143

{

Yoshi Automation Bot

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

[diff] [blame^]

144

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

145

"items": { # A list of NetworkEndpointGroupsScopedList resources.

146

"a_key": { # The name of the scope that contains this set of network endpoint groups.

147

"networkEndpointGroups": [ # [Output Only] The list of network endpoint groups that are contained in this scope.

148

{ # Represents a collection of network endpoints.

149

#

150

# 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 internet NEGs, Setting up zonal NEGs, or Setting up serverless NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==) (== resource_for {$api_version}.regionNetworkEndpointGroups ==)

151

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

152

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

153

},

Yoshi Automation Bot

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

[diff] [blame^]

154

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

155

#

156

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

157

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

158

#

159

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

160

#

161

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

162

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

163

#

164

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

165

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

166

#

167

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

168

#

169

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

170

},

171

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

172

#

173

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

174

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

175

#

176

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

177

#

178

# Example value: "func1".

179

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

180

#

181

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

182

},

183

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

184

#

185

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

186

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

187

#

188

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

189

#

190

# Example value: "run-service".

191

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

192

#

193

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

194

#

195

# Example value: "revision-0010".

196

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

197

#

198

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

199

},

200

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

201

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

202

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

203

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

204

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

205

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

206

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

207

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

208

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

209

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

210

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

211

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

212

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

Bu Sun Kim

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

[diff] [blame]

213

},

214

],

Yoshi Automation Bot

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

[diff] [blame^]

215

"warning": { # [Output Only] An informational warning that replaces the list of network endpoint groups when the list is empty.

216

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

217

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

218

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

219

{

220

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

221

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

222

},

223

],

224

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

225

},

Bu Sun Kim

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

[diff] [blame]

226

},

Yoshi Automation Bot

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

[diff] [blame^]

227

},

228

"kind": "compute#networkEndpointGroupAggregatedList", # [Output Only] The resource type, which is always compute#networkEndpointGroupAggregatedList for aggregated lists of network endpoint groups.

229

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

230

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

231

"unreachables": [ # [Output Only] Unreachable resources.

232

"A String",

233

],

234

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

235

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

236

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

237

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

238

{

239

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

240

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

241

},

242

],

243

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

244

},

245

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

250

<pre>Retrieves the next page of results.

251

252

Args:

253

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

254

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

255

256

Returns:

Bu Sun Kim

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

[diff] [blame]

257

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

Bu Sun Kim

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

[diff] [blame]

258

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]

263

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

Bu Sun Kim

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

[diff] [blame]

264

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

265

266

Args:

267

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

268

zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)

269

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

Dan O'Meara

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

[diff] [blame]

270

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

271

The object takes the form of:

272

273

{

Yoshi Automation Bot

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

[diff] [blame^]

274

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

275

{ # The network endpoint.

276

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

277

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

278

},

Yoshi Automation Bot

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

[diff] [blame^]

279

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

280

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

281

#

282

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

283

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

284

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

285

},

286

],

287

}

Bu Sun Kim

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

[diff] [blame]

288

289

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.

290

291

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.

292

293

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

294

295

Returns:

296

An object of the form:

297

298

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame^]

299

#

300

# Google Compute Engine has three Operation resources:

301

#

302

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

303

#

304

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

305

#

306

# Operations can be global, regional or zonal.

307

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

308

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

309

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

310

#

311

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

312

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

313

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

314

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

315

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

316

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

317

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

Bu Sun Kim

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

[diff] [blame]

318

{

Yoshi Automation Bot

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

[diff] [blame^]

319

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

320

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

321

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

Bu Sun Kim

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

[diff] [blame]

322

},

323

],

Yoshi Automation Bot

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

[diff] [blame^]

324

},

325

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

326

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

327

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

328

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

329

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

330

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

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

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

342

{

343

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

344

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

345

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

346

{

347

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

348

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

349

},

350

],

351

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

352

},

353

],

354

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

355

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

359

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

360

<pre>Close httplib2 connections.</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

364

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

365

<pre>Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it.

366

367

Args:

368

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

369

zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)

370

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

371

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.

372

373

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.

374

375

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

376

377

Returns:

378

An object of the form:

379

380

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame^]

381

#

382

# Google Compute Engine has three Operation resources:

383

#

384

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

385

#

386

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

387

#

388

# Operations can be global, regional or zonal.

389

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

390

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

391

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

392

#

393

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

394

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

395

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

396

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

397

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

398

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

399

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

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

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

402

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

403

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

Bu Sun Kim

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

[diff] [blame]

404

},

405

],

Yoshi Automation Bot

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

[diff] [blame^]

406

},

407

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

408

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

409

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

410

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

411

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

412

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

413

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

414

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

415

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

416

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

417

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

418

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

419

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

420

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

421

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

422

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

423

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

424

{

425

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

426

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

427

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

428

{

429

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

430

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

431

},

432

],

433

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

434

},

435

],

436

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

437

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

441

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

Bu Sun Kim

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

[diff] [blame]

442

<pre>Detach a list of network endpoints from the specified network endpoint group.

443

444

Args:

445

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

446

zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)

447

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

Dan O'Meara

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

[diff] [blame]

448

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

449

The object takes the form of:

450

451

{

Yoshi Automation Bot

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

[diff] [blame^]

452

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

453

{ # The network endpoint.

454

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

455

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

456

},

Yoshi Automation Bot

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

[diff] [blame^]

457

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

458

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

459

#

460

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

461

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

462

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

463

},

464

],

465

}

Bu Sun Kim

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

[diff] [blame]

466

467

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.

468

469

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.

470

471

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

472

473

Returns:

474

An object of the form:

475

476

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame^]

477

#

478

# Google Compute Engine has three Operation resources:

479

#

480

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

481

#

482

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

483

#

484

# Operations can be global, regional or zonal.

485

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

486

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

487

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

488

#

489

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

490

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

491

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

492

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

493

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

494

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

495

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

Bu Sun Kim

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

[diff] [blame]

496

{

Yoshi Automation Bot

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

[diff] [blame^]

497

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

498

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

499

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

Bu Sun Kim

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

[diff] [blame]

500

},

501

],

Yoshi Automation Bot

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

[diff] [blame^]

502

},

503

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

504

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

505

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

506

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

507

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

508

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

509

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

510

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

511

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

512

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

513

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

514

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

515

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

516

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

517

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

518

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

519

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

520

{

521

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

522

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

523

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

524

{

525

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

526

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

527

},

528

],

529

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

530

},

531

],

532

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

533

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

538

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

539

540

Args:

541

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

542

zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)

543

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

544

545

Returns:

546

An object of the form:

547

548

{ # Represents a collection of network endpoints.

Yoshi Automation Bot

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

[diff] [blame^]

549

#

550

# 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 internet NEGs, Setting up zonal NEGs, or Setting up serverless NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==) (== resource_for {$api_version}.regionNetworkEndpointGroups ==)

551

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

552

"a_key": "A String",

553

},

554

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

555

#

Yoshi Automation Bot

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

[diff] [blame^]

556

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

557

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

Dmitry Frenkel

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

[diff] [blame]

558

#

Yoshi Automation Bot

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

[diff] [blame^]

559

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

Dmitry Frenkel

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

[diff] [blame]

560

#

Yoshi Automation Bot

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

[diff] [blame^]

561

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

562

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

Dmitry Frenkel

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

[diff] [blame]

563

#

Yoshi Automation Bot

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

[diff] [blame^]

564

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

565

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

566

#

567

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

568

#

569

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

570

},

571

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

572

#

573

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

574

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

575

#

576

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

577

#

578

# Example value: "func1".

579

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

580

#

581

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

582

},

583

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

584

#

585

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

586

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

587

#

588

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

589

#

590

# Example value: "run-service".

591

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

592

#

593

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

594

#

595

# Example value: "revision-0010".

596

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

597

#

598

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

599

},

600

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

601

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

602

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

603

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

604

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

605

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

606

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

607

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

608

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

609

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

610

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

611

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

612

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

613

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dan O'Meara

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

[diff] [blame]

617

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

Bu Sun Kim

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

[diff] [blame]

618

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

619

620

Args:

621

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

622

zone: string, The name of the zone where you want to create the network endpoint group. It should comply with RFC1035. (required)

Dan O'Meara

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

[diff] [blame]

623

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

624

The object takes the form of:

625

626

{ # Represents a collection of network endpoints.

Bu Sun Kim

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

[diff] [blame]

627

#

Dmitry Frenkel

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

[diff] [blame]

628

# 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 internet NEGs, Setting up zonal NEGs, or Setting up serverless NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==) (== resource_for {$api_version}.regionNetworkEndpointGroups ==)

Bu Sun Kim

d059ad8

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

[diff] [blame]

629

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

630

"a_key": "A String",

631

},

Dmitry Frenkel

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

[diff] [blame]

632

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

633

#

634

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

635

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

636

#

Bu Sun Kim

673ec5c

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

[diff] [blame]

637

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

Dmitry Frenkel

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

[diff] [blame]

638

#

639

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

640

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

641

#

642

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

643

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

644

#

Bu Sun Kim

673ec5c

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

[diff] [blame]

645

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

Dmitry Frenkel

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

[diff] [blame]

646

#

647

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

648

},

649

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

650

#

651

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

652

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

653

#

654

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

655

#

656

# Example value: "func1".

657

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

658

#

659

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

660

},

661

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

662

#

663

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

664

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

665

#

666

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

667

#

668

# Example value: "run-service".

669

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

670

#

671

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

672

#

673

# Example value: "revision-0010".

674

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

675

#

676

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

677

},

Bu Sun Kim

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

[diff] [blame]

678

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

679

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

680

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

681

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

682

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

683

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

684

"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

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

[diff] [blame]

685

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

686

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

687

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

688

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

689

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

690

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

691

}

Bu Sun Kim

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

[diff] [blame]

692

693

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.

694

695

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.

696

697

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

698

699

Returns:

700

An object of the form:

701

702

{ # Represents an Operation resource.

Yoshi Automation Bot

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

[diff] [blame^]

703

#

704

# Google Compute Engine has three Operation resources:

705

#

706

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

707

#

708

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

709

#

710

# Operations can be global, regional or zonal.

711

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

712

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

713

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

714

#

715

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

716

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

717

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

718

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

719

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

720

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

721

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

Bu Sun Kim

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

[diff] [blame]

722

{

Yoshi Automation Bot

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

[diff] [blame^]

723

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

724

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

725

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

Bu Sun Kim

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

[diff] [blame]

726

},

727

],

Yoshi Automation Bot

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

[diff] [blame^]

728

},

729

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

730

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

731

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

732

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

733

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

734

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

735

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

736

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

737

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

738

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

739

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

740

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

741

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

742

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

743

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

744

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

745

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

746

{

747

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

748

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

749

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

750

{

751

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

752

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

753

},

754

],

755

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

756

},

757

],

758

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

759

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

763

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

Bu Sun Kim

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

[diff] [blame]

764

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

765

766

Args:

767

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

768

zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)

Dan O'Meara

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

[diff] [blame]

769

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

Bu Sun Kim

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

[diff] [blame]

770

Dan O'Meara

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

[diff] [blame]

771

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

Bu Sun Kim

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

[diff] [blame]

772

Dan O'Meara

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

[diff] [blame]

773

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.

Bu Sun Kim

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

[diff] [blame]

774

Bu Sun Kim

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

[diff] [blame]

775

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) ```

776

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`)

777

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

778

779

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.

780

781

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

782

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.

Dmitry Frenkel

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

[diff] [blame]

783

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Bu Sun Kim

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

[diff] [blame]

784

785

Returns:

786

An object of the form:

787

788

{

Yoshi Automation Bot

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

[diff] [blame^]

789

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

790

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

791

{ # Represents a collection of network endpoints.

792

#

793

# 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 internet NEGs, Setting up zonal NEGs, or Setting up serverless NEGs. (== resource_for {$api_version}.networkEndpointGroups ==) (== resource_for {$api_version}.globalNetworkEndpointGroups ==) (== resource_for {$api_version}.regionNetworkEndpointGroups ==)

794

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

795

"a_key": "A String",

796

},

797

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

798

#

Yoshi Automation Bot

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

[diff] [blame^]

799

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

800

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

Dmitry Frenkel

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

[diff] [blame]

801

#

Yoshi Automation Bot

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

[diff] [blame^]

802

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

Dmitry Frenkel

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

[diff] [blame]

803

#

Yoshi Automation Bot

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

[diff] [blame^]

804

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

805

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

Dmitry Frenkel

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

[diff] [blame]

806

#

Yoshi Automation Bot

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

[diff] [blame^]

807

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

808

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

809

#

810

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

811

#

812

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

813

},

814

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

815

#

816

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

817

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

818

#

819

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

820

#

821

# Example value: "func1".

822

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

823

#

824

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

825

},

826

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

827

#

828

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

829

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

830

#

831

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

832

#

833

# Example value: "run-service".

834

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

835

#

836

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

837

#

838

# Example value: "revision-0010".

839

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

840

#

841

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

842

},

843

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

844

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

845

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

846

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

847

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

848

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

849

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

850

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

851

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

852

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

853

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

854

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

855

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

856

},

857

],

858

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

859

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

860

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

861

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

862

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

863

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

864

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

865

{

866

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

867

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

868

},

Bu Sun Kim

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

[diff] [blame]

869

],

Yoshi Automation Bot

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

[diff] [blame^]

870

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

871

},

872

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Dmitry Frenkel

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

[diff] [blame]

876

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

Bu Sun Kim

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

[diff] [blame]

877

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

878

879

Args:

880

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

881

zone: string, The name of the zone where the network endpoint group is located. It should comply with RFC1035. (required)

882

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)

Dan O'Meara

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

[diff] [blame]

883

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

884

The object takes the form of:

885

886

{

Yoshi Automation Bot

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

[diff] [blame^]

887

"healthStatus": "A String", # Optional query parameter for showing the health status of each network endpoint. Valid options are SKIP or SHOW. If you don't specify this parameter, the health status of network endpoints will not be provided.

888

}

Bu Sun Kim

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

[diff] [blame]

889

Dan O'Meara

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

[diff] [blame]

890

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

Bu Sun Kim

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

[diff] [blame]

891

Dan O'Meara

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

[diff] [blame]

892

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

Bu Sun Kim

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

[diff] [blame]

893

Dan O'Meara

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

[diff] [blame]

894

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.

Bu Sun Kim

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

[diff] [blame]

895

Bu Sun Kim

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

[diff] [blame]

896

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) ```

897

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`)

898

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

899

900

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.

901

902

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

903

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.

Dmitry Frenkel

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

[diff] [blame]

904

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Bu Sun Kim

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

[diff] [blame]

905

906

Returns:

907

An object of the form:

908

909

{

Yoshi Automation Bot

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

[diff] [blame^]

910

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

911

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

912

{

913

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

Bu Sun Kim

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

[diff] [blame]

914

{

Yoshi Automation Bot

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

[diff] [blame^]

915

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

916

"backendService": "A String",

917

},

918

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

919

"forwardingRule": "A String",

920

},

921

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

922

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

923

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

924

# - global/httpHealthChecks/health-check

925

"healthCheck": "A String",

926

},

927

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

928

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

929

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

930

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

931

"healthCheckService": "A String",

932

},

933

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

Bu Sun Kim

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

[diff] [blame]

934

},

935

],

Yoshi Automation Bot

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

[diff] [blame^]

936

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

937

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

938

"a_key": "A String",

939

},

940

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

941

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

942

#

943

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

944

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

945

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

946

},

Bu Sun Kim

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

[diff] [blame]

947

},

Yoshi Automation Bot

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

[diff] [blame^]

948

],

949

"kind": "compute#networkEndpointGroupsListNetworkEndpoints", # [Output Only] The resource type, which is always compute#networkEndpointGroupsListNetworkEndpoints for the list of network endpoints in the specified network endpoint group.

950

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

951

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

952

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

953

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

954

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

955

{

956

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

957

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

958

},

959

],

960

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

961

},

962

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

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

967

<pre>Retrieves the next page of results.

968

969

Args:

970

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

971

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

972

973

Returns:

Bu Sun Kim

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

[diff] [blame]

974

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

Bu Sun Kim

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

[diff] [blame]

975

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

</pre>

</div>

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

981

<pre>Retrieves the next page of results.

982

983

Args:

984

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

985

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

986

987

Returns:

Bu Sun Kim

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

[diff] [blame]

988

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

Bu Sun Kim

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

[diff] [blame]

989

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]

994

<code class="details" id="testIamPermissions">testIamPermissions(project, zone, resource, body=None)</code>

Bu Sun Kim

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

[diff] [blame]

995

<pre>Returns permissions that a caller has on the specified resource.

996

997

Args:

998

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

999

zone: string, The name of the zone for this request. (required)

1000

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

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

[diff] [blame]

1001

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1002

The object takes the form of:

1003

1004

{

Yoshi Automation Bot

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

[diff] [blame^]

1005

"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.

1006

"A String",

1007

],

1008

}

Bu Sun Kim

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

[diff] [blame]

Returns:

An object of the form:

1013

1014

{

Yoshi Automation Bot

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

[diff] [blame^]

1015

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.

1016

"A String",

1017

],

1018

}</pre>

Bu Sun Kim