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

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

[diff] [blame]

78

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

79

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

Bu Sun Kim

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

[diff] [blame]

80

81

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

Dan O'Meara

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

[diff] [blame]

82

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

Bu Sun Kim

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

[diff] [blame]

83

84

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

Dan O'Meara

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

[diff] [blame]

85

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

Bu Sun Kim

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

[diff] [blame]

86

Bu Sun Kim

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

[diff] [blame]

87

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

Bu Sun Kim

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

[diff] [blame]

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

Dan O'Meara

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

[diff] [blame]

93

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

94

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

Bu Sun Kim

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

[diff] [blame]

95

<h3>Method Details</h3>

96

Dan O'Meara

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

[diff] [blame]

97

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

98

<pre>Create a Service Perimeter. The

Bu Sun Kim

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

[diff] [blame]

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)

Dan O'Meara

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

[diff] [blame]

109

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

110

The object takes the form of:

111

Dan O'Meara

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

[diff] [blame]

112

{ # `ServicePerimeter` describes a set of Google Cloud resources which can freely

Bu Sun Kim

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

[diff] [blame]

113

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

118

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

119

# Service Perimeter Bridges can contain only Google Cloud projects as members,

120

# a single Google Cloud project may belong to multiple Service Perimeter

121

# Bridges.

122

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

123

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

124

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

125

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

126

# behavior.

127

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

128

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

129

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

130

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

131

# restricted/unrestricted service lists as well as access lists must be

132

# empty.

133

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

134

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

135

# restricted/unrestricted services and access levels that determine perimeter

136

# content and boundaries.

137

# describe specific Service Perimeter configuration.

138

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

139

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

140

"A String",

141

],

142

"unrestrictedServices": [ # Google Cloud services that are not subject to the Service Perimeter

143

# restrictions. Deprecated. Must be set to a single wildcard "*".

144

#

145

# The wildcard means that unless explicitly specified by

146

# "restricted_services" list, any service is treated as unrestricted.

147

"A String",

148

],

149

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

150

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

151

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

152

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

153

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

154

# Cloud calls with request origins within the perimeter. Example:

155

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

156

# For Service Perimeter Bridge, must be empty.

157

"A String",

158

],

159

"restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter

160

# restrictions. Must contain a list of services. For example, if

161

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

162

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

163

"A String",

164

],

165

"vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.

166

# Perimeter.

167

"allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty

168

# unless 'enable_restriction' is True.

169

"A String",

Bu Sun Kim

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

[diff] [blame]

170

],

Bu Sun Kim

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

[diff] [blame]

171

"enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of

172

# APIs specified in 'allowed_services'.

Bu Sun Kim

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

[diff] [blame]

173

},

Bu Sun Kim

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

[diff] [blame]

174

},

175

}

Bu Sun Kim

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

[diff] [blame]

176

177

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

184

185

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

186

# network API call.

Bu Sun Kim

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

[diff] [blame]

187

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

Dan O'Meara

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

[diff] [blame]

188

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

189

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

190

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

191

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

192

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

193

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

194

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

195

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

Dan O'Meara

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

[diff] [blame]

196

},

Bu Sun Kim

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

[diff] [blame]

197

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

Dan O'Meara

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

[diff] [blame]

198

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

199

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

Bu Sun Kim

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

[diff] [blame]

200

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

201

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

202

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

203

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

204

#

205

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

206

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

207

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

208

# message types for APIs to use.

209

{

210

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

211

},

212

],

213

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

214

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

215

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

216

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

217

},

218

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

219

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

220

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

221

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

222

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

223

},

224

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

225

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

226

# available.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

Dan O'Meara

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

[diff] [blame]

232

<pre>Delete a Service Perimeter by resource

Bu Sun Kim

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

[diff] [blame]

233

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

234

once the Service Perimeter has been

235

removed from long-lasting storage.

Args:

Format:

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

242

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

249

250

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

251

# network API call.

Bu Sun Kim

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

[diff] [blame]

252

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

Dan O'Meara

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

[diff] [blame]

253

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

254

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

255

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

256

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

257

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

258

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

259

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

260

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

Dan O'Meara

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

[diff] [blame]

261

},

Bu Sun Kim

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

[diff] [blame]

262

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

Dan O'Meara

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

[diff] [blame]

263

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

264

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

Bu Sun Kim

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

[diff] [blame]

265

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

266

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

267

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

268

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

269

#

270

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

271

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

272

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

273

# message types for APIs to use.

274

{

275

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

276

},

277

],

278

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

279

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

280

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

281

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

282

},

283

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

284

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

285

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

286

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

287

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

288

},

289

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

290

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

291

# available.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

Dan O'Meara

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

[diff] [blame]

297

<pre>Get a Service Perimeter by resource

Bu Sun Kim

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

[diff] [blame]

name.

Args:

Format:

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

305

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

312

Dan O'Meara

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

[diff] [blame]

313

{ # `ServicePerimeter` describes a set of Google Cloud resources which can freely

Bu Sun Kim

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

[diff] [blame]

314

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

315

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

316

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

317

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

318

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

319

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

320

# Service Perimeter Bridges can contain only Google Cloud projects as members,

321

# a single Google Cloud project may belong to multiple Service Perimeter

322

# Bridges.

323

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

324

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

325

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

326

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

327

# behavior.

328

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

329

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

330

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

331

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

332

# restricted/unrestricted service lists as well as access lists must be

333

# empty.

334

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

335

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

336

# restricted/unrestricted services and access levels that determine perimeter

337

# content and boundaries.

338

# describe specific Service Perimeter configuration.

339

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

340

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

341

"A String",

342

],

343

"unrestrictedServices": [ # Google Cloud services that are not subject to the Service Perimeter

344

# restrictions. Deprecated. Must be set to a single wildcard "*".

345

#

346

# The wildcard means that unless explicitly specified by

347

# "restricted_services" list, any service is treated as unrestricted.

348

"A String",

349

],

350

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

351

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

352

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

353

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

354

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

355

# Cloud calls with request origins within the perimeter. Example:

356

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

357

# For Service Perimeter Bridge, must be empty.

358

"A String",

359

],

360

"restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter

361

# restrictions. Must contain a list of services. For example, if

362

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

363

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

364

"A String",

365

],

366

"vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.

367

# Perimeter.

368

"allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty

369

# unless 'enable_restriction' is True.

370

"A String",

Bu Sun Kim

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

[diff] [blame]

371

],

Bu Sun Kim

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

[diff] [blame]

372

"enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of

373

# APIs specified in 'allowed_services'.

Bu Sun Kim

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

[diff] [blame]

374

},

Bu Sun Kim

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

[diff] [blame]

375

},

376

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame]

380

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

Bu Sun Kim

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

[diff] [blame]

381

<pre>List all Service Perimeters for an

access policy.

Args:

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

386

387

Format:

388

`accessPolicies/{policy_id}` (required)

389

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

390

Defaults to the first page of results.

Bu Sun Kim

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

[diff] [blame]

391

pageSize: integer, Number of Service Perimeters to include

392

in the list. Default 100.

Bu Sun Kim

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

[diff] [blame]

393

x__xgafv: string, V1 error format.

394

Allowed values

395

1 - v1 error format

396

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

397

398

Returns:

399

An object of the form:

400

401

{ # A response to `ListServicePerimetersRequest`.

Bu Sun Kim

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

[diff] [blame]

402

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

Dan O'Meara

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

[diff] [blame]

403

{ # `ServicePerimeter` describes a set of Google Cloud resources which can freely

Bu Sun Kim

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

[diff] [blame]

404

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

405

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

406

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

407

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

408

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

409

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

410

# Service Perimeter Bridges can contain only Google Cloud projects as members,

411

# a single Google Cloud project may belong to multiple Service Perimeter

412

# Bridges.

413

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

414

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

415

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

416

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

417

# behavior.

418

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

419

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

420

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

421

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

422

# restricted/unrestricted service lists as well as access lists must be

423

# empty.

424

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

425

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

426

# restricted/unrestricted services and access levels that determine perimeter

427

# content and boundaries.

428

# describe specific Service Perimeter configuration.

429

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

430

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

431

"A String",

432

],

433

"unrestrictedServices": [ # Google Cloud services that are not subject to the Service Perimeter

434

# restrictions. Deprecated. Must be set to a single wildcard "*".

435

#

436

# The wildcard means that unless explicitly specified by

437

# "restricted_services" list, any service is treated as unrestricted.

438

"A String",

439

],

440

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

441

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

442

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

443

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

444

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

445

# Cloud calls with request origins within the perimeter. Example:

446

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

447

# For Service Perimeter Bridge, must be empty.

448

"A String",

449

],

450

"restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter

451

# restrictions. Must contain a list of services. For example, if

452

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

453

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

454

"A String",

455

],

456

"vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.

457

# Perimeter.

458

"allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty

459

# unless 'enable_restriction' is True.

460

"A String",

Bu Sun Kim

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

[diff] [blame]

461

],

Bu Sun Kim

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

[diff] [blame]

462

"enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of

463

# APIs specified in 'allowed_services'.

Bu Sun Kim

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

[diff] [blame]

464

},

Bu Sun Kim

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

[diff] [blame]

465

},

Bu Sun Kim

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

[diff] [blame]

466

},

Bu Sun Kim

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

[diff] [blame]

467

],

Bu Sun Kim

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

[diff] [blame]

468

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

469

# empty, no further results remain.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

475

<pre>Retrieves the next page of results.

476

477

Args:

478

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

479

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

480

481

Returns:

Bu Sun Kim

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

[diff] [blame]

482

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

Bu Sun Kim

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

[diff] [blame]

483

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

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

488

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

489

<pre>Update a Service Perimeter. The

Bu Sun Kim

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

[diff] [blame]

490

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

491

changes to the Service Perimeter have

492

propagated to long-lasting storage. Service Perimeter containing

493

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

Args:

Bu Sun Kim

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

[diff] [blame]

497

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

Bu Sun Kim

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

[diff] [blame]

498

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

Dan O'Meara

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

[diff] [blame]

499

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

500

The object takes the form of:

501

Dan O'Meara

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

[diff] [blame]

502

{ # `ServicePerimeter` describes a set of Google Cloud resources which can freely

Bu Sun Kim

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

[diff] [blame]

503

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

504

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

505

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

506

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

507

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

508

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

509

# Service Perimeter Bridges can contain only Google Cloud projects as members,

510

# a single Google Cloud project may belong to multiple Service Perimeter

511

# Bridges.

512

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

513

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

514

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

515

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

516

# behavior.

517

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

518

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

519

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

520

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

521

# restricted/unrestricted service lists as well as access lists must be

522

# empty.

523

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

524

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

525

# restricted/unrestricted services and access levels that determine perimeter

526

# content and boundaries.

527

# describe specific Service Perimeter configuration.

528

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

529

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

530

"A String",

531

],

532

"unrestrictedServices": [ # Google Cloud services that are not subject to the Service Perimeter

533

# restrictions. Deprecated. Must be set to a single wildcard "*".

534

#

535

# The wildcard means that unless explicitly specified by

536

# "restricted_services" list, any service is treated as unrestricted.

537

"A String",

538

],

539

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

540

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

541

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

542

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

543

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

544

# Cloud calls with request origins within the perimeter. Example:

545

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

546

# For Service Perimeter Bridge, must be empty.

547

"A String",

548

],

549

"restrictedServices": [ # Google Cloud services that are subject to the Service Perimeter

550

# restrictions. Must contain a list of services. For example, if

551

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

552

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

553

"A String",

554

],

555

"vpcAccessibleServices": { # Specifies how APIs are allowed to communicate within the Service # Beta. Configuration for APIs allowed within Perimeter.

556

# Perimeter.

557

"allowedServices": [ # The list of APIs usable within the Service Perimeter. Must be empty

558

# unless 'enable_restriction' is True.

559

"A String",

Bu Sun Kim

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

[diff] [blame]

560

],

Bu Sun Kim

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

[diff] [blame]

561

"enableRestriction": True or False, # Whether to restrict API calls within the Service Perimeter to the list of

562

# APIs specified in 'allowed_services'.

Bu Sun Kim

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

[diff] [blame]

563

},

Bu Sun Kim

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

[diff] [blame]

564

},

565

}

Bu Sun Kim

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

[diff] [blame]

566

567

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

568

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

575

576

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

577

# network API call.

Bu Sun Kim

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

[diff] [blame]

578

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

Dan O'Meara

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

[diff] [blame]

579

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

580

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

581

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

582

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

583

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

584

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

585

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

586

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

Dan O'Meara

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

[diff] [blame]

587

},

Bu Sun Kim

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

[diff] [blame]

588

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

Dan O'Meara

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

[diff] [blame]

589

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

590

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

Bu Sun Kim