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-27 12:20:54 -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

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

123

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

124

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

125

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

126

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

127

# empty.

128

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

129

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

130

# restricted/unrestricted services and access levels that determine perimeter

131

# content and boundaries.

132

# describe specific Service Perimeter configuration.

133

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

134

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

135

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

136

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

137

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

138

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

139

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

140

# For Service Perimeter Bridge, must be empty.

Bu Sun Kim

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

[diff] [blame]

141

"A String",

Bu Sun Kim

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

[diff] [blame]

142

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

143

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

144

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

145

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

146

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

147

"A String",

148

],

149

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

150

# Perimeter.

151

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

152

# APIs specified in 'allowed_services'.

153

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

154

# unless 'enable_restriction' is True.

"A String",

],

},

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

159

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

160

"A String",

161

],

162

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

163

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

164

#

165

# The wildcard means that unless explicitly specified by

166

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

167

"A String",

168

],

Bu Sun Kim

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

[diff] [blame]

169

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

170

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

171

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

172

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

173

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

174

# behavior.

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

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

188

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

189

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

Bu Sun Kim

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

[diff] [blame]

190

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

191

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

192

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

193

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

194

#

195

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

196

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

197

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

198

# message types for APIs to use.

199

{

200

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

201

},

202

],

203

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

204

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

205

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

206

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

207

},

208

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

209

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

210

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

211

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

212

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

213

},

214

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

215

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

216

# available.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

# `TakeSnapshotResponse`.

225

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

226

},

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

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

253

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

254

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

Bu Sun Kim

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

[diff] [blame]

255

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

256

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

257

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

258

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

259

#

260

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

261

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

262

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

263

# message types for APIs to use.

264

{

265

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

266

},

267

],

268

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

269

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

270

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

271

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

272

},

273

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

274

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

275

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

276

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

277

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

278

},

279

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

280

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

281

# available.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

282

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

283

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

284

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

285

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

286

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

287

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

288

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

289

# `TakeSnapshotResponse`.

290

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

291

},

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-27 12:20:54 -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

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

324

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

325

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

326

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

327

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

328

# empty.

329

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

330

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

331

# restricted/unrestricted services and access levels that determine perimeter

332

# content and boundaries.

333

# describe specific Service Perimeter configuration.

334

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

335

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

336

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

337

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

338

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

339

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

340

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

341

# For Service Perimeter Bridge, must be empty.

Bu Sun Kim

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

[diff] [blame]

342

"A String",

Bu Sun Kim

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

[diff] [blame]

343

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

344

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

345

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

346

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

347

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

348

"A String",

349

],

350

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

351

# Perimeter.

352

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

353

# APIs specified in 'allowed_services'.

354

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

355

# unless 'enable_restriction' is True.

"A String",

],

},

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

360

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

361

"A String",

362

],

363

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

364

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

365

#

366

# The wildcard means that unless explicitly specified by

367

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

368

"A String",

369

],

Bu Sun Kim

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

[diff] [blame]

370

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

371

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

372

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

373

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

374

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

375

# behavior.

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-27 12:20:54 -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

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

414

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

415

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

416

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

417

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

418

# empty.

419

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

420

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

421

# restricted/unrestricted services and access levels that determine perimeter

422

# content and boundaries.

423

# describe specific Service Perimeter configuration.

424

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

425

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

426

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

427

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

428

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

429

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

430

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

431

# For Service Perimeter Bridge, must be empty.

Bu Sun Kim

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

[diff] [blame]

432

"A String",

Bu Sun Kim

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

[diff] [blame]

433

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

434

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

435

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

436

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

437

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

438

"A String",

439

],

440

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

441

# Perimeter.

442

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

443

# APIs specified in 'allowed_services'.

444

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

445

# unless 'enable_restriction' is True.

"A String",

],

},

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

450

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

451

"A String",

452

],

453

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

454

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

455

#

456

# The wildcard means that unless explicitly specified by

457

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

458

"A String",

459

],

Bu Sun Kim

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

[diff] [blame]

460

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

461

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

462

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

463

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

464

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

465

# behavior.

Bu Sun Kim

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

[diff] [blame]

466

},

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-27 12:20:54 -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

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

513

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

514

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

515

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

516

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

517

# empty.

518

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

519

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

520

# restricted/unrestricted services and access levels that determine perimeter

521

# content and boundaries.

522

# describe specific Service Perimeter configuration.

523

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

524

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

525

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

526

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

527

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

528

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

529

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

530

# For Service Perimeter Bridge, must be empty.

Bu Sun Kim

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

[diff] [blame]

531

"A String",

Bu Sun Kim

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

[diff] [blame]

532

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

533

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

534

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

535

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

536

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

537

"A String",

538

],

539

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

540

# Perimeter.

541

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

542

# APIs specified in 'allowed_services'.

543

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

544

# unless 'enable_restriction' is True.

"A String",

],

},

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

549

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

550

"A String",

551

],

552

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

553

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

554

#

555

# The wildcard means that unless explicitly specified by

556

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

557

"A String",

558

],

Bu Sun Kim

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

[diff] [blame]

559

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

560

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

561

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

562

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

563

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

564

# behavior.

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

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

579

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

580

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

Bu Sun Kim

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

[diff] [blame]

581

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

582

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

583

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

584

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

585

#

586

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

587

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

588

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

589

# message types for APIs to use.

590

{

591

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

592

},

593

],

594

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

595

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

596

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

597

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

598

},

599

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

600

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

601

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

602

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

603

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

604

},

605

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

606

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

607

# available.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

608

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

609

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

610

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

611

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

612

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

613

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

614

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

615

# `TakeSnapshotResponse`.

616

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

617

},

Bu Sun Kim