Class: Google::Apis::AccesscontextmanagerV1beta::AccessContextManagerService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::AccesscontextmanagerV1beta::AccessContextManagerService
- Defined in:
- generated/google/apis/accesscontextmanager_v1beta/service.rb
Overview
Access Context Manager API
An API for setting attribute based access control to requests to GCP services.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#create_access_policy(access_policy_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Create an
AccessPolicy
. -
#create_access_policy_access_level(parent, access_level_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Create an Access Level.
-
#create_access_policy_service_perimeter(parent, service_perimeter_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Create a Service Perimeter.
-
#delete_access_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Delete an AccessPolicy by resource name.
-
#delete_access_policy_access_level(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Delete an Access Level by resource name.
-
#delete_access_policy_service_perimeter(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Delete a Service Perimeter by resource name.
-
#get_access_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::AccessPolicy
Get an AccessPolicy by name.
-
#get_access_policy_access_level(name, access_level_format: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::AccessLevel
Get an Access Level by resource name.
-
#get_access_policy_service_perimeter(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::ServicePerimeter
Get a Service Perimeter by resource name.
-
#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Gets the latest state of a long-running operation.
-
#initialize ⇒ AccessContextManagerService
constructor
A new instance of AccessContextManagerService.
-
#list_access_policies(page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::ListAccessPoliciesResponse
List all AccessPolicies under a container.
-
#list_access_policy_access_levels(parent, access_level_format: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::ListAccessLevelsResponse
List all Access Levels for an access policy.
-
#list_access_policy_service_perimeters(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::ListServicePerimetersResponse
List all Service Perimeters for an access policy.
-
#patch_access_policy(name, access_policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Update an AccessPolicy.
-
#patch_access_policy_access_level(name, access_level_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Update an Access Level.
-
#patch_access_policy_service_perimeter(name, service_perimeter_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Update a Service Perimeter.
Constructor Details
#initialize ⇒ AccessContextManagerService
Returns a new instance of AccessContextManagerService.
45 46 47 48 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 45 def initialize super('https://accesscontextmanager.googleapis.com/', '') @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
38 39 40 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
43 44 45 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 43 def quota_user @quota_user end |
Instance Method Details
#create_access_policy(access_policy_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Create an AccessPolicy
. Fails if this organization already has a
AccessPolicy
. The longrunning Operation will have a successful status once
the AccessPolicy
has propagated to long-lasting storage. Syntactic and basic
semantic errors will be returned in metadata
as a BadRequest proto.
72 73 74 75 76 77 78 79 80 81 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 72 def create_access_policy(access_policy_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta/accessPolicies', ) command.request_representation = Google::Apis::AccesscontextmanagerV1beta::AccessPolicy::Representation command.request_object = access_policy_object command.response_representation = Google::Apis::AccesscontextmanagerV1beta::Operation::Representation command.response_class = Google::Apis::AccesscontextmanagerV1beta::Operation command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_access_policy_access_level(parent, access_level_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Create an Access Level. The longrunning operation from this RPC will have a successful status once the Access Level has propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.
250 251 252 253 254 255 256 257 258 259 260 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 250 def create_access_policy_access_level(parent, access_level_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta/{+parent}/accessLevels', ) command.request_representation = Google::Apis::AccesscontextmanagerV1beta::AccessLevel::Representation command.request_object = access_level_object command.response_representation = Google::Apis::AccesscontextmanagerV1beta::Operation::Representation command.response_class = Google::Apis::AccesscontextmanagerV1beta::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#create_access_policy_service_perimeter(parent, service_perimeter_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Create a Service Perimeter. The longrunning operation from this RPC will have a successful status once the Service Perimeter has propagated to long-lasting storage. Service Perimeters containing errors will result in an error response for the first error encountered.
443 444 445 446 447 448 449 450 451 452 453 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 443 def create_access_policy_service_perimeter(parent, service_perimeter_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1beta/{+parent}/servicePerimeters', ) command.request_representation = Google::Apis::AccesscontextmanagerV1beta::ServicePerimeter::Representation command.request_object = service_perimeter_object command.response_representation = Google::Apis::AccesscontextmanagerV1beta::Operation::Representation command.response_class = Google::Apis::AccesscontextmanagerV1beta::Operation command.params['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_access_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Delete an AccessPolicy by resource name. The longrunning Operation will have a successful status once the AccessPolicy has been removed from long-lasting storage.
106 107 108 109 110 111 112 113 114 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 106 def delete_access_policy(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta/{+name}', ) command.response_representation = Google::Apis::AccesscontextmanagerV1beta::Operation::Representation command.response_class = Google::Apis::AccesscontextmanagerV1beta::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_access_policy_access_level(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Delete an Access Level by resource name. The longrunning operation from this RPC will have a successful status once the Access Level has been removed from long-lasting storage.
285 286 287 288 289 290 291 292 293 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 285 def delete_access_policy_access_level(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta/{+name}', ) command.response_representation = Google::Apis::AccesscontextmanagerV1beta::Operation::Representation command.response_class = Google::Apis::AccesscontextmanagerV1beta::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_access_policy_service_perimeter(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Delete a Service Perimeter by resource name. The longrunning operation from this RPC will have a successful status once the Service Perimeter has been removed from long-lasting storage.
478 479 480 481 482 483 484 485 486 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 478 def delete_access_policy_service_perimeter(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1beta/{+name}', ) command.response_representation = Google::Apis::AccesscontextmanagerV1beta::Operation::Representation command.response_class = Google::Apis::AccesscontextmanagerV1beta::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_access_policy(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::AccessPolicy
Get an AccessPolicy by name.
137 138 139 140 141 142 143 144 145 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 137 def get_access_policy(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta/{+name}', ) command.response_representation = Google::Apis::AccesscontextmanagerV1beta::AccessPolicy::Representation command.response_class = Google::Apis::AccesscontextmanagerV1beta::AccessPolicy command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_access_policy_access_level(name, access_level_format: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::AccessLevel
Get an Access Level by resource name.
322 323 324 325 326 327 328 329 330 331 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 322 def get_access_policy_access_level(name, access_level_format: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta/{+name}', ) command.response_representation = Google::Apis::AccesscontextmanagerV1beta::AccessLevel::Representation command.response_class = Google::Apis::AccesscontextmanagerV1beta::AccessLevel command.params['name'] = name unless name.nil? command.query['accessLevelFormat'] = access_level_format unless access_level_format.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_access_policy_service_perimeter(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::ServicePerimeter
Get a Service Perimeter by resource name.
509 510 511 512 513 514 515 516 517 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 509 def get_access_policy_service_perimeter(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta/{+name}', ) command.response_representation = Google::Apis::AccesscontextmanagerV1beta::ServicePerimeter::Representation command.response_class = Google::Apis::AccesscontextmanagerV1beta::ServicePerimeter command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
619 620 621 622 623 624 625 626 627 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 619 def get_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta/{+name}', ) command.response_representation = Google::Apis::AccesscontextmanagerV1beta::Operation::Representation command.response_class = Google::Apis::AccesscontextmanagerV1beta::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_access_policies(page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::ListAccessPoliciesResponse
List all AccessPolicies under a container.
173 174 175 176 177 178 179 180 181 182 183 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 173 def list_access_policies(page_size: nil, page_token: nil, parent: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta/accessPolicies', ) command.response_representation = Google::Apis::AccesscontextmanagerV1beta::ListAccessPoliciesResponse::Representation command.response_class = Google::Apis::AccesscontextmanagerV1beta::ListAccessPoliciesResponse command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['parent'] = parent unless parent.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_access_policy_access_levels(parent, access_level_format: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::ListAccessLevelsResponse
List all Access Levels for an access policy.
363 364 365 366 367 368 369 370 371 372 373 374 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 363 def list_access_policy_access_levels(parent, access_level_format: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta/{+parent}/accessLevels', ) command.response_representation = Google::Apis::AccesscontextmanagerV1beta::ListAccessLevelsResponse::Representation command.response_class = Google::Apis::AccesscontextmanagerV1beta::ListAccessLevelsResponse command.params['parent'] = parent unless parent.nil? command.query['accessLevelFormat'] = access_level_format unless access_level_format.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_access_policy_service_perimeters(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::ListServicePerimetersResponse
List all Service Perimeters for an access policy.
545 546 547 548 549 550 551 552 553 554 555 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 545 def list_access_policy_service_perimeters(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta/{+parent}/servicePerimeters', ) command.response_representation = Google::Apis::AccesscontextmanagerV1beta::ListServicePerimetersResponse::Representation command.response_class = Google::Apis::AccesscontextmanagerV1beta::ListServicePerimetersResponse command.params['parent'] = parent unless parent.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_access_policy(name, access_policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Update an AccessPolicy. The longrunning Operation from this RPC will have a
successful status once the changes to the AccessPolicy have propagated to long-
lasting storage. Syntactic and basic semantic errors will be returned in
metadata
as a BadRequest proto.
212 213 214 215 216 217 218 219 220 221 222 223 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 212 def patch_access_policy(name, access_policy_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1beta/{+name}', ) command.request_representation = Google::Apis::AccesscontextmanagerV1beta::AccessPolicy::Representation command.request_object = access_policy_object command.response_representation = Google::Apis::AccesscontextmanagerV1beta::Operation::Representation command.response_class = Google::Apis::AccesscontextmanagerV1beta::Operation command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_access_policy_access_level(name, access_level_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Update an Access Level. The longrunning operation from this RPC will have a successful status once the changes to the Access Level have propagated to long- lasting storage. Access Levels containing errors will result in an error response for the first error encountered.
405 406 407 408 409 410 411 412 413 414 415 416 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 405 def patch_access_policy_access_level(name, access_level_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1beta/{+name}', ) command.request_representation = Google::Apis::AccesscontextmanagerV1beta::AccessLevel::Representation command.request_object = access_level_object command.response_representation = Google::Apis::AccesscontextmanagerV1beta::Operation::Representation command.response_class = Google::Apis::AccesscontextmanagerV1beta::Operation command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_access_policy_service_perimeter(name, service_perimeter_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AccesscontextmanagerV1beta::Operation
Update a Service Perimeter. The longrunning operation from this RPC will have a successful status once the changes to the Service Perimeter have propagated to long-lasting storage. Service Perimeter containing errors will result in an error response for the first error encountered.
585 586 587 588 589 590 591 592 593 594 595 596 |
# File 'generated/google/apis/accesscontextmanager_v1beta/service.rb', line 585 def patch_access_policy_service_perimeter(name, service_perimeter_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1beta/{+name}', ) command.request_representation = Google::Apis::AccesscontextmanagerV1beta::ServicePerimeter::Representation command.request_object = service_perimeter_object command.response_representation = Google::Apis::AccesscontextmanagerV1beta::Operation::Representation command.response_class = Google::Apis::AccesscontextmanagerV1beta::Operation command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |