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

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

[diff] [blame]

96

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

97

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

98

99

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

100

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

101

102

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

103

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

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

104

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

105

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

106

<p class="firstline">Patches the specified ServiceAttachment resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.</p>

107

yoshi-code-bot

a8b35b9

2021-03-31 13:33:30 -0700

[diff] [blame]

108

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

109

<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>

110

111

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

112

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

yoshi-code-bot

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

[diff] [blame]

113

<h3>Method Details</h3>

114

115

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

116

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

117

118

Args:

119

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

120

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

121

122

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

123

124

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.

125

126

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

127

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.

128

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

129

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

130

131

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.

132

133

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

134

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.

135

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

136

137

Returns:

138

An object of the form:

139

140

{ # Contains a list of ServiceAttachmentsScopedList.

141

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

142

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

143

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

yoshi-code-bot

c2cd326

2021-05-16 02:16:04 -0700

[diff] [blame]

144

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

yoshi-code-bot

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

[diff] [blame]

145

{ # Represents a ServiceAttachment resource.

146

#

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

147

# 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 = 19

148

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

149

{ # [Output Only] A connection connected to this service attachment.

150

"endpoint": "A String", # The url of a connected endpoint.

151

"forwardingRule": "A String", # The url of a consumer forwarding rule. [Deprecated] Do not use.

152

"pscConnectionId": "A String", # The PSC connection id of the connected endpoint.

153

"status": "A String", # The status of a connected endpoint to this service attachment.

154

},

155

],

yoshi-code-bot

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

[diff] [blame]

156

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

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

157

"consumerAcceptLists": [ # Projects that are allowed to connect to this service attachment.

158

{

159

"connectionLimit": 42, # The value of the limit to set.

160

"projectIdOrNum": "A String", # The project id or number for the project to set the limit for.

161

},

162

],

yoshi-code-bot

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

[diff] [blame]

163

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

164

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

yoshi-code-bot

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

[diff] [blame]

165

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

166

"pscConnectionId": "A String", # The PSC connection id of the PSC Forwarding Rule.

yoshi-code-bot

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

[diff] [blame]

167

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

168

},

169

],

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

170

"consumerRejectLists": [ # Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number.

171

"A String",

172

],

yoshi-code-bot

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

[diff] [blame]

173

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

174

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

175

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

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

176

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment.

yoshi-code-bot

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

[diff] [blame]

177

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

178

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

179

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

180

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

181

"A String",

182

],

183

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

184

"pscServiceAttachmentId": { # [Output Only] An 128-bit global unique ID of the PSC service attachment.

185

"high": "A String",

186

"low": "A String",

187

},

yoshi-code-bot

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

[diff] [blame]

188

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

189

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

190

"targetService": "A String", # The URL of a service serving the endpoint identified by this service attachment.

yoshi-code-bot

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

[diff] [blame]

191

},

192

],

193

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

194

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

195

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

196

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

197

{

198

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

199

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

200

},

201

],

202

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

},

},

},

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

207

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

208

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

209

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

210

"A String",

211

],

212

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

213

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

214

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

215

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

216

{

217

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

218

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

219

},

220

],

221

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

228

<pre>Retrieves the next page of results.

229

230

Args:

231

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

232

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

233

234

Returns:

235

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

236

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

</pre>

</div>

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

242

<pre>Close httplib2 connections.</pre>

</div>

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

247

<pre>Deletes the specified ServiceAttachment in the given scope

248

249

Args:

250

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

251

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

252

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

253

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.

254

255

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.

256

257

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

258

259

Returns:

260

An object of the form:

261

262

{ # Represents an Operation resource.

263

#

264

# Google Compute Engine has three Operation resources:

265

#

266

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

267

#

268

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

269

#

270

# Operations can be global, regional or zonal.

271

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

272

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

273

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

274

#

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

{

283

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

284

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

285

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

290

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

291

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

292

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

293

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

294

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

295

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

296

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

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

{

308

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

309

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

310

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

311

{

312

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

313

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

314

},

315

],

316

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

317

},

318

],

319

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

325

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

326

327

Args:

328

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

329

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

330

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

331

332

Returns:

333

An object of the form:

334

335

{ # Represents a ServiceAttachment resource.

336

#

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

337

# 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 = 19

338

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

339

{ # [Output Only] A connection connected to this service attachment.

340

"endpoint": "A String", # The url of a connected endpoint.

341

"forwardingRule": "A String", # The url of a consumer forwarding rule. [Deprecated] Do not use.

342

"pscConnectionId": "A String", # The PSC connection id of the connected endpoint.

343

"status": "A String", # The status of a connected endpoint to this service attachment.

344

},

345

],

yoshi-code-bot

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

[diff] [blame]

346

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

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

347

"consumerAcceptLists": [ # Projects that are allowed to connect to this service attachment.

348

{

349

"connectionLimit": 42, # The value of the limit to set.

350

"projectIdOrNum": "A String", # The project id or number for the project to set the limit for.

351

},

352

],

yoshi-code-bot

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

[diff] [blame]

353

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

354

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

yoshi-code-bot

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

[diff] [blame]

355

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

356

"pscConnectionId": "A String", # The PSC connection id of the PSC Forwarding Rule.

yoshi-code-bot

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

[diff] [blame]

357

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

358

},

359

],

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

360

"consumerRejectLists": [ # Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number.

361

"A String",

362

],

yoshi-code-bot

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

[diff] [blame]

363

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

364

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

365

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

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

366

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment.

yoshi-code-bot

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

[diff] [blame]

367

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

368

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

369

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

370

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

371

"A String",

372

],

373

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

374

"pscServiceAttachmentId": { # [Output Only] An 128-bit global unique ID of the PSC service attachment.

375

"high": "A String",

376

"low": "A String",

377

},

yoshi-code-bot

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

[diff] [blame]

378

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

379

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

380

"targetService": "A String", # The URL of a service serving the endpoint identified by this service attachment.

yoshi-code-bot

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

[diff] [blame]

}</pre>

</div>

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

385

<code class="details" id="getIamPolicy">getIamPolicy(project, region, resource, optionsRequestedPolicyVersion=None)</code>

386

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists.

387

388

Args:

389

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

390

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

391

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

392

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

393

394

Returns:

395

An object of the form:

396

397

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

#

#

#

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

402

#

403

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

#

# **JSON example:**

#

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

#

# **YAML example:**

#

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

412

#

413

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

414

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

415

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

416

#

417

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

418

#

419

# Example Policy with multiple AuditConfigs:

420

#

421

# { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

422

#

423

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

424

"auditLogConfigs": [ # The configuration for logging of each type of permission.

425

{ # Provides the configuration for logging a type of permissions. Example:

426

#

427

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] }

428

#

429

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

430

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

431

"A String",

432

],

433

"ignoreChildExemptions": True or False,

434

"logType": "A String", # The log type that this config enables.

},

],

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

441

},

442

],

443

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

444

{ # Associates `members` with a `role`.

445

"bindingId": "A String",

446

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. # The condition that is associated with this binding.

447

#

448

# If the condition evaluates to `true`, then this binding applies to the current request.

449

#

450

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

451

#

452

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

453

#

454

# Example (Comparison):

455

#

456

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

457

#

458

# Example (Equality):

459

#

460

# title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email"

#

# Example (Logic):

#

# title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'"

465

#

466

# Example (Data Manipulation):

467

#

468

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

469

#

470

# The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

471

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

472

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

473

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

474

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

475

},

476

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

477

#

478

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

479

#

480

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

481

#

482

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

487

#

488

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

489

#

490

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

491

#

492

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

493

#

494

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

499

"A String",

500

],

501

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

502

},

503

],

504

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.

505

#

506

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

507

"iamOwned": True or False,

508

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

509

{ # A rule to be applied in a Policy.

510

"action": "A String", # Required

511

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

512

{ # A condition to be met.

513

"iam": "A String", # Trusted attributes supplied by the IAM system.

514

"op": "A String", # An operator to apply the subject with.

515

"svc": "A String", # Trusted attributes discharged by the service.

516

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

517

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

523

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

524

"A String",

525

],

526

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

527

{ # Specifies what kind of log the caller must write

528

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

529

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

530

"permissionType": "A String", # The type of the permission that was checked.

531

},

532

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

533

},

534

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

535

#

536

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

537

#

538

# Field names correspond to IAM request parameters and field values are their respective values.

539

#

540

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

541

#

542

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

543

"customFields": [ # Custom fields.

544

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

545

"name": "A String", # Name is the field name.

546

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

547

},

548

],

549

"field": "A String", # The field value to attribute.

550

"metric": "A String", # The metric to update.

551

},

552

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

553

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

558

"A String",

559

],

560

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

566

#

567

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

568

#

569

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

570

#

571

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

572

#

573

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

574

#

575

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

576

#

577

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

}</pre>

</div>

yoshi-code-bot

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

[diff] [blame]

582

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

583

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

584

585

Args:

586

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

587

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

588

body: object, The request body.

589

The object takes the form of:

590

591

{ # Represents a ServiceAttachment resource.

592

#

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

593

# 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 = 19

594

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

595

{ # [Output Only] A connection connected to this service attachment.

596

"endpoint": "A String", # The url of a connected endpoint.

597

"forwardingRule": "A String", # The url of a consumer forwarding rule. [Deprecated] Do not use.

598

"pscConnectionId": "A String", # The PSC connection id of the connected endpoint.

599

"status": "A String", # The status of a connected endpoint to this service attachment.

600

},

601

],

yoshi-code-bot

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

[diff] [blame]

602

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

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

603

"consumerAcceptLists": [ # Projects that are allowed to connect to this service attachment.

604

{

605

"connectionLimit": 42, # The value of the limit to set.

606

"projectIdOrNum": "A String", # The project id or number for the project to set the limit for.

607

},

608

],

yoshi-code-bot

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

[diff] [blame]

609

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

610

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

yoshi-code-bot

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

[diff] [blame]

611

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

612

"pscConnectionId": "A String", # The PSC connection id of the PSC Forwarding Rule.

yoshi-code-bot

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

[diff] [blame]

613

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

614

},

615

],

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

616

"consumerRejectLists": [ # Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number.

617

"A String",

618

],

yoshi-code-bot

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

[diff] [blame]

619

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

620

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

621

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

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

622

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment.

yoshi-code-bot

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

[diff] [blame]

623

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

624

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

625

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

626

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

627

"A String",

628

],

629

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

630

"pscServiceAttachmentId": { # [Output Only] An 128-bit global unique ID of the PSC service attachment.

631

"high": "A String",

632

"low": "A String",

633

},

yoshi-code-bot

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

[diff] [blame]

634

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

635

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

636

"targetService": "A String", # The URL of a service serving the endpoint identified by this service attachment.

yoshi-code-bot

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

[diff] [blame]

637

}

638

639

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.

640

641

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.

642

643

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

644

645

Returns:

646

An object of the form:

647

648

{ # Represents an Operation resource.

649

#

650

# Google Compute Engine has three Operation resources:

651

#

652

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

653

#

654

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

655

#

656

# Operations can be global, regional or zonal.

657

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

658

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

659

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

660

#

661

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

662

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

663

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

664

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

665

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

666

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

667

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

668

{

669

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

670

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

671

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

676

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

677

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

678

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

679

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

680

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

681

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

682

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

683

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

684

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

685

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

686

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

687

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

688

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

689

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

690

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

691

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

692

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

693

{

694

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

695

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

696

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

697

{

698

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

699

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

700

},

701

],

702

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

703

},

704

],

705

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

711

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

712

713

Args:

714

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

715

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

716

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

717

718

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

719

720

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.

721

722

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

723

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

724

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

725

726

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.

727

728

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

729

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.

730

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

731

732

Returns:

733

An object of the form:

734

735

{

736

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

737

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

738

{ # Represents a ServiceAttachment resource.

739

#

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

740

# 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 = 19

741

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

742

{ # [Output Only] A connection connected to this service attachment.

743

"endpoint": "A String", # The url of a connected endpoint.

744

"forwardingRule": "A String", # The url of a consumer forwarding rule. [Deprecated] Do not use.

745

"pscConnectionId": "A String", # The PSC connection id of the connected endpoint.

746

"status": "A String", # The status of a connected endpoint to this service attachment.

747

},

748

],

yoshi-code-bot

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

[diff] [blame]

749

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

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

750

"consumerAcceptLists": [ # Projects that are allowed to connect to this service attachment.

751

{

752

"connectionLimit": 42, # The value of the limit to set.

753

"projectIdOrNum": "A String", # The project id or number for the project to set the limit for.

754

},

755

],

yoshi-code-bot

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

[diff] [blame]

756

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

757

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

yoshi-code-bot

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

[diff] [blame]

758

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

759

"pscConnectionId": "A String", # The PSC connection id of the PSC Forwarding Rule.

yoshi-code-bot

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

[diff] [blame]

760

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

761

},

762

],

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

763

"consumerRejectLists": [ # Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number.

764

"A String",

765

],

yoshi-code-bot

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

[diff] [blame]

766

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

767

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

768

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

yoshi-code-bot

2021-04-29 03:48:05 -0700

[diff] [blame]

769

"fingerprint": "A String", # Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment.

yoshi-code-bot

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

[diff] [blame]

770

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

771

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

772

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

773

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

774

"A String",

775

],

776

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

777

"pscServiceAttachmentId": { # [Output Only] An 128-bit global unique ID of the PSC service attachment.

778

"high": "A String",

779

"low": "A String",

780

},

yoshi-code-bot

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

[diff] [blame]

781

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

782

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

Anthonios Partheniou

2021-04-13 14:47:53 -0400

[diff] [blame]

783

"targetService": "A String", # The URL of a service serving the endpoint identified by this service attachment.

yoshi-code-bot

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

[diff] [blame]

784

},

785

],

786

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

787

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

788

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

789

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

790

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

791

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

792

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

793

{

794

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

795

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

796

},

797

],

798

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

},

}</pre>

</div>

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

805

<pre>Retrieves the next page of results.

806

807

Args:

808

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

809

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

810

811

Returns:

812

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

813

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

</pre>

</div>

yoshi-code-bot

2021-03-31 13:33:30 -0700

[diff] [blame]

817

yoshi-code-bot