Blame - docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html - platform/external/python/google-api-python-client

<h1><a href="accesscontextmanager_v1.html">Access Context Manager API</a> . <a href="accesscontextmanager_v1.accessPolicies.html">accessPolicies</a> . <a href="accesscontextmanager_v1.accessPolicies.servicePerimeters.html">servicePerimeters</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>

79

<p class="firstline">Create an Service Perimeter. The</p>

80

81

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

82

<p class="firstline">Delete an Service Perimeter by resource</p>

83

84

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

85

<p class="firstline">Get an Service Perimeter by resource</p>

86

87

<code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>

88

<p class="firstline">List all Service Perimeters for an</p>

89

90

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

91

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

92

93

<code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p>

94

<p class="firstline">Update an Service Perimeter. The</p>

95

<h3>Method Details</h3>

96

97

<code class="details" id="create">create(parent, body, x__xgafv=None)</code>

98

<pre>Create an Service Perimeter. The

99

longrunning operation from this RPC will have a successful status once the

100

Service Perimeter has

101

propagated to long-lasting storage. Service Perimeters containing

102

errors will result in an error response for the first error encountered.

103

104

Args:

105

parent: string, Required. Resource name for the access policy which owns this Service

106

Perimeter.

107

108

Format: `accessPolicies/{policy_id}` (required)

109

body: object, The request body. (required)

110

The object takes the form of:

111

112

{ # `ServicePerimeter` describes a set of GCP resources which can freely import

113

# and export data amongst themselves, but not export outside of the

114

# `ServicePerimeter`. If a request with a source within this `ServicePerimeter`

115

# has a target outside of the `ServicePerimeter`, the request will be blocked.

116

# Otherwise the request is allowed. There are two types of Service Perimeter -

117

# Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP

118

# project can only belong to a single regular Service Perimeter. Service

119

# Perimeter Bridges can contain only GCP projects as members, a single GCP

120

# project may belong to multiple Service Perimeter Bridges.

121

"status": { # `ServicePerimeterConfig` specifies a set of GCP resources that describe # Current ServicePerimeter configuration. Specifies sets of resources,

122

# restricted services and access levels that determine perimeter

123

# content and boundaries.

124

# specific Service Perimeter configuration.

125

"restrictedServices": [ # GCP services that are subject to the Service Perimeter restrictions. For

126

# example, if `storage.googleapis.com` is specified, access to the storage

127

# buckets inside the perimeter must meet the perimeter's access restrictions.

128

"A String",

129

],

130

"resources": [ # A list of GCP resources that are inside of the service perimeter.

131

# Currently only projects are allowed. Format: `projects/{project_number}`

132

"A String",

133

],

134

"accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the

135

# `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed

136

# must be in the same policy as this `ServicePerimeter`. Referencing a

137

# nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are

138

# listed, resources within the perimeter can only be accessed via GCP calls

139

# with request origins within the perimeter. Example:

140

# `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.

141

# For Service Perimeter Bridge, must be empty.

"A String",

],

},

"updateTime": "A String", # Output only. Time the `ServicePerimeter` was updated in UTC.

146

"name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`

147

# component must begin with a letter and only include alphanumeric and '_'.

148

# Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`

149

"title": "A String", # Human readable title. Must be unique within the Policy.

150

"perimeterType": "A String", # Perimeter type indicator. A single project is

151

# allowed to be a member of single regular perimeter, but multiple service

152

# perimeter bridges. A project cannot be a included in a perimeter bridge

153

# without being included in regular perimeter. For perimeter bridges,

154

# the restricted service list as well as access level lists must be

155

# empty.

156

"createTime": "A String", # Output only. Time the `ServicePerimeter` was created in UTC.

157

"description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect

# behavior.

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

168

169

{ # This resource represents a long-running operation that is the result of a

170

# network API call.

171

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

172

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

173

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

174

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

175

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

176

},

177

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

178

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

179

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

180

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

181

#

182

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

183

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

184

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

185

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

186

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

187

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

188

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

189

# message types for APIs to use.

190

{

191

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

},

],

},

"done": True or False, # If the value is `false`, it means the operation is still in progress.

196

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

197

# available.

198

"response": { # The normal response of the operation in case of success. If the original

199

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

200

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

201

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

202

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

203

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

204

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

205

# `TakeSnapshotResponse`.

206

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

207

},

208

"name": "A String", # The server-assigned name, which is only unique within the same service that

209

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

210

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

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

216

<pre>Delete an Service Perimeter by resource

217

name. The longrunning operation from this RPC will have a successful status

218

once the Service Perimeter has been

219

removed from long-lasting storage.

Args:

Format:

`accessPolicies/{policy_id}/servicePerimeters/{service_perimeter_id}` (required)

226

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

233

234

{ # This resource represents a long-running operation that is the result of a

235

# network API call.

236

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

237

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

238

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

239

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

240

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

241

},

242

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

243

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

244

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

245

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

246

#

247

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

248

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

249

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

250

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

251

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

252

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

253

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

254

# message types for APIs to use.

255

{

256

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

},

],

},

"done": True or False, # If the value is `false`, it means the operation is still in progress.

261

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

262

# available.

263

"response": { # The normal response of the operation in case of success. If the original

264

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

265

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

266

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

267

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

268

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

269

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

270

# `TakeSnapshotResponse`.

271

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

272

},

273

"name": "A String", # The server-assigned name, which is only unique within the same service that

274

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

275

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

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

281

<pre>Get an Service Perimeter by resource

name.

Args:

Format:

`accessPolicies/{policy_id}/servicePerimeters/{service_perimeters_id}` (required)

289

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

296

297

{ # `ServicePerimeter` describes a set of GCP resources which can freely import

298

# and export data amongst themselves, but not export outside of the

299

# `ServicePerimeter`. If a request with a source within this `ServicePerimeter`

300

# has a target outside of the `ServicePerimeter`, the request will be blocked.

301

# Otherwise the request is allowed. There are two types of Service Perimeter -

302

# Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP

303

# project can only belong to a single regular Service Perimeter. Service

304

# Perimeter Bridges can contain only GCP projects as members, a single GCP

305

# project may belong to multiple Service Perimeter Bridges.

306

"status": { # `ServicePerimeterConfig` specifies a set of GCP resources that describe # Current ServicePerimeter configuration. Specifies sets of resources,

307

# restricted services and access levels that determine perimeter

308

# content and boundaries.

309

# specific Service Perimeter configuration.

310

"restrictedServices": [ # GCP services that are subject to the Service Perimeter restrictions. For

311

# example, if `storage.googleapis.com` is specified, access to the storage

312

# buckets inside the perimeter must meet the perimeter's access restrictions.

313

"A String",

314

],

315

"resources": [ # A list of GCP resources that are inside of the service perimeter.

316

# Currently only projects are allowed. Format: `projects/{project_number}`

317

"A String",

318

],

319

"accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the

320

# `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed

321

# must be in the same policy as this `ServicePerimeter`. Referencing a

322

# nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are

323

# listed, resources within the perimeter can only be accessed via GCP calls

324

# with request origins within the perimeter. Example:

325

# `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.

326

# For Service Perimeter Bridge, must be empty.

"A String",

],

},

"updateTime": "A String", # Output only. Time the `ServicePerimeter` was updated in UTC.

331

"name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`

332

# component must begin with a letter and only include alphanumeric and '_'.

333

# Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`

334

"title": "A String", # Human readable title. Must be unique within the Policy.

335

"perimeterType": "A String", # Perimeter type indicator. A single project is

336

# allowed to be a member of single regular perimeter, but multiple service

337

# perimeter bridges. A project cannot be a included in a perimeter bridge

338

# without being included in regular perimeter. For perimeter bridges,

339

# the restricted service list as well as access level lists must be

340

# empty.

341

"createTime": "A String", # Output only. Time the `ServicePerimeter` was created in UTC.

342

"description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect

# behavior.

}</pre>

</div>

<code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>

349

<pre>List all Service Perimeters for an

access policy.

Args:

parent: string, Required. Resource name for the access policy to list Service Perimeters from.

354

355

Format:

356

`accessPolicies/{policy_id}` (required)

357

pageToken: string, Next page token for the next batch of Service Perimeter instances.

358

Defaults to the first page of results.

359

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

pageSize: integer, Number of Service Perimeters to include

364

in the list. Default 100.

365

366

Returns:

367

An object of the form:

368

369

{ # A response to `ListServicePerimetersRequest`.

370

"nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is

371

# empty, no further results remain.

372

"servicePerimeters": [ # List of the Service Perimeter instances.

373

{ # `ServicePerimeter` describes a set of GCP resources which can freely import

374

# and export data amongst themselves, but not export outside of the

375

# `ServicePerimeter`. If a request with a source within this `ServicePerimeter`

376

# has a target outside of the `ServicePerimeter`, the request will be blocked.

377

# Otherwise the request is allowed. There are two types of Service Perimeter -

378

# Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP

379

# project can only belong to a single regular Service Perimeter. Service

380

# Perimeter Bridges can contain only GCP projects as members, a single GCP

381

# project may belong to multiple Service Perimeter Bridges.

382

"status": { # `ServicePerimeterConfig` specifies a set of GCP resources that describe # Current ServicePerimeter configuration. Specifies sets of resources,

383

# restricted services and access levels that determine perimeter

384

# content and boundaries.

385

# specific Service Perimeter configuration.

386

"restrictedServices": [ # GCP services that are subject to the Service Perimeter restrictions. For

387

# example, if `storage.googleapis.com` is specified, access to the storage

388

# buckets inside the perimeter must meet the perimeter's access restrictions.

389

"A String",

390

],

391

"resources": [ # A list of GCP resources that are inside of the service perimeter.

392

# Currently only projects are allowed. Format: `projects/{project_number}`

393

"A String",

394

],

395

"accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the

396

# `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed

397

# must be in the same policy as this `ServicePerimeter`. Referencing a

398

# nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are

399

# listed, resources within the perimeter can only be accessed via GCP calls

400

# with request origins within the perimeter. Example:

401

# `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.

402

# For Service Perimeter Bridge, must be empty.

"A String",

],

},

"updateTime": "A String", # Output only. Time the `ServicePerimeter` was updated in UTC.

407

"name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`

408

# component must begin with a letter and only include alphanumeric and '_'.

409

# Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`

410

"title": "A String", # Human readable title. Must be unique within the Policy.

411

"perimeterType": "A String", # Perimeter type indicator. A single project is

412

# allowed to be a member of single regular perimeter, but multiple service

413

# perimeter bridges. A project cannot be a included in a perimeter bridge

414

# without being included in regular perimeter. For perimeter bridges,

415

# the restricted service list as well as access level lists must be

416

# empty.

417

"createTime": "A String", # Output only. Time the `ServicePerimeter` was created in UTC.

418

"description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect

# behavior.

},

],

}</pre>

</div>

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

427

<pre>Retrieves the next page of results.

428

429

Args:

430

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

431

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

432

433

Returns:

434

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

435

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

</pre>

</div>

<code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code>

441

<pre>Update an Service Perimeter. The

442

longrunning operation from this RPC will have a successful status once the

443

changes to the Service Perimeter have

444

propagated to long-lasting storage. Service Perimeter containing

445

errors will result in an error response for the first error encountered.

Args:

component must begin with a letter and only include alphanumeric and '_'.

450

Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}` (required)

451

body: object, The request body. (required)

452

The object takes the form of:

453

454

{ # `ServicePerimeter` describes a set of GCP resources which can freely import

455

# and export data amongst themselves, but not export outside of the

456

# `ServicePerimeter`. If a request with a source within this `ServicePerimeter`

457

# has a target outside of the `ServicePerimeter`, the request will be blocked.

458

# Otherwise the request is allowed. There are two types of Service Perimeter -

459

# Regular and Bridge. Regular Service Perimeters cannot overlap, a single GCP

460

# project can only belong to a single regular Service Perimeter. Service

461

# Perimeter Bridges can contain only GCP projects as members, a single GCP

462

# project may belong to multiple Service Perimeter Bridges.

463

"status": { # `ServicePerimeterConfig` specifies a set of GCP resources that describe # Current ServicePerimeter configuration. Specifies sets of resources,

464

# restricted services and access levels that determine perimeter

465

# content and boundaries.

466

# specific Service Perimeter configuration.

467

"restrictedServices": [ # GCP services that are subject to the Service Perimeter restrictions. For

468

# example, if `storage.googleapis.com` is specified, access to the storage

469

# buckets inside the perimeter must meet the perimeter's access restrictions.

470

"A String",

471

],

472

"resources": [ # A list of GCP resources that are inside of the service perimeter.

473

# Currently only projects are allowed. Format: `projects/{project_number}`

474

"A String",

475

],

476

"accessLevels": [ # A list of `AccessLevel` resource names that allow resources within the

477

# `ServicePerimeter` to be accessed from the internet. `AccessLevels` listed

478

# must be in the same policy as this `ServicePerimeter`. Referencing a

479

# nonexistent `AccessLevel` is a syntax error. If no `AccessLevel` names are

480

# listed, resources within the perimeter can only be accessed via GCP calls

481

# with request origins within the perimeter. Example:

482

# `"accessPolicies/MY_POLICY/accessLevels/MY_LEVEL"`.

483

# For Service Perimeter Bridge, must be empty.

"A String",

],

},

"updateTime": "A String", # Output only. Time the `ServicePerimeter` was updated in UTC.

488

"name": "A String", # Required. Resource name for the ServicePerimeter. The `short_name`

489

# component must begin with a letter and only include alphanumeric and '_'.

490

# Format: `accessPolicies/{policy_id}/servicePerimeters/{short_name}`

491

"title": "A String", # Human readable title. Must be unique within the Policy.

492

"perimeterType": "A String", # Perimeter type indicator. A single project is

493

# allowed to be a member of single regular perimeter, but multiple service

494

# perimeter bridges. A project cannot be a included in a perimeter bridge

495

# without being included in regular perimeter. For perimeter bridges,

496

# the restricted service list as well as access level lists must be

497

# empty.

498

"createTime": "A String", # Output only. Time the `ServicePerimeter` was created in UTC.

499

"description": "A String", # Description of the `ServicePerimeter` and its use. Does not affect

# behavior.

}

updateMask: string, Required. Mask to control which fields get updated. Must be non-empty.

504

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

511

512

{ # This resource represents a long-running operation that is the result of a

513

# network API call.

514

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

515

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

516

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

517

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

518

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

519

},

520

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

521

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

522

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

523

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

524

#

525

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

526

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