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

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

79

<p class="firstline">Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project.</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

84

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

85

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

86

87

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

88

<p class="firstline">Deletes the specified ServiceAttachment in the given scope</p>

89

90

<code><a href="#get">get(project, region, serviceAttachment)</a></code></p>

91

<p class="firstline">Returns the specified ServiceAttachment resource in the given scope.</p>

92

93

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

94

<p class="firstline">Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request.</p>

95

96

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

97

<p class="firstline">Lists the ServiceAttachments for a project in the given scope.</p>

98

99

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

100

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

101

<h3>Method Details</h3>

102

103

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

104

<pre>Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project.

105

106

Args:

107

project: string, Name of the project scoping this request. (required)

108

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

109

110

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

111

112

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.

113

114

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

115

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.

116

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

117

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

118

119

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.

120

121

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

122

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.

123

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

124

125

Returns:

126

An object of the form:

127

128

{ # Contains a list of ServiceAttachmentsScopedList.

129

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

130

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

131

"a_key": { # Name of the scope containing this set of ServiceAttachments.

132

"resources": [ # A list of ServiceAttachments contained in this scope.

133

{ # Represents a ServiceAttachment resource.

134

#

135

# A service attachment represents a service that a producer has exposed. It encapsulates the load balancer which fronts the service runs and a list of NAT IP ranges that the producers uses to represent the consumers connecting to the service. next tag = 16

136

"connectionPreference": "A String", # The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules.

137

"consumerForwardingRules": [ # [Output Only] An array of forwarding rules for all the consumers connected to this service attachment.

138

{ # [Output Only] A consumer forwarding rule connected to this service attachment.

139

"forwardingRule": "A String", # The url of a consumer forwarding rule.

140

"status": "A String", # The status of the forwarding rule.

141

},

142

],

143

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

144

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

145

"enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers.

146

"id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.

147

"kind": "compute#serviceAttachment", # [Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.

148

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

149

"natSubnets": [ # An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment.

150

"A String",

151

],

152

"producerForwardingRule": "A String", # The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.

153

"region": "A String", # [Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

154

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

155

},

156

],

157

"warning": { # Informational warning which replaces the list of service attachments when the list is empty.

158

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

159

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

160

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

161

{

162

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

163

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

164

},

165

],

166

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

},

},

},

"kind": "compute#serviceAttachmentAggregatedList", # Type of resource.

171

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

172

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

173

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

174

"A String",

175

],

176

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

177

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

178

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

179

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

180

{

181

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

182

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

183

},

184

],

185

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

},

}</pre>

</div>

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

192

<pre>Retrieves the next page of results.

193

194

Args:

195

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

196

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

197

198

Returns:

199

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

200

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

</pre>

</div>

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

206

<pre>Close httplib2 connections.</pre>

</div>

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

211

<pre>Deletes the specified ServiceAttachment in the given scope

212

213

Args:

214

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

215

region: string, Name of the region of this request. (required)

216

serviceAttachment: string, Name of the ServiceAttachment resource to delete. (required)

217

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.

218

219

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.

220

221

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

222

223

Returns:

224

An object of the form:

225

226

{ # Represents an Operation resource.

227

#

228

# Google Compute Engine has three Operation resources:

229

#

230

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

231

#

232

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

233

#

234

# Operations can be global, regional or zonal.

235

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

236

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

237

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

238

#

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

{

247

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

248

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

249

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

},

],

},

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

254

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

255

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

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

{

272

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

273

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

274

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

275

{

276

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

277

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

278

},

279

],

280

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

281

},

282

],

283

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

}</pre>

</div>

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

289

<pre>Returns the specified ServiceAttachment resource in the given scope.

290

291

Args:

292

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

293

region: string, Name of the region of this request. (required)

294

serviceAttachment: string, Name of the ServiceAttachment resource to return. (required)

295

296

Returns:

297

An object of the form:

298

299

{ # Represents a ServiceAttachment resource.

300

#

301

# A service attachment represents a service that a producer has exposed. It encapsulates the load balancer which fronts the service runs and a list of NAT IP ranges that the producers uses to represent the consumers connecting to the service. next tag = 16

302

"connectionPreference": "A String", # The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules.

303

"consumerForwardingRules": [ # [Output Only] An array of forwarding rules for all the consumers connected to this service attachment.

304

{ # [Output Only] A consumer forwarding rule connected to this service attachment.

305

"forwardingRule": "A String", # The url of a consumer forwarding rule.

306

"status": "A String", # The status of the forwarding rule.

307

},

308

],

309

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

310

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

311

"enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers.

312

"id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.

313

"kind": "compute#serviceAttachment", # [Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.

314

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

315

"natSubnets": [ # An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment.

316

"A String",

317

],

318

"producerForwardingRule": "A String", # The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.

319

"region": "A String", # [Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

320

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

}</pre>

</div>

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

326

<pre>Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request.

327

328

Args:

329

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

330

region: string, Name of the region of this request. (required)

331

body: object, The request body.

332

The object takes the form of:

333

334

{ # Represents a ServiceAttachment resource.

335

#

336

# A service attachment represents a service that a producer has exposed. It encapsulates the load balancer which fronts the service runs and a list of NAT IP ranges that the producers uses to represent the consumers connecting to the service. next tag = 16

337

"connectionPreference": "A String", # The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules.

338

"consumerForwardingRules": [ # [Output Only] An array of forwarding rules for all the consumers connected to this service attachment.

339

{ # [Output Only] A consumer forwarding rule connected to this service attachment.

340

"forwardingRule": "A String", # The url of a consumer forwarding rule.

341

"status": "A String", # The status of the forwarding rule.

342

},

343

],

344

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

345

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

346

"enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers.

347

"id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.

348

"kind": "compute#serviceAttachment", # [Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.

349

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

350

"natSubnets": [ # An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment.

351

"A String",

352

],

353

"producerForwardingRule": "A String", # The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.

354

"region": "A String", # [Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

355

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

356

}

357

358

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.

359

360

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.

361

362

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

363

364

Returns:

365

An object of the form:

366

367

{ # Represents an Operation resource.

368

#

369

# Google Compute Engine has three Operation resources:

370

#

371

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

372

#

373

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

374

#

375

# Operations can be global, regional or zonal.

376

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

377

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

378

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

379

#

380

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

381

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

382

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

383

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

384

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

385

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

386

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

387

{

388

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

389

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

390

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

},

],

},

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

395

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

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

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

412

{

413

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

414

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

415

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

416

{

417

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

418

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

419

},

420

],

421

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

422

},

423

],

424

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

}</pre>

</div>

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

430

<pre>Lists the ServiceAttachments for a project in the given scope.

431

432

Args:

433

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

434

region: string, Name of the region of this request. (required)

435

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

436

437

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

438

439

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.

440

441

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

442

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

443

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

444

445

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.

446

447

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

448

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.

449

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

450

451

Returns:

452

An object of the form:

453

454

{

455

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

456

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

457

{ # Represents a ServiceAttachment resource.

458

#

459

# A service attachment represents a service that a producer has exposed. It encapsulates the load balancer which fronts the service runs and a list of NAT IP ranges that the producers uses to represent the consumers connecting to the service. next tag = 16

460

"connectionPreference": "A String", # The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules.

461

"consumerForwardingRules": [ # [Output Only] An array of forwarding rules for all the consumers connected to this service attachment.

462

{ # [Output Only] A consumer forwarding rule connected to this service attachment.

463

"forwardingRule": "A String", # The url of a consumer forwarding rule.

464

"status": "A String", # The status of the forwarding rule.

465

},

466

],

467

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

468

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

469

"enableProxyProtocol": True or False, # If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers.

470

"id": "A String", # [Output Only] The unique identifier for the resource type. The server generates this identifier.

471

"kind": "compute#serviceAttachment", # [Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.

472

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

473

"natSubnets": [ # An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment.

474

"A String",

475

],

476

"producerForwardingRule": "A String", # The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.

477

"region": "A String", # [Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

478

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

479

},

480

],

481

"kind": "compute#serviceAttachmentList", # [Output Only] Type of the resource. Always compute#serviceAttachment for service attachments.

482

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

483

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

484

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

485

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

486

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

487

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

488

{

489

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

490

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

491

},

492

],

493

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

494

},

495

}</pre>