lib/google/cloud/datastream/v1alpha1/datastream/rest/client.rb in google-cloud-datastream-v1alpha1-0.4.0 vs lib/google/cloud/datastream/v1alpha1/datastream/rest/client.rb in google-cloud-datastream-v1alpha1-0.5.0

- old
+ new

@@ -213,10 +213,30 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Datastream::V1alpha1::ListConnectionProfilesResponse] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::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::V1alpha1::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::V1alpha1::ListConnectionProfilesRequest @@ -275,10 +295,26 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Datastream::V1alpha1::ConnectionProfile] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::GetConnectionProfileRequest.new + # + # # Call the get_connection_profile method. + # result = client.get_connection_profile request + # + # # The returned object is of type Google::Cloud::Datastream::V1alpha1::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::V1alpha1::GetConnectionProfileRequest @@ -355,10 +391,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::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::V1alpha1::CreateConnectionProfileRequest @@ -438,10 +497,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::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::V1alpha1::UpdateConnectionProfileRequest @@ -515,10 +597,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::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::V1alpha1::DeleteConnectionProfileRequest @@ -595,10 +700,26 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Datastream::V1alpha1::DiscoverConnectionProfileResponse] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::DiscoverConnectionProfileRequest.new + # + # # Call the discover_connection_profile method. + # result = client.discover_connection_profile request + # + # # The returned object is of type Google::Cloud::Datastream::V1alpha1::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::V1alpha1::DiscoverConnectionProfileRequest @@ -671,10 +792,30 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Datastream::V1alpha1::ListStreamsResponse] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::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::V1alpha1::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::V1alpha1::ListStreamsRequest @@ -733,10 +874,26 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Datastream::V1alpha1::Stream] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::GetStreamRequest.new + # + # # Call the get_stream method. + # result = client.get_stream request + # + # # The returned object is of type Google::Cloud::Datastream::V1alpha1::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::V1alpha1::GetStreamRequest @@ -818,10 +975,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::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::V1alpha1::CreateStreamRequest @@ -906,10 +1086,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::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::V1alpha1::UpdateStreamRequest @@ -983,10 +1186,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::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::V1alpha1::DeleteStreamRequest @@ -1046,10 +1272,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::FetchErrorsRequest.new + # + # # Call the fetch_errors method. + # result = client.fetch_errors 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 fetch_errors request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Datastream::V1alpha1::FetchErrorsRequest @@ -1117,10 +1366,26 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Rest::PagedEnumerable<::String>] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::FetchStaticIpsRequest.new + # + # # Call the fetch_static_ips method. + # result = client.fetch_static_ips request + # + # # The returned object is of type Google::Cloud::Datastream::V1alpha1::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::V1alpha1::FetchStaticIpsRequest @@ -1198,10 +1463,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::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::V1alpha1::CreatePrivateConnectionRequest @@ -1261,10 +1549,26 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Datastream::V1alpha1::PrivateConnection] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::GetPrivateConnectionRequest.new + # + # # Call the get_private_connection method. + # result = client.get_private_connection request + # + # # The returned object is of type Google::Cloud::Datastream::V1alpha1::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::V1alpha1::GetPrivateConnectionRequest @@ -1340,10 +1644,30 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Datastream::V1alpha1::ListPrivateConnectionsResponse] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::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::V1alpha1::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::V1alpha1::ListPrivateConnectionsRequest @@ -1419,10 +1743,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::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::V1alpha1::DeletePrivateConnectionRequest @@ -1501,10 +1848,33 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::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::V1alpha1::CreateRouteRequest @@ -1564,10 +1934,26 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Datastream::V1alpha1::Route] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::GetRouteRequest.new + # + # # Call the get_route method. + # result = client.get_route request + # + # # The returned object is of type Google::Cloud::Datastream::V1alpha1::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::V1alpha1::GetRouteRequest @@ -1643,10 +2029,30 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Datastream::V1alpha1::ListRoutesResponse] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::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::V1alpha1::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::V1alpha1::ListRoutesRequest @@ -1719,9 +2125,32 @@ # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Gapic::Operation] # # @raise [::Google::Cloud::Error] if the REST call is aborted. + # + # @example Basic example + # require "google/cloud/datastream/v1alpha1" + # + # # Create a client object. The client can be reused for multiple calls. + # client = Google::Cloud::Datastream::V1alpha1::Datastream::Rest::Client.new + # + # # Create a request. To set request fields, pass in keyword arguments. + # request = Google::Cloud::Datastream::V1alpha1::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::V1alpha1::DeleteRouteRequest