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 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
|
# 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 ServicemanagementV1
# Service Management API
#
# Google Service Management allows service producers to publish their services
# on Google Cloud Platform so that they can be discovered and used by service
# consumers.
#
# @example
# require 'google/apis/servicemanagement_v1'
#
# Servicemanagement = Google::Apis::ServicemanagementV1 # Alias the module
# service = Servicemanagement::ServiceManagementService.new
#
# @see https://cloud.google.com/service-management/
class ServiceManagementService < 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://servicemanagement.googleapis.com/', '')
@batch_path = 'batch'
end
# 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.
# @param [String] name
# The name of the operation resource.
# @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::ServicemanagementV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::Operation]
#
# @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_operation(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/{+name}', options)
command.response_representation = Google::Apis::ServicemanagementV1::Operation::Representation
command.response_class = Google::Apis::ServicemanagementV1::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
# Lists service operations that match the specified filter in the request.
# @param [String] filter
# A string for filtering Operations.
# The following filter fields are supported:
# * serviceName: Required. Only `=` operator is allowed.
# * startTime: The time this job was started, in ISO 8601 format.
# Allowed operators are `>=`, `>`, `<=`, and `<`.
# * status: Can be `done`, `in_progress`, or `failed`. Allowed
# operators are `=`, and `!=`.
# Filter expression supports conjunction (AND) and disjunction (OR)
# logical operators. However, the serviceName restriction must be at the
# top-level and can only be combined with other restrictions via the AND
# logical operator.
# Examples:
# * `serviceName=`some-service`.googleapis.com`
# * `serviceName=`some-service`.googleapis.com AND startTime>="2017-02-01"`
# * `serviceName=`some-service`.googleapis.com AND status=done`
# * `serviceName=`some-service`.googleapis.com AND (status=done OR startTime>="
# 2017-02-01")`
# @param [String] name
# Not used.
# @param [Fixnum] page_size
# The maximum number of operations to return. If unspecified, defaults to
# 50. The maximum value is 100.
# @param [String] page_token
# The standard list page token.
# @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::ServicemanagementV1::ListOperationsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::ListOperationsResponse]
#
# @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_operations(filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/operations', options)
command.response_representation = Google::Apis::ServicemanagementV1::ListOperationsResponse::Representation
command.response_class = Google::Apis::ServicemanagementV1::ListOperationsResponse
command.query['filter'] = filter unless filter.nil?
command.query['name'] = name unless name.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
# Creates a new managed service.
# Please note one producer project can own no more than 20 services.
# Operation<response: ManagedService>
# @param [Google::Apis::ServicemanagementV1::ManagedService] managed_service_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::ServicemanagementV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::Operation]
#
# @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 create_service(managed_service_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/services', options)
command.request_representation = Google::Apis::ServicemanagementV1::ManagedService::Representation
command.request_object = managed_service_object
command.response_representation = Google::Apis::ServicemanagementV1::Operation::Representation
command.response_class = Google::Apis::ServicemanagementV1::Operation
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a managed service. This method will change the service to the
# `Soft-Delete` state for 30 days. Within this period, service producers may
# call UndeleteService to restore the service.
# After 30 days, the service will be permanently deleted.
# Operation<response: google.protobuf.Empty>
# @param [String] service_name
# Required. The name of the service. See the [overview](/service-management/
# overview)
# for naming requirements. For example: `example.googleapis.com`.
# @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::ServicemanagementV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::Operation]
#
# @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_service(service_name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1/services/{serviceName}', options)
command.response_representation = Google::Apis::ServicemanagementV1::Operation::Representation
command.response_class = Google::Apis::ServicemanagementV1::Operation
command.params['serviceName'] = service_name unless service_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
# Disables a service for a project, so it can no longer be
# be used for the project. It prevents accidental usage that may cause
# unexpected billing charges or security leaks.
# Operation<response: DisableServiceResponse>
# @param [String] service_name
# Required. Name of the service to disable. Specifying an unknown service name
# will cause the request to fail.
# @param [Google::Apis::ServicemanagementV1::DisableServiceRequest] disable_service_request_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::ServicemanagementV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::Operation]
#
# @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 disable_service(service_name, disable_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/services/{serviceName}:disable', options)
command.request_representation = Google::Apis::ServicemanagementV1::DisableServiceRequest::Representation
command.request_object = disable_service_request_object
command.response_representation = Google::Apis::ServicemanagementV1::Operation::Representation
command.response_class = Google::Apis::ServicemanagementV1::Operation
command.params['serviceName'] = service_name unless service_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
# Enables a service for a project, so it can be used
# for the project. See
# [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for
# more information.
# Operation<response: EnableServiceResponse>
# @param [String] service_name
# Required. Name of the service to enable. Specifying an unknown service name
# will
# cause the request to fail.
# @param [Google::Apis::ServicemanagementV1::EnableServiceRequest] enable_service_request_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::ServicemanagementV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::Operation]
#
# @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 enable_service(service_name, enable_service_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/services/{serviceName}:enable', options)
command.request_representation = Google::Apis::ServicemanagementV1::EnableServiceRequest::Representation
command.request_object = enable_service_request_object
command.response_representation = Google::Apis::ServicemanagementV1::Operation::Representation
command.response_class = Google::Apis::ServicemanagementV1::Operation
command.params['serviceName'] = service_name unless service_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
# Generates and returns a report (errors, warnings and changes from
# existing configurations) associated with
# GenerateConfigReportRequest.new_value
# If GenerateConfigReportRequest.old_value is specified,
# GenerateConfigReportRequest will contain a single ChangeReport based on the
# comparison between GenerateConfigReportRequest.new_value and
# GenerateConfigReportRequest.old_value.
# If GenerateConfigReportRequest.old_value is not specified, this method
# will compare GenerateConfigReportRequest.new_value with the last pushed
# service configuration.
# @param [Google::Apis::ServicemanagementV1::GenerateConfigReportRequest] generate_config_report_request_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::ServicemanagementV1::GenerateConfigReportResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::GenerateConfigReportResponse]
#
# @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 generate_service_config_report(generate_config_report_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/services:generateConfigReport', options)
command.request_representation = Google::Apis::ServicemanagementV1::GenerateConfigReportRequest::Representation
command.request_object = generate_config_report_request_object
command.response_representation = Google::Apis::ServicemanagementV1::GenerateConfigReportResponse::Representation
command.response_class = Google::Apis::ServicemanagementV1::GenerateConfigReportResponse
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets a managed service. Authentication is required unless the service is
# public.
# @param [String] service_name
# Required. The name of the service. See the `ServiceManager` overview for
# naming
# requirements. For example: `example.googleapis.com`.
# @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::ServicemanagementV1::ManagedService] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::ManagedService]
#
# @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_service(service_name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/services/{serviceName}', options)
command.response_representation = Google::Apis::ServicemanagementV1::ManagedService::Representation
command.response_class = Google::Apis::ServicemanagementV1::ManagedService
command.params['serviceName'] = service_name unless service_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 a service configuration (version) for a managed service.
# @param [String] service_name
# Required. The name of the service. See the [overview](/service-management/
# overview)
# for naming requirements. For example: `example.googleapis.com`.
# @param [String] config_id
# Required. The id of the service configuration resource.
# This field must be specified for the server to return all fields, including
# `SourceInfo`.
# @param [String] view
# Specifies which parts of the Service Config should be returned in the
# response.
# @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::ServicemanagementV1::Service] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::Service]
#
# @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_service_configuration(service_name, config_id: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/services/{serviceName}/config', options)
command.response_representation = Google::Apis::ServicemanagementV1::Service::Representation
command.response_class = Google::Apis::ServicemanagementV1::Service
command.params['serviceName'] = service_name unless service_name.nil?
command.query['configId'] = config_id unless config_id.nil?
command.query['view'] = view unless view.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 access control policy for a resource.
# Returns an empty policy if the resource exists and does not have a policy
# set.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested.
# See the operation documentation for the appropriate value for this field.
# @param [Google::Apis::ServicemanagementV1::GetIamPolicyRequest] get_iam_policy_request_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::ServicemanagementV1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::Policy]
#
# @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_service_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
command.request_representation = Google::Apis::ServicemanagementV1::GetIamPolicyRequest::Representation
command.request_object = get_iam_policy_request_object
command.response_representation = Google::Apis::ServicemanagementV1::Policy::Representation
command.response_class = Google::Apis::ServicemanagementV1::Policy
command.params['resource'] = resource unless resource.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 managed services.
# Returns all public services. For authenticated users, also returns all
# services the calling user has "servicemanagement.services.get" permission
# for.
# **BETA:** If the caller specifies the `consumer_id`, it returns only the
# services enabled on the consumer. The `consumer_id` must have the format
# of "project:`PROJECT-ID`".
# @param [String] consumer_id
# Include services consumed by the specified consumer.
# The Google Service Management implementation accepts the following
# forms:
# - project:<project_id>
# @param [Fixnum] page_size
# The max number of items to include in the response list. Page size is 50
# if not specified. Maximum value is 100.
# @param [String] page_token
# Token identifying which result to start with; returned by a previous list
# call.
# @param [String] producer_project_id
# Include services produced by the specified project.
# @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::ServicemanagementV1::ListServicesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::ListServicesResponse]
#
# @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_services(consumer_id: nil, page_size: nil, page_token: nil, producer_project_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/services', options)
command.response_representation = Google::Apis::ServicemanagementV1::ListServicesResponse::Representation
command.response_class = Google::Apis::ServicemanagementV1::ListServicesResponse
command.query['consumerId'] = consumer_id unless consumer_id.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['producerProjectId'] = producer_project_id unless producer_project_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the access control policy on the specified resource. Replaces any
# existing policy.
# Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified.
# See the operation documentation for the appropriate value for this field.
# @param [Google::Apis::ServicemanagementV1::SetIamPolicyRequest] set_iam_policy_request_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::ServicemanagementV1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::Policy]
#
# @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 set_service_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::ServicemanagementV1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::ServicemanagementV1::Policy::Representation
command.response_class = Google::Apis::ServicemanagementV1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns permissions that a caller has on the specified resource.
# If the resource does not exist, this will return an empty set of
# permissions, not a NOT_FOUND error.
# Note: This operation is designed to be used for building permission-aware
# UIs and command-line tools, not for authorization checking. This operation
# may "fail open" without warning.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
# See the operation documentation for the appropriate value for this field.
# @param [Google::Apis::ServicemanagementV1::TestIamPermissionsRequest] test_iam_permissions_request_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::ServicemanagementV1::TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::TestIamPermissionsResponse]
#
# @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 test_service_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::ServicemanagementV1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::ServicemanagementV1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::ServicemanagementV1::TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Revives a previously deleted managed service. The method restores the
# service using the configuration at the time the service was deleted.
# The target service must exist and must have been deleted within the
# last 30 days.
# Operation<response: UndeleteServiceResponse>
# @param [String] service_name
# Required. The name of the service. See the [overview](/service-management/
# overview)
# for naming requirements. For example: `example.googleapis.com`.
# @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::ServicemanagementV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::Operation]
#
# @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 undelete_service(service_name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/services/{serviceName}:undelete', options)
command.response_representation = Google::Apis::ServicemanagementV1::Operation::Representation
command.response_class = Google::Apis::ServicemanagementV1::Operation
command.params['serviceName'] = service_name unless service_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
# Creates a new service configuration (version) for a managed service.
# This method only stores the service configuration. To roll out the service
# configuration to backend systems please call
# CreateServiceRollout.
# Only the 100 most recent service configurations and ones referenced by
# existing rollouts are kept for each service. The rest will be deleted
# eventually.
# @param [String] service_name
# Required. The name of the service. See the [overview](/service-management/
# overview)
# for naming requirements. For example: `example.googleapis.com`.
# @param [Google::Apis::ServicemanagementV1::Service] service_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::ServicemanagementV1::Service] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::Service]
#
# @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 create_service_config(service_name, service_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/services/{serviceName}/configs', options)
command.request_representation = Google::Apis::ServicemanagementV1::Service::Representation
command.request_object = service_object
command.response_representation = Google::Apis::ServicemanagementV1::Service::Representation
command.response_class = Google::Apis::ServicemanagementV1::Service
command.params['serviceName'] = service_name unless service_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 a service configuration (version) for a managed service.
# @param [String] service_name
# Required. The name of the service. See the [overview](/service-management/
# overview)
# for naming requirements. For example: `example.googleapis.com`.
# @param [String] config_id
# Required. The id of the service configuration resource.
# This field must be specified for the server to return all fields, including
# `SourceInfo`.
# @param [String] view
# Specifies which parts of the Service Config should be returned in the
# response.
# @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::ServicemanagementV1::Service] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::Service]
#
# @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_service_config(service_name, config_id, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/services/{serviceName}/configs/{configId}', options)
command.response_representation = Google::Apis::ServicemanagementV1::Service::Representation
command.response_class = Google::Apis::ServicemanagementV1::Service
command.params['serviceName'] = service_name unless service_name.nil?
command.params['configId'] = config_id unless config_id.nil?
command.query['view'] = view unless view.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 the history of the service configuration for a managed service,
# from the newest to the oldest.
# @param [String] service_name
# Required. The name of the service. See the [overview](/service-management/
# overview)
# for naming requirements. For example: `example.googleapis.com`.
# @param [Fixnum] page_size
# The max number of items to include in the response list. Page size is 50
# if not specified. Maximum value is 100.
# @param [String] page_token
# The token of the page 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::ServicemanagementV1::ListServiceConfigsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::ListServiceConfigsResponse]
#
# @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_service_configs(service_name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/services/{serviceName}/configs', options)
command.response_representation = Google::Apis::ServicemanagementV1::ListServiceConfigsResponse::Representation
command.response_class = Google::Apis::ServicemanagementV1::ListServiceConfigsResponse
command.params['serviceName'] = service_name unless service_name.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
# Creates a new service configuration (version) for a managed service based
# on
# user-supplied configuration source files (for example: OpenAPI
# Specification). This method stores the source configurations as well as the
# generated service configuration. To rollout the service configuration to
# other services,
# please call CreateServiceRollout.
# Only the 100 most recent configuration sources and ones referenced by
# existing service configurtions are kept for each service. The rest will be
# deleted eventually.
# Operation<response: SubmitConfigSourceResponse>
# @param [String] service_name
# Required. The name of the service. See the [overview](/service-management/
# overview)
# for naming requirements. For example: `example.googleapis.com`.
# @param [Google::Apis::ServicemanagementV1::SubmitConfigSourceRequest] submit_config_source_request_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::ServicemanagementV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::Operation]
#
# @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 submit_config_source(service_name, submit_config_source_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/services/{serviceName}/configs:submit', options)
command.request_representation = Google::Apis::ServicemanagementV1::SubmitConfigSourceRequest::Representation
command.request_object = submit_config_source_request_object
command.response_representation = Google::Apis::ServicemanagementV1::Operation::Representation
command.response_class = Google::Apis::ServicemanagementV1::Operation
command.params['serviceName'] = service_name unless service_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 access control policy for a resource.
# Returns an empty policy if the resource exists and does not have a policy
# set.
# @param [String] resource
# REQUIRED: The resource for which the policy is being requested.
# See the operation documentation for the appropriate value for this field.
# @param [Google::Apis::ServicemanagementV1::GetIamPolicyRequest] get_iam_policy_request_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::ServicemanagementV1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::Policy]
#
# @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_consumer_iam_policy(resource, get_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:getIamPolicy', options)
command.request_representation = Google::Apis::ServicemanagementV1::GetIamPolicyRequest::Representation
command.request_object = get_iam_policy_request_object
command.response_representation = Google::Apis::ServicemanagementV1::Policy::Representation
command.response_class = Google::Apis::ServicemanagementV1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Sets the access control policy on the specified resource. Replaces any
# existing policy.
# Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
# @param [String] resource
# REQUIRED: The resource for which the policy is being specified.
# See the operation documentation for the appropriate value for this field.
# @param [Google::Apis::ServicemanagementV1::SetIamPolicyRequest] set_iam_policy_request_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::ServicemanagementV1::Policy] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::Policy]
#
# @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 set_consumer_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
command.request_representation = Google::Apis::ServicemanagementV1::SetIamPolicyRequest::Representation
command.request_object = set_iam_policy_request_object
command.response_representation = Google::Apis::ServicemanagementV1::Policy::Representation
command.response_class = Google::Apis::ServicemanagementV1::Policy
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Returns permissions that a caller has on the specified resource.
# If the resource does not exist, this will return an empty set of
# permissions, not a NOT_FOUND error.
# Note: This operation is designed to be used for building permission-aware
# UIs and command-line tools, not for authorization checking. This operation
# may "fail open" without warning.
# @param [String] resource
# REQUIRED: The resource for which the policy detail is being requested.
# See the operation documentation for the appropriate value for this field.
# @param [Google::Apis::ServicemanagementV1::TestIamPermissionsRequest] test_iam_permissions_request_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::ServicemanagementV1::TestIamPermissionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::TestIamPermissionsResponse]
#
# @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 test_consumer_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
command.request_representation = Google::Apis::ServicemanagementV1::TestIamPermissionsRequest::Representation
command.request_object = test_iam_permissions_request_object
command.response_representation = Google::Apis::ServicemanagementV1::TestIamPermissionsResponse::Representation
command.response_class = Google::Apis::ServicemanagementV1::TestIamPermissionsResponse
command.params['resource'] = resource unless resource.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new service configuration rollout. Based on rollout, the
# Google Service Management will roll out the service configurations to
# different backend services. For example, the logging configuration will be
# pushed to Google Cloud Logging.
# Please note that any previous pending and running Rollouts and associated
# Operations will be automatically cancelled so that the latest Rollout will
# not be blocked by previous Rollouts.
# Only the 100 most recent (in any state) and the last 10 successful (if not
# already part of the set of 100 most recent) rollouts are kept for each
# service. The rest will be deleted eventually.
# Operation<response: Rollout>
# @param [String] service_name
# Required. The name of the service. See the [overview](/service-management/
# overview)
# for naming requirements. For example: `example.googleapis.com`.
# @param [Google::Apis::ServicemanagementV1::Rollout] rollout_object
# @param [String] base_rollout_id
# Unimplemented. Do not use this feature until this comment is removed.
# The rollout id that rollout to be created based on.
# Rollout should be constructed based on current successful rollout, this
# field indicates the current successful rollout id that new rollout based on
# to construct, if current successful rollout changed when server receives
# the request, request will be rejected for safety.
# @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::ServicemanagementV1::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::Operation]
#
# @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 create_service_rollout(service_name, rollout_object = nil, base_rollout_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1/services/{serviceName}/rollouts', options)
command.request_representation = Google::Apis::ServicemanagementV1::Rollout::Representation
command.request_object = rollout_object
command.response_representation = Google::Apis::ServicemanagementV1::Operation::Representation
command.response_class = Google::Apis::ServicemanagementV1::Operation
command.params['serviceName'] = service_name unless service_name.nil?
command.query['baseRolloutId'] = base_rollout_id unless base_rollout_id.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 a service configuration rollout.
# @param [String] service_name
# Required. The name of the service. See the [overview](/service-management/
# overview)
# for naming requirements. For example: `example.googleapis.com`.
# @param [String] rollout_id
# Required. The id of the rollout resource.
# @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::ServicemanagementV1::Rollout] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::Rollout]
#
# @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_service_rollout(service_name, rollout_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/services/{serviceName}/rollouts/{rolloutId}', options)
command.response_representation = Google::Apis::ServicemanagementV1::Rollout::Representation
command.response_class = Google::Apis::ServicemanagementV1::Rollout
command.params['serviceName'] = service_name unless service_name.nil?
command.params['rolloutId'] = rollout_id unless rollout_id.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 the history of the service configuration rollouts for a managed
# service, from the newest to the oldest.
# @param [String] service_name
# Required. The name of the service. See the [overview](/service-management/
# overview)
# for naming requirements. For example: `example.googleapis.com`.
# @param [String] filter
# Required. Use `filter` to return subset of rollouts.
# The following filters are supported:
# -- To limit the results to only those in
# [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',
# use filter='status=SUCCESS'
# -- To limit the results to those in
# [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'
# or 'FAILED', use filter='status=CANCELLED OR status=FAILED'
# @param [Fixnum] page_size
# The max number of items to include in the response list. Page size is 50
# if not specified. Maximum value is 100.
# @param [String] page_token
# The token of the page 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::ServicemanagementV1::ListServiceRolloutsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::ServicemanagementV1::ListServiceRolloutsResponse]
#
# @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_service_rollouts(service_name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1/services/{serviceName}/rollouts', options)
command.response_representation = Google::Apis::ServicemanagementV1::ListServiceRolloutsResponse::Representation
command.response_class = Google::Apis::ServicemanagementV1::ListServiceRolloutsResponse
command.params['serviceName'] = service_name unless service_name.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
|