Class: Google::Cloud::CloudControlsPartner::V1beta::CloudControlsPartnerCore::Client
- Inherits:
-
Object
- Object
- Google::Cloud::CloudControlsPartner::V1beta::CloudControlsPartnerCore::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/cloud_controls_partner/v1beta/cloud_controls_partner_core/client.rb
Overview
Client for the CloudControlsPartnerCore service.
Service describing handlers for resources
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the CloudControlsPartnerCore Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the CloudControlsPartnerCore Client instance.
-
#get_customer(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::CloudControlsPartner::V1beta::Customer
Gets details of a single customer.
-
#get_ekm_connections(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::CloudControlsPartner::V1beta::EkmConnections
Gets the EKM connections associated with a workload.
-
#get_partner(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::CloudControlsPartner::V1beta::Partner
Get details of a Partner.
-
#get_partner_permissions(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::CloudControlsPartner::V1beta::PartnerPermissions
Gets the partner permissions granted for a workload.
-
#get_workload(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::CloudControlsPartner::V1beta::Workload
Gets details of a single workload.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new CloudControlsPartnerCore client object.
-
#list_access_approval_requests(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CloudControlsPartner::V1beta::AccessApprovalRequest>
Lists access requests associated with a workload.
-
#list_customers(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CloudControlsPartner::V1beta::Customer>
Lists customers of a partner identified by its Google Cloud organization ID.
-
#list_workloads(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CloudControlsPartner::V1beta::Workload>
Lists customer workloads for a given customer org id.
-
#universe_domain ⇒ String
The effective universe domain.
Methods included from Paths
#customer_path, #ekm_connections_path, #organization_location_path, #partner_path, #partner_permissions_path, #workload_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new CloudControlsPartnerCore client object.
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 |
# File 'lib/google/cloud/cloud_controls_partner/v1beta/cloud_controls_partner_core/client.rb', line 156 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/cloudcontrolspartner/v1beta/core_services_pb" # 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 @cloud_controls_partner_core_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::CloudControlsPartner::V1beta::CloudControlsPartnerCore::Stub, credentials: credentials, endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the CloudControlsPartnerCore Client class.
See Configuration for a description of the configuration fields.
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 |
# File 'lib/google/cloud/cloud_controls_partner/v1beta/cloud_controls_partner_core/client.rb', line 59 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "CloudControlsPartner", "V1beta"] 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.get_workload.timeout = 60.0 default_config.rpcs.get_workload.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.list_workloads.timeout = 60.0 default_config.rpcs.list_workloads.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.get_customer.timeout = 60.0 default_config.rpcs.get_customer.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.list_customers.timeout = 60.0 default_config.rpcs.list_customers.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.get_ekm_connections.timeout = 60.0 default_config.rpcs.get_ekm_connections.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs..timeout = 60.0 default_config.rpcs..retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.list_access_approval_requests.timeout = 60.0 default_config.rpcs.list_access_approval_requests.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the CloudControlsPartnerCore 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.
126 127 128 129 |
# File 'lib/google/cloud/cloud_controls_partner/v1beta/cloud_controls_partner_core/client.rb', line 126 def configure yield @config if block_given? @config end |
#get_customer(request, options = nil) ⇒ ::Google::Cloud::CloudControlsPartner::V1beta::Customer #get_customer(name: nil) ⇒ ::Google::Cloud::CloudControlsPartner::V1beta::Customer
Gets details of a single customer
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 |
# File 'lib/google/cloud/cloud_controls_partner/v1beta/cloud_controls_partner_core/client.rb', line 431 def get_customer request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudControlsPartner::V1beta::GetCustomerRequest # 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_customer..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::Cloud::CloudControlsPartner::V1beta::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_customer.timeout, metadata: , retry_policy: @config.rpcs.get_customer.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @cloud_controls_partner_core_stub.call_rpc :get_customer, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#get_ekm_connections(request, options = nil) ⇒ ::Google::Cloud::CloudControlsPartner::V1beta::EkmConnections #get_ekm_connections(name: nil) ⇒ ::Google::Cloud::CloudControlsPartner::V1beta::EkmConnections
Gets the EKM connections associated with a workload
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 |
# File 'lib/google/cloud/cloud_controls_partner/v1beta/cloud_controls_partner_core/client.rb', line 618 def get_ekm_connections request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudControlsPartner::V1beta::GetEkmConnectionsRequest # 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_ekm_connections..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::Cloud::CloudControlsPartner::V1beta::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_ekm_connections.timeout, metadata: , retry_policy: @config.rpcs.get_ekm_connections.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @cloud_controls_partner_core_stub.call_rpc :get_ekm_connections, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#get_partner(request, options = nil) ⇒ ::Google::Cloud::CloudControlsPartner::V1beta::Partner #get_partner(name: nil) ⇒ ::Google::Cloud::CloudControlsPartner::V1beta::Partner
Get details of a Partner.
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 |
# File 'lib/google/cloud/cloud_controls_partner/v1beta/cloud_controls_partner_core/client.rb', line 893 def get_partner request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudControlsPartner::V1beta::GetPartnerRequest # 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_partner..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::Cloud::CloudControlsPartner::V1beta::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_partner.timeout, metadata: , retry_policy: @config.rpcs.get_partner.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @cloud_controls_partner_core_stub.call_rpc :get_partner, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#get_partner_permissions(request, options = nil) ⇒ ::Google::Cloud::CloudControlsPartner::V1beta::PartnerPermissions #get_partner_permissions(name: nil) ⇒ ::Google::Cloud::CloudControlsPartner::V1beta::PartnerPermissions
Gets the partner permissions granted for a workload
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 |
# File 'lib/google/cloud/cloud_controls_partner/v1beta/cloud_controls_partner_core/client.rb', line 704 def request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudControlsPartner::V1beta::GetPartnerPermissionsRequest # 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...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::Cloud::CloudControlsPartner::V1beta::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs..timeout, metadata: , retry_policy: @config.rpcs..retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @cloud_controls_partner_core_stub.call_rpc :get_partner_permissions, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#get_workload(request, options = nil) ⇒ ::Google::Cloud::CloudControlsPartner::V1beta::Workload #get_workload(name: nil) ⇒ ::Google::Cloud::CloudControlsPartner::V1beta::Workload
Gets details of a single workload
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 |
# File 'lib/google/cloud/cloud_controls_partner/v1beta/cloud_controls_partner_core/client.rb', line 243 def get_workload request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudControlsPartner::V1beta::GetWorkloadRequest # 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_workload..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::Cloud::CloudControlsPartner::V1beta::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_workload.timeout, metadata: , retry_policy: @config.rpcs.get_workload.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @cloud_controls_partner_core_stub.call_rpc :get_workload, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#list_access_approval_requests(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CloudControlsPartner::V1beta::AccessApprovalRequest> #list_access_approval_requests(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CloudControlsPartner::V1beta::AccessApprovalRequest>
Lists access requests associated with a workload
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 |
# File 'lib/google/cloud/cloud_controls_partner/v1beta/cloud_controls_partner_core/client.rb', line 807 def list_access_approval_requests request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudControlsPartner::V1beta::ListAccessApprovalRequestsRequest # 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_access_approval_requests..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::Cloud::CloudControlsPartner::V1beta::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_access_approval_requests.timeout, metadata: , retry_policy: @config.rpcs.list_access_approval_requests.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @cloud_controls_partner_core_stub.call_rpc :list_access_approval_requests, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @cloud_controls_partner_core_stub, :list_access_approval_requests, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#list_customers(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CloudControlsPartner::V1beta::Customer> #list_customers(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CloudControlsPartner::V1beta::Customer>
Lists customers of a partner identified by its Google Cloud organization ID
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 |
# File 'lib/google/cloud/cloud_controls_partner/v1beta/cloud_controls_partner_core/client.rb', line 531 def list_customers request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudControlsPartner::V1beta::ListCustomersRequest # 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_customers..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::Cloud::CloudControlsPartner::V1beta::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_customers.timeout, metadata: , retry_policy: @config.rpcs.list_customers.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @cloud_controls_partner_core_stub.call_rpc :list_customers, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @cloud_controls_partner_core_stub, :list_customers, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#list_workloads(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CloudControlsPartner::V1beta::Workload> #list_workloads(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::CloudControlsPartner::V1beta::Workload>
Lists customer workloads for a given customer org id
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 |
# File 'lib/google/cloud/cloud_controls_partner/v1beta/cloud_controls_partner_core/client.rb', line 344 def list_workloads request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::CloudControlsPartner::V1beta::ListWorkloadsRequest # 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_workloads..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::Cloud::CloudControlsPartner::V1beta::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_workloads.timeout, metadata: , retry_policy: @config.rpcs.list_workloads.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @cloud_controls_partner_core_stub.call_rpc :list_workloads, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @cloud_controls_partner_core_stub, :list_workloads, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#universe_domain ⇒ String
The effective universe domain
136 137 138 |
# File 'lib/google/cloud/cloud_controls_partner/v1beta/cloud_controls_partner_core/client.rb', line 136 def universe_domain @cloud_controls_partner_core_stub.universe_domain end |