# 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/datastream/v1/datastream_pb" require "google/cloud/location" require "google/iam/v1" module Google module Cloud module Datastream module V1 module Datastream ## # Client for the Datastream service. # # Datastream service # class Client # @private API_VERSION = "" # @private DEFAULT_ENDPOINT_TEMPLATE = "datastream.$UNIVERSE_DOMAIN$" include Paths # @private attr_reader :datastream_stub ## # Configure the Datastream Client class. # # See {::Google::Cloud::Datastream::V1::Datastream::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all Datastream clients # ::Google::Cloud::Datastream::V1::Datastream::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", "Datastream", "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.timeout = 60.0 default_config.retry_policy = { initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.create_connection_profile.timeout = 60.0 default_config.rpcs.update_connection_profile.timeout = 60.0 default_config.rpcs.delete_connection_profile.timeout = 60.0 default_config.rpcs.create_stream.timeout = 60.0 default_config.rpcs.update_stream.timeout = 60.0 default_config.rpcs.delete_stream.timeout = 60.0 default_config.rpcs.create_private_connection.timeout = 60.0 default_config.rpcs.delete_private_connection.timeout = 60.0 default_config.rpcs.create_route.timeout = 60.0 default_config.rpcs.delete_route.timeout = 60.0 default_config end yield @configure if block_given? @configure end ## # Configure the Datastream 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::Datastream::V1::Datastream::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 @datastream_stub.universe_domain end ## # Create a new Datastream client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::Datastream::V1::Datastream::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the Datastream 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/datastream/v1/datastream_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 @datastream_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Datastream::V1::Datastream::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 = @datastream_stub.endpoint config.universe_domain = @datastream_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 = @datastream_stub.endpoint config.universe_domain = @datastream_stub.universe_domain end end ## # Get the associated client for long-running operations. # # @return [::Google::Cloud::Datastream::V1::Datastream::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 ## # Use this method to list connection profiles created in a project and # location. # # @overload list_connection_profiles(request, options = nil) # Pass arguments to `list_connection_profiles` via a request object, either of type # {::Google::Cloud::Datastream::V1::ListConnectionProfilesRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::ListConnectionProfilesRequest, ::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_connection_profiles(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) # Pass arguments to `list_connection_profiles` 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 parent that owns the collection of connection profiles. # @param page_size [::Integer] # Maximum number of connection profiles to return. # If unspecified, at most 50 connection profiles will be returned. # The maximum value is 1000; values above 1000 will be coerced to 1000. # @param page_token [::String] # Page token received from a previous `ListConnectionProfiles` call. # Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to `ListConnectionProfiles` # must match the call that provided the page token. # @param filter [::String] # Filter request. # @param order_by [::String] # Order by fields for the result. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1::ConnectionProfile>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1::ConnectionProfile>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::ListConnectionProfilesRequest.new # # # Call the list_connection_profiles method. # result = client.list_connection_profiles 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::Datastream::V1::ConnectionProfile. # p item # end # def list_connection_profiles request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::ListConnectionProfilesRequest # 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_connection_profiles.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_connection_profiles.timeout, metadata: metadata, retry_policy: @config.rpcs.list_connection_profiles.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :list_connection_profiles, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @datastream_stub, :list_connection_profiles, 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 ## # Use this method to get details about a connection profile. # # @overload get_connection_profile(request, options = nil) # Pass arguments to `get_connection_profile` via a request object, either of type # {::Google::Cloud::Datastream::V1::GetConnectionProfileRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::GetConnectionProfileRequest, ::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_connection_profile(name: nil) # Pass arguments to `get_connection_profile` 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. The name of the connection profile resource to get. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Datastream::V1::ConnectionProfile] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Datastream::V1::ConnectionProfile] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::GetConnectionProfileRequest.new # # # Call the get_connection_profile method. # result = client.get_connection_profile request # # # The returned object is of type Google::Cloud::Datastream::V1::ConnectionProfile. # p result # def get_connection_profile request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::GetConnectionProfileRequest # 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_connection_profile.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_connection_profile.timeout, metadata: metadata, retry_policy: @config.rpcs.get_connection_profile.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :get_connection_profile, 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 ## # Use this method to create a connection profile in a project and location. # # @overload create_connection_profile(request, options = nil) # Pass arguments to `create_connection_profile` via a request object, either of type # {::Google::Cloud::Datastream::V1::CreateConnectionProfileRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::CreateConnectionProfileRequest, ::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_connection_profile(parent: nil, connection_profile_id: nil, connection_profile: nil, request_id: nil, validate_only: nil, force: nil) # Pass arguments to `create_connection_profile` 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 parent that owns the collection of ConnectionProfiles. # @param connection_profile_id [::String] # Required. The connection profile identifier. # @param connection_profile [::Google::Cloud::Datastream::V1::ConnectionProfile, ::Hash] # Required. The connection profile resource to create. # @param request_id [::String] # Optional. A 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 the # 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. Only validate the connection profile, but don't create any # resources. The default is false. # @param force [::Boolean] # Optional. Create the connection profile without validating it. # # @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/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::CreateConnectionProfileRequest.new # # # Call the create_connection_profile method. # result = client.create_connection_profile 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_connection_profile request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::CreateConnectionProfileRequest # 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_connection_profile.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_connection_profile.timeout, metadata: metadata, retry_policy: @config.rpcs.create_connection_profile.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :create_connection_profile, 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 ## # Use this method to update the parameters of a connection profile. # # @overload update_connection_profile(request, options = nil) # Pass arguments to `update_connection_profile` via a request object, either of type # {::Google::Cloud::Datastream::V1::UpdateConnectionProfileRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::UpdateConnectionProfileRequest, ::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_connection_profile(update_mask: nil, connection_profile: nil, request_id: nil, validate_only: nil, force: nil) # Pass arguments to `update_connection_profile` 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] # Optional. Field mask is used to specify the fields to be overwritten in the # ConnectionProfile resource by the update. # The fields specified in the update_mask are relative to the resource, not # the full request. A field will be overwritten if it is in the mask. If the # user does not provide a mask then all fields will be overwritten. # @param connection_profile [::Google::Cloud::Datastream::V1::ConnectionProfile, ::Hash] # Required. The connection profile to update. # @param request_id [::String] # Optional. A 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 the # 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. Only validate the connection profile, but don't update any # resources. The default is false. # @param force [::Boolean] # Optional. Update the connection profile without validating it. # # @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/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::UpdateConnectionProfileRequest.new # # # Call the update_connection_profile method. # result = client.update_connection_profile 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_connection_profile request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::UpdateConnectionProfileRequest # 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_connection_profile.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.connection_profile&.name header_params["connection_profile.name"] = request.connection_profile.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_connection_profile.timeout, metadata: metadata, retry_policy: @config.rpcs.update_connection_profile.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :update_connection_profile, 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 ## # Use this method to delete a connection profile. # # @overload delete_connection_profile(request, options = nil) # Pass arguments to `delete_connection_profile` via a request object, either of type # {::Google::Cloud::Datastream::V1::DeleteConnectionProfileRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::DeleteConnectionProfileRequest, ::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_connection_profile(name: nil, request_id: nil) # Pass arguments to `delete_connection_profile` 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. The name of the connection profile resource to delete. # @param request_id [::String] # Optional. A 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 the # 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). # # @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/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::DeleteConnectionProfileRequest.new # # # Call the delete_connection_profile method. # result = client.delete_connection_profile 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_connection_profile request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::DeleteConnectionProfileRequest # 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_connection_profile.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_connection_profile.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_connection_profile.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :delete_connection_profile, 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 ## # Use this method to discover a connection profile. # The discover API call exposes the data objects and metadata belonging to # the profile. Typically, a request returns children data objects of a # parent data object that's optionally supplied in the request. # # @overload discover_connection_profile(request, options = nil) # Pass arguments to `discover_connection_profile` via a request object, either of type # {::Google::Cloud::Datastream::V1::DiscoverConnectionProfileRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::DiscoverConnectionProfileRequest, ::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 discover_connection_profile(parent: nil, connection_profile: nil, connection_profile_name: nil, full_hierarchy: nil, hierarchy_depth: nil, oracle_rdbms: nil, mysql_rdbms: nil, postgresql_rdbms: nil) # Pass arguments to `discover_connection_profile` 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 parent resource of the connection profile type. Must be in # the format `projects/*/locations/*`. # @param connection_profile [::Google::Cloud::Datastream::V1::ConnectionProfile, ::Hash] # An ad-hoc connection profile configuration. # @param connection_profile_name [::String] # A reference to an existing connection profile. # @param full_hierarchy [::Boolean] # Whether to retrieve the full hierarchy of data objects (TRUE) or only the # current level (FALSE). # @param hierarchy_depth [::Integer] # The number of hierarchy levels below the current level to be retrieved. # @param oracle_rdbms [::Google::Cloud::Datastream::V1::OracleRdbms, ::Hash] # Oracle RDBMS to enrich with child data objects and metadata. # @param mysql_rdbms [::Google::Cloud::Datastream::V1::MysqlRdbms, ::Hash] # MySQL RDBMS to enrich with child data objects and metadata. # @param postgresql_rdbms [::Google::Cloud::Datastream::V1::PostgresqlRdbms, ::Hash] # PostgreSQL RDBMS to enrich with child data objects and metadata. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Datastream::V1::DiscoverConnectionProfileResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Datastream::V1::DiscoverConnectionProfileResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::DiscoverConnectionProfileRequest.new # # # Call the discover_connection_profile method. # result = client.discover_connection_profile request # # # The returned object is of type Google::Cloud::Datastream::V1::DiscoverConnectionProfileResponse. # p result # def discover_connection_profile request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::DiscoverConnectionProfileRequest # 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.discover_connection_profile.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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.discover_connection_profile.timeout, metadata: metadata, retry_policy: @config.rpcs.discover_connection_profile.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :discover_connection_profile, 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 ## # Use this method to list streams in a project and location. # # @overload list_streams(request, options = nil) # Pass arguments to `list_streams` via a request object, either of type # {::Google::Cloud::Datastream::V1::ListStreamsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::ListStreamsRequest, ::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_streams(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) # Pass arguments to `list_streams` 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 parent that owns the collection of streams. # @param page_size [::Integer] # Maximum number of streams to return. # If unspecified, at most 50 streams will be returned. The maximum # value is 1000; values above 1000 will be coerced to 1000. # @param page_token [::String] # Page token received from a previous `ListStreams` call. # Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to `ListStreams` # must match the call that provided the page token. # @param filter [::String] # Filter request. # @param order_by [::String] # Order by fields for the result. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1::Stream>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1::Stream>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::ListStreamsRequest.new # # # Call the list_streams method. # result = client.list_streams 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::Datastream::V1::Stream. # p item # end # def list_streams request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::ListStreamsRequest # 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_streams.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_streams.timeout, metadata: metadata, retry_policy: @config.rpcs.list_streams.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :list_streams, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @datastream_stub, :list_streams, 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 ## # Use this method to get details about a stream. # # @overload get_stream(request, options = nil) # Pass arguments to `get_stream` via a request object, either of type # {::Google::Cloud::Datastream::V1::GetStreamRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::GetStreamRequest, ::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_stream(name: nil) # Pass arguments to `get_stream` 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. The name of the stream resource to get. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Datastream::V1::Stream] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Datastream::V1::Stream] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::GetStreamRequest.new # # # Call the get_stream method. # result = client.get_stream request # # # The returned object is of type Google::Cloud::Datastream::V1::Stream. # p result # def get_stream request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::GetStreamRequest # 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_stream.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_stream.timeout, metadata: metadata, retry_policy: @config.rpcs.get_stream.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :get_stream, 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 ## # Use this method to create a stream. # # @overload create_stream(request, options = nil) # Pass arguments to `create_stream` via a request object, either of type # {::Google::Cloud::Datastream::V1::CreateStreamRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::CreateStreamRequest, ::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_stream(parent: nil, stream_id: nil, stream: nil, request_id: nil, validate_only: nil, force: nil) # Pass arguments to `create_stream` 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 parent that owns the collection of streams. # @param stream_id [::String] # Required. The stream identifier. # @param stream [::Google::Cloud::Datastream::V1::Stream, ::Hash] # Required. The stream resource to create. # @param request_id [::String] # Optional. A 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 the # 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. Only validate the stream, but don't create any resources. # The default is false. # @param force [::Boolean] # Optional. Create the stream without validating it. # # @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/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::CreateStreamRequest.new # # # Call the create_stream method. # result = client.create_stream 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_stream request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::CreateStreamRequest # 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_stream.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_stream.timeout, metadata: metadata, retry_policy: @config.rpcs.create_stream.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :create_stream, 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 ## # Use this method to update the configuration of a stream. # # @overload update_stream(request, options = nil) # Pass arguments to `update_stream` via a request object, either of type # {::Google::Cloud::Datastream::V1::UpdateStreamRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::UpdateStreamRequest, ::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_stream(update_mask: nil, stream: nil, request_id: nil, validate_only: nil, force: nil) # Pass arguments to `update_stream` 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] # Optional. Field mask is used to specify the fields to be overwritten in the # stream resource by the update. # The fields specified in the update_mask are relative to the resource, not # the full request. A field will be overwritten if it is in the mask. If the # user does not provide a mask then all fields will be overwritten. # @param stream [::Google::Cloud::Datastream::V1::Stream, ::Hash] # Required. The stream resource to update. # @param request_id [::String] # Optional. A 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 the # 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. Only validate the stream with the changes, without actually # updating it. The default is false. # @param force [::Boolean] # Optional. Update the stream without validating it. # # @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/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::UpdateStreamRequest.new # # # Call the update_stream method. # result = client.update_stream 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_stream request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::UpdateStreamRequest # 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_stream.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.stream&.name header_params["stream.name"] = request.stream.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_stream.timeout, metadata: metadata, retry_policy: @config.rpcs.update_stream.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :update_stream, 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 ## # Use this method to delete a stream. # # @overload delete_stream(request, options = nil) # Pass arguments to `delete_stream` via a request object, either of type # {::Google::Cloud::Datastream::V1::DeleteStreamRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::DeleteStreamRequest, ::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_stream(name: nil, request_id: nil) # Pass arguments to `delete_stream` 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. The name of the stream resource to delete. # @param request_id [::String] # Optional. A 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 the # 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). # # @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/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::DeleteStreamRequest.new # # # Call the delete_stream method. # result = client.delete_stream 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_stream request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::DeleteStreamRequest # 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_stream.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_stream.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_stream.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :delete_stream, 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 ## # Use this method to get details about a stream object. # # @overload get_stream_object(request, options = nil) # Pass arguments to `get_stream_object` via a request object, either of type # {::Google::Cloud::Datastream::V1::GetStreamObjectRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::GetStreamObjectRequest, ::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_stream_object(name: nil) # Pass arguments to `get_stream_object` 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. The name of the stream object resource to get. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Datastream::V1::StreamObject] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Datastream::V1::StreamObject] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::GetStreamObjectRequest.new # # # Call the get_stream_object method. # result = client.get_stream_object request # # # The returned object is of type Google::Cloud::Datastream::V1::StreamObject. # p result # def get_stream_object request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::GetStreamObjectRequest # 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_stream_object.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_stream_object.timeout, metadata: metadata, retry_policy: @config.rpcs.get_stream_object.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :get_stream_object, 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 ## # Use this method to look up a stream object by its source object identifier. # # @overload lookup_stream_object(request, options = nil) # Pass arguments to `lookup_stream_object` via a request object, either of type # {::Google::Cloud::Datastream::V1::LookupStreamObjectRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::LookupStreamObjectRequest, ::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 lookup_stream_object(parent: nil, source_object_identifier: nil) # Pass arguments to `lookup_stream_object` 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 parent stream that owns the collection of objects. # @param source_object_identifier [::Google::Cloud::Datastream::V1::SourceObjectIdentifier, ::Hash] # Required. The source object identifier which maps to the stream object. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Datastream::V1::StreamObject] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Datastream::V1::StreamObject] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::LookupStreamObjectRequest.new # # # Call the lookup_stream_object method. # result = client.lookup_stream_object request # # # The returned object is of type Google::Cloud::Datastream::V1::StreamObject. # p result # def lookup_stream_object request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::LookupStreamObjectRequest # 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.lookup_stream_object.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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.lookup_stream_object.timeout, metadata: metadata, retry_policy: @config.rpcs.lookup_stream_object.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :lookup_stream_object, 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 ## # Use this method to list the objects of a specific stream. # # @overload list_stream_objects(request, options = nil) # Pass arguments to `list_stream_objects` via a request object, either of type # {::Google::Cloud::Datastream::V1::ListStreamObjectsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::ListStreamObjectsRequest, ::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_stream_objects(parent: nil, page_size: nil, page_token: nil) # Pass arguments to `list_stream_objects` 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 parent stream that owns the collection of objects. # @param page_size [::Integer] # Maximum number of objects to return. Default is 50. # The maximum value is 1000; values above 1000 will be coerced to 1000. # @param page_token [::String] # Page token received from a previous `ListStreamObjectsRequest` call. # Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to # `ListStreamObjectsRequest` must match the call that provided the page # token. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1::StreamObject>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1::StreamObject>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::ListStreamObjectsRequest.new # # # Call the list_stream_objects method. # result = client.list_stream_objects 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::Datastream::V1::StreamObject. # p item # end # def list_stream_objects request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::ListStreamObjectsRequest # 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_stream_objects.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_stream_objects.timeout, metadata: metadata, retry_policy: @config.rpcs.list_stream_objects.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :list_stream_objects, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @datastream_stub, :list_stream_objects, 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 ## # Use this method to start a backfill job for the specified stream object. # # @overload start_backfill_job(request, options = nil) # Pass arguments to `start_backfill_job` via a request object, either of type # {::Google::Cloud::Datastream::V1::StartBackfillJobRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::StartBackfillJobRequest, ::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 start_backfill_job(object: nil) # Pass arguments to `start_backfill_job` 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 object [::String] # Required. The name of the stream object resource to start a backfill job # for. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Datastream::V1::StartBackfillJobResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Datastream::V1::StartBackfillJobResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::StartBackfillJobRequest.new # # # Call the start_backfill_job method. # result = client.start_backfill_job request # # # The returned object is of type Google::Cloud::Datastream::V1::StartBackfillJobResponse. # p result # def start_backfill_job request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::StartBackfillJobRequest # 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.start_backfill_job.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.object header_params["object"] = request.object 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.start_backfill_job.timeout, metadata: metadata, retry_policy: @config.rpcs.start_backfill_job.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :start_backfill_job, 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 ## # Use this method to stop a backfill job for the specified stream object. # # @overload stop_backfill_job(request, options = nil) # Pass arguments to `stop_backfill_job` via a request object, either of type # {::Google::Cloud::Datastream::V1::StopBackfillJobRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::StopBackfillJobRequest, ::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 stop_backfill_job(object: nil) # Pass arguments to `stop_backfill_job` 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 object [::String] # Required. The name of the stream object resource to stop the backfill job # for. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Datastream::V1::StopBackfillJobResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Datastream::V1::StopBackfillJobResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::StopBackfillJobRequest.new # # # Call the stop_backfill_job method. # result = client.stop_backfill_job request # # # The returned object is of type Google::Cloud::Datastream::V1::StopBackfillJobResponse. # p result # def stop_backfill_job request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::StopBackfillJobRequest # 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.stop_backfill_job.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.object header_params["object"] = request.object 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.stop_backfill_job.timeout, metadata: metadata, retry_policy: @config.rpcs.stop_backfill_job.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :stop_backfill_job, 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 ## # The FetchStaticIps API call exposes the static IP addresses used by # Datastream. # # @overload fetch_static_ips(request, options = nil) # Pass arguments to `fetch_static_ips` via a request object, either of type # {::Google::Cloud::Datastream::V1::FetchStaticIpsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::FetchStaticIpsRequest, ::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 fetch_static_ips(name: nil, page_size: nil, page_token: nil) # Pass arguments to `fetch_static_ips` 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. The resource name for the location for which static IPs should be # returned. Must be in the format `projects/*/locations/*`. # @param page_size [::Integer] # Maximum number of Ips to return, will likely not be specified. # @param page_token [::String] # A page token, received from a previous `ListStaticIps` call. # will likely not be specified. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Datastream::V1::FetchStaticIpsResponse] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Datastream::V1::FetchStaticIpsResponse] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::FetchStaticIpsRequest.new # # # Call the fetch_static_ips method. # result = client.fetch_static_ips request # # # The returned object is of type Google::Cloud::Datastream::V1::FetchStaticIpsResponse. # p result # def fetch_static_ips request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::FetchStaticIpsRequest # 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.fetch_static_ips.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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.fetch_static_ips.timeout, metadata: metadata, retry_policy: @config.rpcs.fetch_static_ips.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :fetch_static_ips, 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 ## # Use this method to create a private connectivity configuration. # # @overload create_private_connection(request, options = nil) # Pass arguments to `create_private_connection` via a request object, either of type # {::Google::Cloud::Datastream::V1::CreatePrivateConnectionRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::CreatePrivateConnectionRequest, ::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_private_connection(parent: nil, private_connection_id: nil, private_connection: nil, request_id: nil, force: nil) # Pass arguments to `create_private_connection` 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 parent that owns the collection of PrivateConnections. # @param private_connection_id [::String] # Required. The private connectivity identifier. # @param private_connection [::Google::Cloud::Datastream::V1::PrivateConnection, ::Hash] # Required. The Private Connectivity resource to create. # @param request_id [::String] # Optional. A 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 the # 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 force [::Boolean] # Optional. If set to true, will skip validations. # # @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/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::CreatePrivateConnectionRequest.new # # # Call the create_private_connection method. # result = client.create_private_connection 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_private_connection request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::CreatePrivateConnectionRequest # 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_private_connection.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_private_connection.timeout, metadata: metadata, retry_policy: @config.rpcs.create_private_connection.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :create_private_connection, 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 ## # Use this method to get details about a private connectivity configuration. # # @overload get_private_connection(request, options = nil) # Pass arguments to `get_private_connection` via a request object, either of type # {::Google::Cloud::Datastream::V1::GetPrivateConnectionRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::GetPrivateConnectionRequest, ::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_private_connection(name: nil) # Pass arguments to `get_private_connection` 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. The name of the private connectivity configuration to get. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Datastream::V1::PrivateConnection] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Datastream::V1::PrivateConnection] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::GetPrivateConnectionRequest.new # # # Call the get_private_connection method. # result = client.get_private_connection request # # # The returned object is of type Google::Cloud::Datastream::V1::PrivateConnection. # p result # def get_private_connection request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::GetPrivateConnectionRequest # 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_private_connection.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_private_connection.timeout, metadata: metadata, retry_policy: @config.rpcs.get_private_connection.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :get_private_connection, 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 ## # Use this method to list private connectivity configurations in a project # and location. # # @overload list_private_connections(request, options = nil) # Pass arguments to `list_private_connections` via a request object, either of type # {::Google::Cloud::Datastream::V1::ListPrivateConnectionsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::ListPrivateConnectionsRequest, ::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_private_connections(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) # Pass arguments to `list_private_connections` 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 parent that owns the collection of private connectivity # configurations. # @param page_size [::Integer] # Maximum number of private connectivity configurations to return. # If unspecified, at most 50 private connectivity configurations that will be # returned. The maximum value is 1000; values above 1000 will be coerced to # 1000. # @param page_token [::String] # Page token received from a previous `ListPrivateConnections` call. # Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to # `ListPrivateConnections` must match the call that provided the page # token. # @param filter [::String] # Filter request. # @param order_by [::String] # Order by fields for the result. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1::PrivateConnection>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1::PrivateConnection>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::ListPrivateConnectionsRequest.new # # # Call the list_private_connections method. # result = client.list_private_connections 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::Datastream::V1::PrivateConnection. # p item # end # def list_private_connections request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::ListPrivateConnectionsRequest # 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_private_connections.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_private_connections.timeout, metadata: metadata, retry_policy: @config.rpcs.list_private_connections.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :list_private_connections, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @datastream_stub, :list_private_connections, 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 ## # Use this method to delete a private connectivity configuration. # # @overload delete_private_connection(request, options = nil) # Pass arguments to `delete_private_connection` via a request object, either of type # {::Google::Cloud::Datastream::V1::DeletePrivateConnectionRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::DeletePrivateConnectionRequest, ::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_private_connection(name: nil, request_id: nil, force: nil) # Pass arguments to `delete_private_connection` 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. The name of the private connectivity configuration to delete. # @param request_id [::String] # Optional. A 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 the # 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 force [::Boolean] # Optional. If set to true, any child routes that belong to this # PrivateConnection will also be deleted. # # @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/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::DeletePrivateConnectionRequest.new # # # Call the delete_private_connection method. # result = client.delete_private_connection 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_private_connection request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::DeletePrivateConnectionRequest # 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_private_connection.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_private_connection.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_private_connection.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :delete_private_connection, 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 ## # Use this method to create a route for a private connectivity configuration # in a project and location. # # @overload create_route(request, options = nil) # Pass arguments to `create_route` via a request object, either of type # {::Google::Cloud::Datastream::V1::CreateRouteRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::CreateRouteRequest, ::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_route(parent: nil, route_id: nil, route: nil, request_id: nil) # Pass arguments to `create_route` 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 parent that owns the collection of Routes. # @param route_id [::String] # Required. The Route identifier. # @param route [::Google::Cloud::Datastream::V1::Route, ::Hash] # Required. The Route resource to create. # @param request_id [::String] # Optional. A 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 the # 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). # # @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/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::CreateRouteRequest.new # # # Call the create_route method. # result = client.create_route 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_route request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::CreateRouteRequest # 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_route.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_route.timeout, metadata: metadata, retry_policy: @config.rpcs.create_route.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :create_route, 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 ## # Use this method to get details about a route. # # @overload get_route(request, options = nil) # Pass arguments to `get_route` via a request object, either of type # {::Google::Cloud::Datastream::V1::GetRouteRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::GetRouteRequest, ::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_route(name: nil) # Pass arguments to `get_route` 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. The name of the Route resource to get. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Google::Cloud::Datastream::V1::Route] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Google::Cloud::Datastream::V1::Route] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::GetRouteRequest.new # # # Call the get_route method. # result = client.get_route request # # # The returned object is of type Google::Cloud::Datastream::V1::Route. # p result # def get_route request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::GetRouteRequest # 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_route.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_route.timeout, metadata: metadata, retry_policy: @config.rpcs.get_route.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :get_route, 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 ## # Use this method to list routes created for a private connectivity # configuration in a project and location. # # @overload list_routes(request, options = nil) # Pass arguments to `list_routes` via a request object, either of type # {::Google::Cloud::Datastream::V1::ListRoutesRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::ListRoutesRequest, ::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_routes(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) # Pass arguments to `list_routes` 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 parent that owns the collection of Routess. # @param page_size [::Integer] # Maximum number of Routes to return. The service may return # fewer than this value. If unspecified, at most 50 Routes # will be returned. The maximum value is 1000; values above 1000 will be # coerced to 1000. # @param page_token [::String] # Page token received from a previous `ListRoutes` call. # Provide this to retrieve the subsequent page. # # When paginating, all other parameters provided to # `ListRoutes` must match the call that provided the page # token. # @param filter [::String] # Filter request. # @param order_by [::String] # Order by fields for the result. # # @yield [response, operation] Access the result along with the RPC operation # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1::Route>] # @yieldparam operation [::GRPC::ActiveCall::Operation] # # @return [::Gapic::PagedEnumerable<::Google::Cloud::Datastream::V1::Route>] # # @raise [::Google::Cloud::Error] if the RPC is aborted. # # @example Basic example # require "google/cloud/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::ListRoutesRequest.new # # # Call the list_routes method. # result = client.list_routes 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::Datastream::V1::Route. # p item # end # def list_routes request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::ListRoutesRequest # 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_routes.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_routes.timeout, metadata: metadata, retry_policy: @config.rpcs.list_routes.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :list_routes, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @datastream_stub, :list_routes, 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 ## # Use this method to delete a route. # # @overload delete_route(request, options = nil) # Pass arguments to `delete_route` via a request object, either of type # {::Google::Cloud::Datastream::V1::DeleteRouteRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Datastream::V1::DeleteRouteRequest, ::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_route(name: nil, request_id: nil) # Pass arguments to `delete_route` 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. The name of the Route resource to delete. # @param request_id [::String] # Optional. A 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 the # 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). # # @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/datastream/v1" # # # Create a client object. The client can be reused for multiple calls. # client = Google::Cloud::Datastream::V1::Datastream::Client.new # # # Create a request. To set request fields, pass in keyword arguments. # request = Google::Cloud::Datastream::V1::DeleteRouteRequest.new # # # Call the delete_route method. # result = client.delete_route 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_route request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1::DeleteRouteRequest # 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_route.metadata.to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::Datastream::V1::VERSION metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? 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_route.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_route.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @datastream_stub.call_rpc :delete_route, 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 Datastream API. # # This class represents the configuration for Datastream, # 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::Datastream::V1::Datastream::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_connection_profiles to 20 seconds, # # and all remaining timeouts to 10 seconds. # ::Google::Cloud::Datastream::V1::Datastream::Client.configure do |config| # config.timeout = 10.0 # config.rpcs.list_connection_profiles.timeout = 20.0 # end # # # Apply the above configuration only to a new client. # client = ::Google::Cloud::Datastream::V1::Datastream::Client.new do |config| # config.timeout = 10.0 # config.rpcs.list_connection_profiles.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 = "datastream.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 Datastream 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_connection_profiles` # @return [::Gapic::Config::Method] # attr_reader :list_connection_profiles ## # RPC-specific configuration for `get_connection_profile` # @return [::Gapic::Config::Method] # attr_reader :get_connection_profile ## # RPC-specific configuration for `create_connection_profile` # @return [::Gapic::Config::Method] # attr_reader :create_connection_profile ## # RPC-specific configuration for `update_connection_profile` # @return [::Gapic::Config::Method] # attr_reader :update_connection_profile ## # RPC-specific configuration for `delete_connection_profile` # @return [::Gapic::Config::Method] # attr_reader :delete_connection_profile ## # RPC-specific configuration for `discover_connection_profile` # @return [::Gapic::Config::Method] # attr_reader :discover_connection_profile ## # RPC-specific configuration for `list_streams` # @return [::Gapic::Config::Method] # attr_reader :list_streams ## # RPC-specific configuration for `get_stream` # @return [::Gapic::Config::Method] # attr_reader :get_stream ## # RPC-specific configuration for `create_stream` # @return [::Gapic::Config::Method] # attr_reader :create_stream ## # RPC-specific configuration for `update_stream` # @return [::Gapic::Config::Method] # attr_reader :update_stream ## # RPC-specific configuration for `delete_stream` # @return [::Gapic::Config::Method] # attr_reader :delete_stream ## # RPC-specific configuration for `get_stream_object` # @return [::Gapic::Config::Method] # attr_reader :get_stream_object ## # RPC-specific configuration for `lookup_stream_object` # @return [::Gapic::Config::Method] # attr_reader :lookup_stream_object ## # RPC-specific configuration for `list_stream_objects` # @return [::Gapic::Config::Method] # attr_reader :list_stream_objects ## # RPC-specific configuration for `start_backfill_job` # @return [::Gapic::Config::Method] # attr_reader :start_backfill_job ## # RPC-specific configuration for `stop_backfill_job` # @return [::Gapic::Config::Method] # attr_reader :stop_backfill_job ## # RPC-specific configuration for `fetch_static_ips` # @return [::Gapic::Config::Method] # attr_reader :fetch_static_ips ## # RPC-specific configuration for `create_private_connection` # @return [::Gapic::Config::Method] # attr_reader :create_private_connection ## # RPC-specific configuration for `get_private_connection` # @return [::Gapic::Config::Method] # attr_reader :get_private_connection ## # RPC-specific configuration for `list_private_connections` # @return [::Gapic::Config::Method] # attr_reader :list_private_connections ## # RPC-specific configuration for `delete_private_connection` # @return [::Gapic::Config::Method] # attr_reader :delete_private_connection ## # RPC-specific configuration for `create_route` # @return [::Gapic::Config::Method] # attr_reader :create_route ## # RPC-specific configuration for `get_route` # @return [::Gapic::Config::Method] # attr_reader :get_route ## # RPC-specific configuration for `list_routes` # @return [::Gapic::Config::Method] # attr_reader :list_routes ## # RPC-specific configuration for `delete_route` # @return [::Gapic::Config::Method] # attr_reader :delete_route # @private def initialize parent_rpcs = nil list_connection_profiles_config = parent_rpcs.list_connection_profiles if parent_rpcs.respond_to? :list_connection_profiles @list_connection_profiles = ::Gapic::Config::Method.new list_connection_profiles_config get_connection_profile_config = parent_rpcs.get_connection_profile if parent_rpcs.respond_to? :get_connection_profile @get_connection_profile = ::Gapic::Config::Method.new get_connection_profile_config create_connection_profile_config = parent_rpcs.create_connection_profile if parent_rpcs.respond_to? :create_connection_profile @create_connection_profile = ::Gapic::Config::Method.new create_connection_profile_config update_connection_profile_config = parent_rpcs.update_connection_profile if parent_rpcs.respond_to? :update_connection_profile @update_connection_profile = ::Gapic::Config::Method.new update_connection_profile_config delete_connection_profile_config = parent_rpcs.delete_connection_profile if parent_rpcs.respond_to? :delete_connection_profile @delete_connection_profile = ::Gapic::Config::Method.new delete_connection_profile_config discover_connection_profile_config = parent_rpcs.discover_connection_profile if parent_rpcs.respond_to? :discover_connection_profile @discover_connection_profile = ::Gapic::Config::Method.new discover_connection_profile_config list_streams_config = parent_rpcs.list_streams if parent_rpcs.respond_to? :list_streams @list_streams = ::Gapic::Config::Method.new list_streams_config get_stream_config = parent_rpcs.get_stream if parent_rpcs.respond_to? :get_stream @get_stream = ::Gapic::Config::Method.new get_stream_config create_stream_config = parent_rpcs.create_stream if parent_rpcs.respond_to? :create_stream @create_stream = ::Gapic::Config::Method.new create_stream_config update_stream_config = parent_rpcs.update_stream if parent_rpcs.respond_to? :update_stream @update_stream = ::Gapic::Config::Method.new update_stream_config delete_stream_config = parent_rpcs.delete_stream if parent_rpcs.respond_to? :delete_stream @delete_stream = ::Gapic::Config::Method.new delete_stream_config get_stream_object_config = parent_rpcs.get_stream_object if parent_rpcs.respond_to? :get_stream_object @get_stream_object = ::Gapic::Config::Method.new get_stream_object_config lookup_stream_object_config = parent_rpcs.lookup_stream_object if parent_rpcs.respond_to? :lookup_stream_object @lookup_stream_object = ::Gapic::Config::Method.new lookup_stream_object_config list_stream_objects_config = parent_rpcs.list_stream_objects if parent_rpcs.respond_to? :list_stream_objects @list_stream_objects = ::Gapic::Config::Method.new list_stream_objects_config start_backfill_job_config = parent_rpcs.start_backfill_job if parent_rpcs.respond_to? :start_backfill_job @start_backfill_job = ::Gapic::Config::Method.new start_backfill_job_config stop_backfill_job_config = parent_rpcs.stop_backfill_job if parent_rpcs.respond_to? :stop_backfill_job @stop_backfill_job = ::Gapic::Config::Method.new stop_backfill_job_config fetch_static_ips_config = parent_rpcs.fetch_static_ips if parent_rpcs.respond_to? :fetch_static_ips @fetch_static_ips = ::Gapic::Config::Method.new fetch_static_ips_config create_private_connection_config = parent_rpcs.create_private_connection if parent_rpcs.respond_to? :create_private_connection @create_private_connection = ::Gapic::Config::Method.new create_private_connection_config get_private_connection_config = parent_rpcs.get_private_connection if parent_rpcs.respond_to? :get_private_connection @get_private_connection = ::Gapic::Config::Method.new get_private_connection_config list_private_connections_config = parent_rpcs.list_private_connections if parent_rpcs.respond_to? :list_private_connections @list_private_connections = ::Gapic::Config::Method.new list_private_connections_config delete_private_connection_config = parent_rpcs.delete_private_connection if parent_rpcs.respond_to? :delete_private_connection @delete_private_connection = ::Gapic::Config::Method.new delete_private_connection_config create_route_config = parent_rpcs.create_route if parent_rpcs.respond_to? :create_route @create_route = ::Gapic::Config::Method.new create_route_config get_route_config = parent_rpcs.get_route if parent_rpcs.respond_to? :get_route @get_route = ::Gapic::Config::Method.new get_route_config list_routes_config = parent_rpcs.list_routes if parent_rpcs.respond_to? :list_routes @list_routes = ::Gapic::Config::Method.new list_routes_config delete_route_config = parent_rpcs.delete_route if parent_rpcs.respond_to? :delete_route @delete_route = ::Gapic::Config::Method.new delete_route_config yield self if block_given? end end end end end end end end end