Class: Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/beyond_corp/app_connectors/v1/app_connectors_service/client.rb
Overview
Client for the AppConnectorsService service.
API Overview:
The beyondcorp.googleapis.com
service implements the Google Cloud
BeyondCorp API.
Data Model:
The AppConnectorsService exposes the following resource:
- AppConnectors, named as follows:
projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}
.
The AppConnectorsService provides methods to manage (create/read/update/delete) BeyondCorp AppConnectors.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
-
#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Client
readonly
Get the associated client for mix-in of the IAMPolicy.
-
#location_client ⇒ Google::Cloud::Location::Locations::Client
readonly
Get the associated client for mix-in of the Locations.
-
#operations_client ⇒ ::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Operations
readonly
Get the associated client for long-running operations.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the AppConnectorsService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the AppConnectorsService Client instance.
-
#create_app_connector(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Creates a new AppConnector in a given project and location.
-
#delete_app_connector(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Deletes a single AppConnector.
-
#get_app_connector(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector
Gets details of a single AppConnector.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new AppConnectorsService client object.
-
#list_app_connectors(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector>
Lists AppConnectors in a given project and location.
-
#report_status(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Report status for a given connector.
-
#universe_domain ⇒ String
The effective universe domain.
-
#update_app_connector(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Updates the parameters of a single AppConnector.
Methods included from Paths
#app_connector_path, #location_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new AppConnectorsService client object.
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 |
# File 'lib/google/cloud/beyond_corp/app_connectors/v1/app_connectors_service/client.rb', line 137 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/beyondcorp/appconnectors/v1/app_connectors_service_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 @operations_client = Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.universe_domain = @config.universe_domain end @app_connectors_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::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 ) @location_client = Google::Cloud::Location::Locations::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @app_connectors_service_stub.endpoint config.universe_domain = @app_connectors_service_stub.universe_domain end @iam_policy_client = Google::Iam::V1::IAMPolicy::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @app_connectors_service_stub.endpoint config.universe_domain = @app_connectors_service_stub.universe_domain end end |
Instance Attribute Details
#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Client (readonly)
Get the associated client for mix-in of the IAMPolicy.
217 218 219 |
# File 'lib/google/cloud/beyond_corp/app_connectors/v1/app_connectors_service/client.rb', line 217 def iam_policy_client @iam_policy_client end |
#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)
Get the associated client for mix-in of the Locations.
210 211 212 |
# File 'lib/google/cloud/beyond_corp/app_connectors/v1/app_connectors_service/client.rb', line 210 def location_client @location_client end |
#operations_client ⇒ ::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Operations (readonly)
Get the associated client for long-running operations.
203 204 205 |
# File 'lib/google/cloud/beyond_corp/app_connectors/v1/app_connectors_service/client.rb', line 203 def operations_client @operations_client end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the AppConnectorsService Client class.
See Configuration for a description of the configuration fields.
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 |
# File 'lib/google/cloud/beyond_corp/app_connectors/v1/app_connectors_service/client.rb', line 75 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "BeyondCorp", "AppConnectors", "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 end yield @configure if block_given? @configure end |
Instance Method Details
#configure {|config| ... } ⇒ Client::Configuration
Configure the AppConnectorsService 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.
107 108 109 110 |
# File 'lib/google/cloud/beyond_corp/app_connectors/v1/app_connectors_service/client.rb', line 107 def configure yield @config if block_given? @config end |
#create_app_connector(request, options = nil) ⇒ ::Gapic::Operation #create_app_connector(parent: nil, app_connector_id: nil, app_connector: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation
Creates a new AppConnector in a given project and location.
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 |
# File 'lib/google/cloud/beyond_corp/app_connectors/v1/app_connectors_service/client.rb', line 492 def create_app_connector request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BeyondCorp::AppConnectors::V1::CreateAppConnectorRequest # 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_app_connector..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::BeyondCorp::AppConnectors::V1::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.create_app_connector.timeout, metadata: , retry_policy: @config.rpcs.create_app_connector.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @app_connectors_service_stub.call_rpc :create_app_connector, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#delete_app_connector(request, options = nil) ⇒ ::Gapic::Operation #delete_app_connector(name: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation
Deletes a single AppConnector.
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 |
# File 'lib/google/cloud/beyond_corp/app_connectors/v1/app_connectors_service/client.rb', line 720 def delete_app_connector request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BeyondCorp::AppConnectors::V1::DeleteAppConnectorRequest # 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_app_connector..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::BeyondCorp::AppConnectors::V1::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.delete_app_connector.timeout, metadata: , retry_policy: @config.rpcs.delete_app_connector.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @app_connectors_service_stub.call_rpc :delete_app_connector, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#get_app_connector(request, options = nil) ⇒ ::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector #get_app_connector(name: nil) ⇒ ::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector
Gets details of a single AppConnector.
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 |
# File 'lib/google/cloud/beyond_corp/app_connectors/v1/app_connectors_service/client.rb', line 374 def get_app_connector request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BeyondCorp::AppConnectors::V1::GetAppConnectorRequest # 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_app_connector..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::BeyondCorp::AppConnectors::V1::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_app_connector.timeout, metadata: , retry_policy: @config.rpcs.get_app_connector.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @app_connectors_service_stub.call_rpc :get_app_connector, 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_app_connectors(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector> #list_app_connectors(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector>
Lists AppConnectors in a given project and location.
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 |
# File 'lib/google/cloud/beyond_corp/app_connectors/v1/app_connectors_service/client.rb', line 287 def list_app_connectors request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BeyondCorp::AppConnectors::V1::ListAppConnectorsRequest # 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_app_connectors..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::BeyondCorp::AppConnectors::V1::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_app_connectors.timeout, metadata: , retry_policy: @config.rpcs.list_app_connectors.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @app_connectors_service_stub.call_rpc :list_app_connectors, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @app_connectors_service_stub, :list_app_connectors, request, response, operation, yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#report_status(request, options = nil) ⇒ ::Gapic::Operation #report_status(app_connector: nil, resource_info: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation
Report status for a given connector.
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 |
# File 'lib/google/cloud/beyond_corp/app_connectors/v1/app_connectors_service/client.rb', line 833 def report_status request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BeyondCorp::AppConnectors::V1::ReportStatusRequest # 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.report_status..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::BeyondCorp::AppConnectors::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.app_connector header_params["app_connector"] = request.app_connector end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.report_status.timeout, metadata: , retry_policy: @config.rpcs.report_status.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @app_connectors_service_stub.call_rpc :report_status, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: 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
117 118 119 |
# File 'lib/google/cloud/beyond_corp/app_connectors/v1/app_connectors_service/client.rb', line 117 def universe_domain @app_connectors_service_stub.universe_domain end |
#update_app_connector(request, options = nil) ⇒ ::Gapic::Operation #update_app_connector(update_mask: nil, app_connector: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation
Updates the parameters of a single AppConnector.
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 |
# File 'lib/google/cloud/beyond_corp/app_connectors/v1/app_connectors_service/client.rb', line 609 def update_app_connector request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::BeyondCorp::AppConnectors::V1::UpdateAppConnectorRequest # 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_app_connector..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::BeyondCorp::AppConnectors::V1::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.app_connector&.name header_params["app_connector.name"] = request.app_connector.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.update_app_connector.timeout, metadata: , retry_policy: @config.rpcs.update_app_connector.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @app_connectors_service_stub.call_rpc :update_app_connector, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |