# frozen_string_literal: true # Copyright 2022 Google LLC # # 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 # # https://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. # Auto-generated by gapic-generator-ruby. DO NOT EDIT! require "google/cloud/errors" require "google/cloud/beyondcorp/appconnectors/v1/app_connectors_service_pb" require "google/cloud/location" require "google/iam/v1" module Google module Cloud module BeyondCorp module AppConnectors module V1 module AppConnectorsService ## # 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. # class Client # @private DEFAULT_ENDPOINT_TEMPLATE = "beyondcorp.$UNIVERSE_DOMAIN$" include Paths # @private attr_reader :app_connectors_service_stub ## # Configure the AppConnectorsService Client class. # # See {::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all AppConnectorsService clients # ::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Client.configure do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # 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 ## # 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 {Client.configure}. # # See {::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Client::Configuration} # for a description of the configuration fields. # # @yield [config] Configure the Client client. # @yieldparam config [Client::Configuration] # # @return [Client::Configuration] # def configure yield @config if block_given? @config end ## # The effective universe domain # # @return [String] # def universe_domain @app_connectors_service_stub.universe_domain end ## # Create a new AppConnectorsService client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the AppConnectorsService client. # @yieldparam config [Client::Configuration] # 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 @location_client = Google::Cloud::Location::Locations::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.universe_domain = @config.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 = @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 ) end ## # Get the associated client for long-running operations. # # @return [::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Operations] # attr_reader :operations_client ## # Get the associated client for mix-in of the Locations. # # @return [Google::Cloud::Location::Locations::Client] # attr_reader :location_client ## # Get the associated client for mix-in of the IAMPolicy. # # @return [Google::Iam::V1::IAMPolicy::Client] # attr_reader :iam_policy_client # Service calls ## # Lists AppConnectors in a given project and location. # # @overload list_app_connectors(request, options = nil) # Pass arguments to `list_app_connectors` via a request object, either of type # {::Google::Cloud::BeyondCorp::AppConnectors::V1::ListAppConnectorsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BeyondCorp::AppConnectors::V1::ListAppConnectorsRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload list_app_connectors(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) # Pass arguments to `list_app_connectors` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. The resource name of the AppConnector location using the form: # `projects/{project_id}/locations/{location_id}` # @param page_size [::Integer] # Optional. The maximum number of items to return. # If not specified, a default value of 50 will be used by the service. # Regardless of the page_size value, the response may include a partial list # and a caller should only rely on response's # [next_page_token][BeyondCorp.ListAppConnectorsResponse.next_page_token] to # determine if there are more instances left to be queried. # @param page_token [::String] # Optional. The next_page_token value returned from a previous # ListAppConnectorsRequest, if any. # @param filter [::String] # Optional. A filter specifying constraints of a list operation. # @param order_by [::String] # Optional. Specifies the ordering of results. See # [Sorting # order](https://cloud.google.com/apis/design/design_patterns#sorting_order) # for more information. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/beyond_corp/app_connectors/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::BeyondCorp::AppConnectors::V1::ListAppConnectorsRequest.new # # # Call the list_app_connectors method. # result = client.list_app_connectors request # # # The returned object is of type Gapic::PagedEnumerable. You can iterate # # over elements, and API calls will be issued to fetch pages as needed. # result.each do |item| # # Each element is of type ::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector. # p item # end # def list_app_connectors request, options = 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 options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_app_connectors.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"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 metadata[:"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("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_app_connectors.timeout, metadata: metadata, retry_policy: @config.rpcs.list_app_connectors.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @app_connectors_service_stub.call_rpc :list_app_connectors, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @app_connectors_service_stub, :list_app_connectors, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Gets details of a single AppConnector. # # @overload get_app_connector(request, options = nil) # Pass arguments to `get_app_connector` via a request object, either of type # {::Google::Cloud::BeyondCorp::AppConnectors::V1::GetAppConnectorRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BeyondCorp::AppConnectors::V1::GetAppConnectorRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload get_app_connector(name: nil) # Pass arguments to `get_app_connector` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. BeyondCorp AppConnector name using the form: # `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}` # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/beyond_corp/app_connectors/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::BeyondCorp::AppConnectors::V1::GetAppConnectorRequest.new # # # Call the get_app_connector method. # result = client.get_app_connector request # # # The returned object is of type Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector. # p result # def get_app_connector request, options = 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 options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_app_connector.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"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 metadata[:"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("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_app_connector.timeout, metadata: metadata, retry_policy: @config.rpcs.get_app_connector.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @app_connectors_service_stub.call_rpc :get_app_connector, request, options: 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 ## # Creates a new AppConnector in a given project and location. # # @overload create_app_connector(request, options = nil) # Pass arguments to `create_app_connector` via a request object, either of type # {::Google::Cloud::BeyondCorp::AppConnectors::V1::CreateAppConnectorRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BeyondCorp::AppConnectors::V1::CreateAppConnectorRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload create_app_connector(parent: nil, app_connector_id: nil, app_connector: nil, request_id: nil, validate_only: nil) # Pass arguments to `create_app_connector` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param parent [::String] # Required. The resource project name of the AppConnector location using the # form: `projects/{project_id}/locations/{location_id}` # @param app_connector_id [::String] # Optional. User-settable AppConnector resource ID. # # * Must start with a letter. # * Must contain between 4-63 characters from `/[a-z][0-9]-/`. # * Must end with a number or a letter. # @param app_connector [::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector, ::Hash] # Required. A BeyondCorp AppConnector resource. # @param request_id [::String] # Optional. An optional request ID to identify requests. Specify a unique # request ID so that if you must retry your request, the server will know to # ignore the request if it has already been completed. The server will # guarantee that for at least 60 minutes since the first request. # # For example, consider a situation where you make an initial request and t # he request times out. If you make the request again with the same request # ID, the server can check if original operation with the same request ID # was received, and if so, will ignore the second request. This prevents # clients from accidentally creating duplicate commitments. # # The request ID must be a valid UUID with the exception that zero UUID is # not supported (00000000-0000-0000-0000-000000000000). # @param validate_only [::Boolean] # Optional. If set, validates request by executing a dry-run which would not # alter the resource in any way. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/beyond_corp/app_connectors/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::BeyondCorp::AppConnectors::V1::CreateAppConnectorRequest.new # # # Call the create_app_connector method. # result = client.create_app_connector request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def create_app_connector request, options = 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 options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_app_connector.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"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 metadata[:"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("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_app_connector.timeout, metadata: metadata, retry_policy: @config.rpcs.create_app_connector.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @app_connectors_service_stub.call_rpc :create_app_connector, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Updates the parameters of a single AppConnector. # # @overload update_app_connector(request, options = nil) # Pass arguments to `update_app_connector` via a request object, either of type # {::Google::Cloud::BeyondCorp::AppConnectors::V1::UpdateAppConnectorRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BeyondCorp::AppConnectors::V1::UpdateAppConnectorRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload update_app_connector(update_mask: nil, app_connector: nil, request_id: nil, validate_only: nil) # Pass arguments to `update_app_connector` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param update_mask [::Google::Protobuf::FieldMask, ::Hash] # Required. Mask of fields to update. At least one path must be supplied in # this field. The elements of the repeated paths field may only include these # fields from [BeyondCorp.AppConnector]: # * `labels` # * `display_name` # @param app_connector [::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnector, ::Hash] # Required. AppConnector message with updated fields. Only supported fields # specified in update_mask are updated. # @param request_id [::String] # Optional. An optional request ID to identify requests. Specify a unique # request ID so that if you must retry your request, the server will know to # ignore the request if it has already been completed. The server will # guarantee that for at least 60 minutes since the first request. # # For example, consider a situation where you make an initial request and t # he request times out. If you make the request again with the same request # ID, the server can check if original operation with the same request ID # was received, and if so, will ignore the second request. This prevents # clients from accidentally creating duplicate commitments. # # The request ID must be a valid UUID with the exception that zero UUID is # not supported (00000000-0000-0000-0000-000000000000). # @param validate_only [::Boolean] # Optional. If set, validates request by executing a dry-run which would not # alter the resource in any way. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/beyond_corp/app_connectors/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::BeyondCorp::AppConnectors::V1::UpdateAppConnectorRequest.new # # # Call the update_app_connector method. # result = client.update_app_connector request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def update_app_connector request, options = 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 options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_app_connector.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"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 metadata[:"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("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_app_connector.timeout, metadata: metadata, retry_policy: @config.rpcs.update_app_connector.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @app_connectors_service_stub.call_rpc :update_app_connector, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Deletes a single AppConnector. # # @overload delete_app_connector(request, options = nil) # Pass arguments to `delete_app_connector` via a request object, either of type # {::Google::Cloud::BeyondCorp::AppConnectors::V1::DeleteAppConnectorRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BeyondCorp::AppConnectors::V1::DeleteAppConnectorRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload delete_app_connector(name: nil, request_id: nil, validate_only: nil) # Pass arguments to `delete_app_connector` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param name [::String] # Required. BeyondCorp AppConnector name using the form: # `projects/{project_id}/locations/{location_id}/appConnectors/{app_connector_id}` # @param request_id [::String] # Optional. An optional request ID to identify requests. Specify a unique # request ID so that if you must retry your request, the server will know to # ignore the request if it has already been completed. The server will # guarantee that for at least 60 minutes after the first request. # # For example, consider a situation where you make an initial request and t # he request times out. If you make the request again with the same request # ID, the server can check if original operation with the same request ID # was received, and if so, will ignore the second request. This prevents # clients from accidentally creating duplicate commitments. # # The request ID must be a valid UUID with the exception that zero UUID is # not supported (00000000-0000-0000-0000-000000000000). # @param validate_only [::Boolean] # Optional. If set, validates request by executing a dry-run which would not # alter the resource in any way. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/beyond_corp/app_connectors/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::BeyondCorp::AppConnectors::V1::DeleteAppConnectorRequest.new # # # Call the delete_app_connector method. # result = client.delete_app_connector request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def delete_app_connector request, options = 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 options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_app_connector.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"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 metadata[:"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("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_app_connector.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_app_connector.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @app_connectors_service_stub.call_rpc :delete_app_connector, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Report status for a given connector. # # @overload report_status(request, options = nil) # Pass arguments to `report_status` via a request object, either of type # {::Google::Cloud::BeyondCorp::AppConnectors::V1::ReportStatusRequest} or an equivalent Hash. # # @param request [::Google::Cloud::BeyondCorp::AppConnectors::V1::ReportStatusRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. # # @overload report_status(app_connector: nil, resource_info: nil, request_id: nil, validate_only: nil) # Pass arguments to `report_status` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). # # @param app_connector [::String] # Required. BeyondCorp Connector name using the form: # `projects/{project_id}/locations/{location_id}/connectors/{connector}` # @param resource_info [::Google::Cloud::BeyondCorp::AppConnectors::V1::ResourceInfo, ::Hash] # Required. Resource info of the connector. # @param request_id [::String] # Optional. An optional request ID to identify requests. Specify a unique # request ID so that if you must retry your request, the server will know to # ignore the request if it has already been completed. The server will # guarantee that for at least 60 minutes since the first request. # # For example, consider a situation where you make an initial request and t # he request times out. If you make the request again with the same request # ID, the server can check if original operation with the same request ID # was received, and if so, will ignore the second request. This prevents # clients from accidentally creating duplicate commitments. # # The request ID must be a valid UUID with the exception that zero UUID is # not supported (00000000-0000-0000-0000-000000000000). # @param validate_only [::Boolean] # Optional. If set, validates request by executing a dry-run which would not # alter the resource in any way. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::Operation] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/beyond_corp/app_connectors/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::BeyondCorp::AppConnectors::V1::ReportStatusRequest.new # # # Call the report_status method. # result = client.report_status request # # # The returned object is of type Gapic::Operation. You can use it to # # check the status of an operation, cancel it, or wait for results. # # Here is how to wait for a response. # result.wait_until_done! timeout: 60 # if result.response? # p result.response # else # puts "No response received." # end # def report_status request, options = 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 options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.report_status.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"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 metadata[:"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("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.report_status.timeout, metadata: metadata, retry_policy: @config.rpcs.report_status.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @app_connectors_service_stub.call_rpc :report_status, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end ## # Configuration class for the AppConnectorsService API. # # This class represents the configuration for AppConnectorsService, # providing control over timeouts, retry behavior, logging, transport # parameters, and other low-level controls. Certain parameters can also be # applied individually to specific RPCs. See # {::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Client::Configuration::Rpcs} # for a list of RPCs that can be configured independently. # # Configuration can be applied globally to all clients, or to a single client # on construction. # # @example # # # Modify the global config, setting the timeout for # # list_app_connectors to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.list_app_connectors.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Cloud::BeyondCorp::AppConnectors::V1::AppConnectorsService::Client.new do |config| # config.timeout = 10.0 # config.rpcs.list_app_connectors.timeout = 20.0 # end # # @!attribute [rw] endpoint # A custom service endpoint, as a hostname or hostname:port. The default is # nil, indicating to use the default endpoint in the current universe domain. # @return [::String,nil] # @!attribute [rw] credentials # Credentials to send with calls. You may provide any of the following types: # * (`String`) The path to a service account key file in JSON format # * (`Hash`) A service account key as a Hash # * (`Google::Auth::Credentials`) A googleauth credentials object # (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) # * (`GRPC::Core::Channel`) a gRPC channel with included credentials # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object # * (`nil`) indicating no credentials # @return [::Object] # @!attribute [rw] scope # The OAuth scopes # @return [::Array<::String>] # @!attribute [rw] lib_name # The library name as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] lib_version # The library version as recorded in instrumentation and logging # @return [::String] # @!attribute [rw] channel_args # Extra parameters passed to the gRPC channel. Note: this is ignored if a # `GRPC::Core::Channel` object is provided as the credential. # @return [::Hash] # @!attribute [rw] interceptors # An array of interceptors that are run before calls are executed. # @return [::Array<::GRPC::ClientInterceptor>] # @!attribute [rw] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata # Additional gRPC headers to be sent with the call. # @return [::Hash{::Symbol=>::String}] # @!attribute [rw] retry_policy # The retry policy. The value is a hash with the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # @return [::Hash] # @!attribute [rw] quota_project # A separate project against which to charge quota. # @return [::String] # @!attribute [rw] universe_domain # The universe domain within which to make requests. This determines the # default endpoint URL. The default value of nil uses the environment # universe (usually the default "googleapis.com" universe). # @return [::String,nil] # class Configuration extend ::Gapic::Config # @private # The endpoint specific to the default "googleapis.com" universe. Deprecated. DEFAULT_ENDPOINT = "beyondcorp.googleapis.com" config_attr :endpoint, nil, ::String, nil config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, nil config_attr :universe_domain, nil, ::String, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration for the channel pool # @return [::Gapic::ServiceStub::ChannelPool::Configuration] # def channel_pool @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new end ## # Configuration RPC class for the AppConnectorsService API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `list_app_connectors` # @return [::Gapic::Config::Method] # attr_reader :list_app_connectors ## # RPC-specific configuration for `get_app_connector` # @return [::Gapic::Config::Method] # attr_reader :get_app_connector ## # RPC-specific configuration for `create_app_connector` # @return [::Gapic::Config::Method] # attr_reader :create_app_connector ## # RPC-specific configuration for `update_app_connector` # @return [::Gapic::Config::Method] # attr_reader :update_app_connector ## # RPC-specific configuration for `delete_app_connector` # @return [::Gapic::Config::Method] # attr_reader :delete_app_connector ## # RPC-specific configuration for `report_status` # @return [::Gapic::Config::Method] # attr_reader :report_status # @private def initialize parent_rpcs = nil list_app_connectors_config = parent_rpcs.list_app_connectors if parent_rpcs.respond_to? :list_app_connectors @list_app_connectors = ::Gapic::Config::Method.new list_app_connectors_config get_app_connector_config = parent_rpcs.get_app_connector if parent_rpcs.respond_to? :get_app_connector @get_app_connector = ::Gapic::Config::Method.new get_app_connector_config create_app_connector_config = parent_rpcs.create_app_connector if parent_rpcs.respond_to? :create_app_connector @create_app_connector = ::Gapic::Config::Method.new create_app_connector_config update_app_connector_config = parent_rpcs.update_app_connector if parent_rpcs.respond_to? :update_app_connector @update_app_connector = ::Gapic::Config::Method.new update_app_connector_config delete_app_connector_config = parent_rpcs.delete_app_connector if parent_rpcs.respond_to? :delete_app_connector @delete_app_connector = ::Gapic::Config::Method.new delete_app_connector_config report_status_config = parent_rpcs.report_status if parent_rpcs.respond_to? :report_status @report_status = ::Gapic::Config::Method.new report_status_config yield self if block_given? end end end end end end end end end end