1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
|
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module AccessapprovalV1
# Access Approval API
#
# An API for controlling access to data by Google personnel.
#
# @example
# require 'google/apis/accessapproval_v1'
#
# Accessapproval = Google::Apis::AccessapprovalV1 # Alias the module
# service = Accessapproval::AccessApprovalService.new
#
# @see https://cloud.google.com/access-approval/docs
class AccessApprovalService < Google::Apis::Core::BaseService
# @return [String]
# 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.
attr_accessor :key
# @return [String]
# 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.
attr_accessor :quota_user
def initialize
super('https://accessapproval.googleapis.com/', '')
@batch_path = 'batch'
end
# Deletes the settings associated with a project, folder, or organization. This
# will have the effect of disabling Access Approval for the project, folder, or
# organization, but only if all ancestors also have Access Approval disabled. If
# Access Approval is enabled at a higher level of the hierarchy, then Access
# Approval will still be enabled at this level as the settings are inherited.
# @param [String] name
# Name of the AccessApprovalSettings to delete.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_folder_access_approval_settings(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::AccessapprovalV1::Empty::Representation
command.response_class = Google::Apis::AccessapprovalV1::Empty
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
# Gets the settings associated with a project, folder, or organization.
# @param [String] name
# Name of the AccessApprovalSettings to retrieve.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::AccessApprovalSettings] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::AccessApprovalSettings]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_folder_access_approval_settings(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
command.response_class = Google::Apis::AccessapprovalV1::AccessApprovalSettings
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
# Updates the settings associated with a project, folder, or organization.
# Settings to update are determined by the value of field_mask.
# @param [String] name
# The resource name of the settings. Format is one of: * "projects/`project`/
# accessApprovalSettings" * "folders/`folder`/accessApprovalSettings" * "
# organizations/`organization`/accessApprovalSettings"
# @param [Google::Apis::AccessapprovalV1::AccessApprovalSettings] access_approval_settings_object
# @param [String] update_mask
# The update mask applies to the settings. Only the top level fields of
# AccessApprovalSettings (notification_emails & enrolled_services) are supported.
# For each field, if it is included, the currently stored value will be
# entirely overwritten with the value of the field passed in this request. For
# the `FieldMask` definition, see https://developers.google.com/protocol-buffers/
# docs/reference/google.protobuf#fieldmask If this field is left unset, only the
# notification_emails field will be updated.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::AccessApprovalSettings] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::AccessApprovalSettings]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_folder_access_approval_settings(name, access_approval_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+name}', options)
command.request_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
command.request_object = access_approval_settings_object
command.response_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
command.response_class = Google::Apis::AccessapprovalV1::AccessApprovalSettings
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
# Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND
# if the request does not exist. Returns FAILED_PRECONDITION if the request
# exists but is not in a pending state.
# @param [String] name
# Name of the approval request to approve.
# @param [Google::Apis::AccessapprovalV1::ApproveApprovalRequestMessage] approve_approval_request_message_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::ApprovalRequest] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::ApprovalRequest]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def approve_folder_approval_request(name, approve_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:approve', options)
command.request_representation = Google::Apis::AccessapprovalV1::ApproveApprovalRequestMessage::Representation
command.request_object = approve_approval_request_message_object
command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
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
# Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not
# deny access to the resource if another request has been made and approved. It
# is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND
# if the request does not exist. Returns FAILED_PRECONDITION if the request
# exists but is not in a pending state.
# @param [String] name
# Name of the ApprovalRequest to dismiss.
# @param [Google::Apis::AccessapprovalV1::DismissApprovalRequestMessage] dismiss_approval_request_message_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::ApprovalRequest] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::ApprovalRequest]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def dismiss_folder_approval_request(name, dismiss_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:dismiss', options)
command.request_representation = Google::Apis::AccessapprovalV1::DismissApprovalRequestMessage::Representation
command.request_object = dismiss_approval_request_message_object
command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
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
# Gets an approval request. Returns NOT_FOUND if the request does not exist.
# @param [String] name
# Name of the approval request to retrieve.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::ApprovalRequest] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::ApprovalRequest]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_folder_approval_request(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
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
# Lists approval requests associated with a project, folder, or organization.
# Approval requests can be filtered by state (pending, active, dismissed). The
# order is reverse chronological.
# @param [String] parent
# The parent resource. This may be "projects/`project`", "folders/`folder`", or "
# organizations/`organization`".
# @param [String] filter
# A filter on the type of approval requests to retrieve. Must be one of the
# following values: * [not set]: Requests that are pending or have active
# approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE:
# Only active (i.e. currently approved) requests. * DISMISSED: Only requests
# that have been dismissed, or requests that . are not approved and past
# expiration. * EXPIRED: Only requests that have been approved, and the approval
# has expired. * HISTORY: Active, dismissed and expired requests.
# @param [Fixnum] page_size
# Requested page size.
# @param [String] page_token
# A token identifying the page of results to return.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_folder_approval_requests(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/approvalRequests', options)
command.response_representation = Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse::Representation
command.response_class = Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.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
# Deletes the settings associated with a project, folder, or organization. This
# will have the effect of disabling Access Approval for the project, folder, or
# organization, but only if all ancestors also have Access Approval disabled. If
# Access Approval is enabled at a higher level of the hierarchy, then Access
# Approval will still be enabled at this level as the settings are inherited.
# @param [String] name
# Name of the AccessApprovalSettings to delete.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_organization_access_approval_settings(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::AccessapprovalV1::Empty::Representation
command.response_class = Google::Apis::AccessapprovalV1::Empty
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
# Gets the settings associated with a project, folder, or organization.
# @param [String] name
# Name of the AccessApprovalSettings to retrieve.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::AccessApprovalSettings] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::AccessApprovalSettings]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_access_approval_settings(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
command.response_class = Google::Apis::AccessapprovalV1::AccessApprovalSettings
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
# Updates the settings associated with a project, folder, or organization.
# Settings to update are determined by the value of field_mask.
# @param [String] name
# The resource name of the settings. Format is one of: * "projects/`project`/
# accessApprovalSettings" * "folders/`folder`/accessApprovalSettings" * "
# organizations/`organization`/accessApprovalSettings"
# @param [Google::Apis::AccessapprovalV1::AccessApprovalSettings] access_approval_settings_object
# @param [String] update_mask
# The update mask applies to the settings. Only the top level fields of
# AccessApprovalSettings (notification_emails & enrolled_services) are supported.
# For each field, if it is included, the currently stored value will be
# entirely overwritten with the value of the field passed in this request. For
# the `FieldMask` definition, see https://developers.google.com/protocol-buffers/
# docs/reference/google.protobuf#fieldmask If this field is left unset, only the
# notification_emails field will be updated.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::AccessApprovalSettings] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::AccessApprovalSettings]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_organization_access_approval_settings(name, access_approval_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+name}', options)
command.request_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
command.request_object = access_approval_settings_object
command.response_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
command.response_class = Google::Apis::AccessapprovalV1::AccessApprovalSettings
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
# Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND
# if the request does not exist. Returns FAILED_PRECONDITION if the request
# exists but is not in a pending state.
# @param [String] name
# Name of the approval request to approve.
# @param [Google::Apis::AccessapprovalV1::ApproveApprovalRequestMessage] approve_approval_request_message_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::ApprovalRequest] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::ApprovalRequest]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def approve_organization_approval_request(name, approve_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:approve', options)
command.request_representation = Google::Apis::AccessapprovalV1::ApproveApprovalRequestMessage::Representation
command.request_object = approve_approval_request_message_object
command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
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
# Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not
# deny access to the resource if another request has been made and approved. It
# is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND
# if the request does not exist. Returns FAILED_PRECONDITION if the request
# exists but is not in a pending state.
# @param [String] name
# Name of the ApprovalRequest to dismiss.
# @param [Google::Apis::AccessapprovalV1::DismissApprovalRequestMessage] dismiss_approval_request_message_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::ApprovalRequest] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::ApprovalRequest]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def dismiss_organization_approval_request(name, dismiss_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:dismiss', options)
command.request_representation = Google::Apis::AccessapprovalV1::DismissApprovalRequestMessage::Representation
command.request_object = dismiss_approval_request_message_object
command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
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
# Gets an approval request. Returns NOT_FOUND if the request does not exist.
# @param [String] name
# Name of the approval request to retrieve.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::ApprovalRequest] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::ApprovalRequest]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_organization_approval_request(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
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
# Lists approval requests associated with a project, folder, or organization.
# Approval requests can be filtered by state (pending, active, dismissed). The
# order is reverse chronological.
# @param [String] parent
# The parent resource. This may be "projects/`project`", "folders/`folder`", or "
# organizations/`organization`".
# @param [String] filter
# A filter on the type of approval requests to retrieve. Must be one of the
# following values: * [not set]: Requests that are pending or have active
# approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE:
# Only active (i.e. currently approved) requests. * DISMISSED: Only requests
# that have been dismissed, or requests that . are not approved and past
# expiration. * EXPIRED: Only requests that have been approved, and the approval
# has expired. * HISTORY: Active, dismissed and expired requests.
# @param [Fixnum] page_size
# Requested page size.
# @param [String] page_token
# A token identifying the page of results to return.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_organization_approval_requests(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/approvalRequests', options)
command.response_representation = Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse::Representation
command.response_class = Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.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
# Deletes the settings associated with a project, folder, or organization. This
# will have the effect of disabling Access Approval for the project, folder, or
# organization, but only if all ancestors also have Access Approval disabled. If
# Access Approval is enabled at a higher level of the hierarchy, then Access
# Approval will still be enabled at this level as the settings are inherited.
# @param [String] name
# Name of the AccessApprovalSettings to delete.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_access_approval_settings(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/{+name}', options)
command.response_representation = Google::Apis::AccessapprovalV1::Empty::Representation
command.response_class = Google::Apis::AccessapprovalV1::Empty
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
# Gets the settings associated with a project, folder, or organization.
# @param [String] name
# Name of the AccessApprovalSettings to retrieve.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::AccessApprovalSettings] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::AccessApprovalSettings]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_access_approval_settings(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
command.response_class = Google::Apis::AccessapprovalV1::AccessApprovalSettings
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
# Updates the settings associated with a project, folder, or organization.
# Settings to update are determined by the value of field_mask.
# @param [String] name
# The resource name of the settings. Format is one of: * "projects/`project`/
# accessApprovalSettings" * "folders/`folder`/accessApprovalSettings" * "
# organizations/`organization`/accessApprovalSettings"
# @param [Google::Apis::AccessapprovalV1::AccessApprovalSettings] access_approval_settings_object
# @param [String] update_mask
# The update mask applies to the settings. Only the top level fields of
# AccessApprovalSettings (notification_emails & enrolled_services) are supported.
# For each field, if it is included, the currently stored value will be
# entirely overwritten with the value of the field passed in this request. For
# the `FieldMask` definition, see https://developers.google.com/protocol-buffers/
# docs/reference/google.protobuf#fieldmask If this field is left unset, only the
# notification_emails field will be updated.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::AccessApprovalSettings] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::AccessApprovalSettings]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_project_access_approval_settings(name, access_approval_settings_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:patch, 'v1/{+name}', options)
command.request_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
command.request_object = access_approval_settings_object
command.response_representation = Google::Apis::AccessapprovalV1::AccessApprovalSettings::Representation
command.response_class = Google::Apis::AccessapprovalV1::AccessApprovalSettings
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
# Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND
# if the request does not exist. Returns FAILED_PRECONDITION if the request
# exists but is not in a pending state.
# @param [String] name
# Name of the approval request to approve.
# @param [Google::Apis::AccessapprovalV1::ApproveApprovalRequestMessage] approve_approval_request_message_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::ApprovalRequest] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::ApprovalRequest]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def approve_project_approval_request(name, approve_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:approve', options)
command.request_representation = Google::Apis::AccessapprovalV1::ApproveApprovalRequestMessage::Representation
command.request_object = approve_approval_request_message_object
command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
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
# Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not
# deny access to the resource if another request has been made and approved. It
# is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND
# if the request does not exist. Returns FAILED_PRECONDITION if the request
# exists but is not in a pending state.
# @param [String] name
# Name of the ApprovalRequest to dismiss.
# @param [Google::Apis::AccessapprovalV1::DismissApprovalRequestMessage] dismiss_approval_request_message_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::ApprovalRequest] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::ApprovalRequest]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def dismiss_project_approval_request(name, dismiss_approval_request_message_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+name}:dismiss', options)
command.request_representation = Google::Apis::AccessapprovalV1::DismissApprovalRequestMessage::Representation
command.request_object = dismiss_approval_request_message_object
command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
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
# Gets an approval request. Returns NOT_FOUND if the request does not exist.
# @param [String] name
# Name of the approval request to retrieve.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::ApprovalRequest] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::ApprovalRequest]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_approval_request(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::AccessapprovalV1::ApprovalRequest::Representation
command.response_class = Google::Apis::AccessapprovalV1::ApprovalRequest
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
# Lists approval requests associated with a project, folder, or organization.
# Approval requests can be filtered by state (pending, active, dismissed). The
# order is reverse chronological.
# @param [String] parent
# The parent resource. This may be "projects/`project`", "folders/`folder`", or "
# organizations/`organization`".
# @param [String] filter
# A filter on the type of approval requests to retrieve. Must be one of the
# following values: * [not set]: Requests that are pending or have active
# approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE:
# Only active (i.e. currently approved) requests. * DISMISSED: Only requests
# that have been dismissed, or requests that . are not approved and past
# expiration. * EXPIRED: Only requests that have been approved, and the approval
# has expired. * HISTORY: Active, dismissed and expired requests.
# @param [Fixnum] page_size
# Requested page size.
# @param [String] page_token
# A token identifying the page of results to return.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# 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.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_approval_requests(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+parent}/approvalRequests', options)
command.response_representation = Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse::Representation
command.response_class = Google::Apis::AccessapprovalV1::ListApprovalRequestsResponse
command.params['parent'] = parent unless parent.nil?
command.query['filter'] = filter unless filter.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
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
|