Class: Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Rest::Client
- Inherits:
-
Object
- Object
- Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Rest::Client
- Includes:
- Paths
- Defined in:
- lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/client.rb
Overview
REST client for the SubscriptionsService service.
A service that manages subscriptions to Google Workspace events.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
-
#operations_client ⇒ ::Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Rest::Operations
readonly
Get the associated client for long-running operations.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the SubscriptionsService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the SubscriptionsService Client instance.
-
#create_subscription(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Operation
Creates a Google Workspace subscription.
-
#delete_subscription(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Operation
Deletes a Google Workspace subscription.
-
#get_subscription(request, options = nil) {|result, operation| ... } ⇒ ::Google::Apps::Events::Subscriptions::V1::Subscription
Gets details about a Google Workspace subscription.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new SubscriptionsService REST client object.
-
#list_subscriptions(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Events::Subscriptions::V1::Subscription>
Lists Google Workspace subscriptions.
-
#reactivate_subscription(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Operation
Reactivates a suspended Google Workspace subscription.
-
#universe_domain ⇒ String
The effective universe domain.
-
#update_subscription(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Operation
Updates or renews a Google Workspace subscription.
Methods included from Paths
#subscription_path, #topic_path, #user_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new SubscriptionsService REST client object.
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 |
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/client.rb', line 142 def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint.nil? || (@config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-")) credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = ::Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Rest::Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.universe_domain = @config.universe_domain end @subscriptions_service_stub = ::Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Rest::ServiceStub.new( endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, credentials: credentials ) end |
Instance Attribute Details
#operations_client ⇒ ::Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Rest::Operations (readonly)
Get the associated client for long-running operations.
185 186 187 |
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/client.rb', line 185 def operations_client @operations_client end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the SubscriptionsService Client class.
See Configuration for a description of the configuration fields.
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 |
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/client.rb', line 62 def self.configure @configure ||= begin namespace = ["Google", "Apps", "Events", "Subscriptions", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.create_subscription.timeout = 60.0 default_config.rpcs.delete_subscription.timeout = 60.0 default_config.rpcs.get_subscription.timeout = 60.0 default_config.rpcs.get_subscription.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.list_subscriptions.timeout = 60.0 default_config.rpcs.list_subscriptions.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.update_subscription.timeout = 60.0 default_config.rpcs.reactivate_subscription.timeout = 60.0 default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the SubscriptionsService Client instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.
See Configuration for a description of the configuration fields.
112 113 114 115 |
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/client.rb', line 112 def configure yield @config if block_given? @config end |
#create_subscription(request, options = nil) ⇒ ::Gapic::Operation #create_subscription(subscription: nil, validate_only: nil) ⇒ ::Gapic::Operation
Creates a Google Workspace subscription. To learn how to use this method, see Create a Google Workspace subscription.
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 |
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/client.rb', line 244 def create_subscription request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Events::Subscriptions::V1::CreateSubscriptionRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_subscription..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Apps::Events::Subscriptions::V1::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.create_subscription.timeout, metadata: , retry_policy: @config.rpcs.create_subscription.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @subscriptions_service_stub.create_subscription request, do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#delete_subscription(request, options = nil) ⇒ ::Gapic::Operation #delete_subscription(name: nil, validate_only: nil, allow_missing: nil, etag: nil) ⇒ ::Gapic::Operation
Deletes a Google Workspace subscription. To learn how to use this method, see Delete a Google Workspace subscription.
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 |
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/client.rb', line 345 def delete_subscription request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Events::Subscriptions::V1::DeleteSubscriptionRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_subscription..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Apps::Events::Subscriptions::V1::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.delete_subscription.timeout, metadata: , retry_policy: @config.rpcs.delete_subscription.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @subscriptions_service_stub.delete_subscription request, do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#get_subscription(request, options = nil) ⇒ ::Google::Apps::Events::Subscriptions::V1::Subscription #get_subscription(name: nil) ⇒ ::Google::Apps::Events::Subscriptions::V1::Subscription
Gets details about a Google Workspace subscription. To learn how to use this method, see Get details about a Google Workspace subscription.
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 |
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/client.rb', line 428 def get_subscription request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Events::Subscriptions::V1::GetSubscriptionRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_subscription..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Apps::Events::Subscriptions::V1::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.get_subscription.timeout, metadata: , retry_policy: @config.rpcs.get_subscription.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @subscriptions_service_stub.get_subscription request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#list_subscriptions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Events::Subscriptions::V1::Subscription> #list_subscriptions(page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Apps::Events::Subscriptions::V1::Subscription>
Lists Google Workspace subscriptions. To learn how to use this method, see List Google Workspace subscriptions.
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 |
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/client.rb', line 553 def list_subscriptions request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Events::Subscriptions::V1::ListSubscriptionsRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_subscriptions..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Apps::Events::Subscriptions::V1::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.list_subscriptions.timeout, metadata: , retry_policy: @config.rpcs.list_subscriptions.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @subscriptions_service_stub.list_subscriptions request, do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @subscriptions_service_stub, :list_subscriptions, "subscriptions", request, result, yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#reactivate_subscription(request, options = nil) ⇒ ::Gapic::Operation #reactivate_subscription(name: nil) ⇒ ::Gapic::Operation
Reactivates a suspended Google Workspace subscription.
This method resets your subscription's State
field to ACTIVE
. Before
you use this method, you must fix the error that suspended the
subscription. To learn how to use this method, see Reactivate a Google
Workspace
subscription.
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 |
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/client.rb', line 751 def reactivate_subscription request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Events::Subscriptions::V1::ReactivateSubscriptionRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.reactivate_subscription..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Apps::Events::Subscriptions::V1::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.reactivate_subscription.timeout, metadata: , retry_policy: @config.rpcs.reactivate_subscription.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @subscriptions_service_stub.reactivate_subscription request, do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#universe_domain ⇒ String
The effective universe domain
122 123 124 |
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/client.rb', line 122 def universe_domain @subscriptions_service_stub.universe_domain end |
#update_subscription(request, options = nil) ⇒ ::Gapic::Operation #update_subscription(subscription: nil, update_mask: nil, validate_only: nil) ⇒ ::Gapic::Operation
Updates or renews a Google Workspace subscription. To learn how to use this method, see Update or renew a Google Workspace subscription.
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 |
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/rest/client.rb', line 657 def update_subscription request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Events::Subscriptions::V1::UpdateSubscriptionRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_subscription..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Apps::Events::Subscriptions::V1::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.update_subscription.timeout, metadata: , retry_policy: @config.rpcs.update_subscription.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @subscriptions_service_stub.update_subscription request, do |result, operation| result = ::Gapic::Operation.new result, @operations_client, options: yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |