google-cloud-eventarc-v1 0.7.0 → 0.9.0

data/lib/google/cloud/eventarc/v1/eventarc/rest/client.rb

@@ -35,6 +35,9 @@ module Google
             # Google Cloud services and forward them to supported destinations.
             #
             class Client
+              # @private
+              DEFAULT_ENDPOINT_TEMPLATE = "eventarc.$UNIVERSE_DOMAIN$"
+
               include Paths
 
               # @private
@@ -95,6 +98,15 @@ module Google
                 @config
               end
 
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @eventarc_stub.universe_domain
+              end
+
               ##
               # Create a new Eventarc REST client object.
               #
@@ -122,8 +134,9 @@ module Google
                 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 == Configuration::DEFAULT_ENDPOINT &&
-                                         !@config.endpoint.split(".").first.include?("-")
+                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)
@@ -137,12 +150,14 @@ module Google
                   config.credentials = credentials
                   config.quota_project = @quota_project_id
                   config.endpoint = @config.endpoint
+                  config.universe_domain = @config.universe_domain
                 end
 
                 @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
                   config.credentials = credentials
                   config.quota_project = @quota_project_id
                   config.endpoint = @config.endpoint
+                  config.universe_domain = @config.universe_domain
                   config.bindings_override = @config.bindings_override
                 end
 
@@ -150,10 +165,16 @@ module Google
                   config.credentials = credentials
                   config.quota_project = @quota_project_id
                   config.endpoint = @config.endpoint
+                  config.universe_domain = @config.universe_domain
                   config.bindings_override = @config.bindings_override
                 end
 
-                @eventarc_stub = ::Google::Cloud::Eventarc::V1::Eventarc::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
+                @eventarc_stub = ::Google::Cloud::Eventarc::V1::Eventarc::Rest::ServiceStub.new(
+                  endpoint: @config.endpoint,
+                  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                  universe_domain: @config.universe_domain,
+                  credentials: credentials
+                )
               end
 
               ##
@@ -206,6 +227,22 @@ module Google
               # @return [::Google::Cloud::Eventarc::V1::Trigger]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::GetTriggerRequest.new
+              #
+              #   # Call the get_trigger method.
+              #   result = client.get_trigger request
+              #
+              #   # The returned object is of type Google::Cloud::Eventarc::V1::Trigger.
+              #   p result
+              #
               def get_trigger request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -287,6 +324,26 @@ module Google
               # @return [::Google::Cloud::Eventarc::V1::ListTriggersResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::ListTriggersRequest.new
+              #
+              #   # Call the list_triggers method.
+              #   result = client.list_triggers 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::Eventarc::V1::Trigger.
+              #     p item
+              #   end
+              #
               def list_triggers request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -356,6 +413,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::CreateTriggerRequest.new
+              #
+              #   # Call the create_trigger method.
+              #   result = client.create_trigger 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_trigger request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -429,6 +509,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::UpdateTriggerRequest.new
+              #
+              #   # Call the update_trigger method.
+              #   result = client.update_trigger 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_trigger request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -501,6 +604,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::DeleteTriggerRequest.new
+              #
+              #   # Call the delete_trigger method.
+              #   result = client.delete_trigger 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_trigger request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -564,6 +690,22 @@ module Google
               # @return [::Google::Cloud::Eventarc::V1::Channel]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::GetChannelRequest.new
+              #
+              #   # Call the get_channel method.
+              #   result = client.get_channel request
+              #
+              #   # The returned object is of type Google::Cloud::Eventarc::V1::Channel.
+              #   p result
+              #
               def get_channel request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -641,6 +783,26 @@ module Google
               # @return [::Google::Cloud::Eventarc::V1::ListChannelsResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::ListChannelsRequest.new
+              #
+              #   # Call the list_channels method.
+              #   result = client.list_channels 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::Eventarc::V1::Channel.
+              #     p item
+              #   end
+              #
               def list_channels request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -710,6 +872,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::CreateChannelRequest.new
+              #
+              #   # Call the create_channel method.
+              #   result = client.create_channel 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_channel request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -780,6 +965,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::UpdateChannelRequest.new
+              #
+              #   # Call the update_channel method.
+              #   result = client.update_channel 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_channel request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -846,6 +1054,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::DeleteChannelRequest.new
+              #
+              #   # Call the delete_channel method.
+              #   result = client.delete_channel 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_channel request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -909,6 +1140,22 @@ module Google
               # @return [::Google::Cloud::Eventarc::V1::Provider]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::GetProviderRequest.new
+              #
+              #   # Call the get_provider method.
+              #   result = client.get_provider request
+              #
+              #   # The returned object is of type Google::Cloud::Eventarc::V1::Provider.
+              #   p result
+              #
               def get_provider request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -986,6 +1233,26 @@ module Google
               # @return [::Google::Cloud::Eventarc::V1::ListProvidersResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::ListProvidersRequest.new
+              #
+              #   # Call the list_providers method.
+              #   result = client.list_providers 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::Eventarc::V1::Provider.
+              #     p item
+              #   end
+              #
               def list_providers request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1048,6 +1315,22 @@ module Google
               # @return [::Google::Cloud::Eventarc::V1::ChannelConnection]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::GetChannelConnectionRequest.new
+              #
+              #   # Call the get_channel_connection method.
+              #   result = client.get_channel_connection request
+              #
+              #   # The returned object is of type Google::Cloud::Eventarc::V1::ChannelConnection.
+              #   p result
+              #
               def get_channel_connection request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1120,6 +1403,26 @@ module Google
               # @return [::Google::Cloud::Eventarc::V1::ListChannelConnectionsResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::ListChannelConnectionsRequest.new
+              #
+              #   # Call the list_channel_connections method.
+              #   result = client.list_channel_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::Eventarc::V1::ChannelConnection.
+              #     p item
+              #   end
+              #
               def list_channel_connections request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1186,6 +1489,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::CreateChannelConnectionRequest.new
+              #
+              #   # Call the create_channel_connection method.
+              #   result = client.create_channel_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_channel_connection request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1249,6 +1575,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::DeleteChannelConnectionRequest.new
+              #
+              #   # Call the delete_channel_connection method.
+              #   result = client.delete_channel_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_channel_connection request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1312,6 +1661,22 @@ module Google
               # @return [::Google::Cloud::Eventarc::V1::GoogleChannelConfig]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::GetGoogleChannelConfigRequest.new
+              #
+              #   # Call the get_google_channel_config method.
+              #   result = client.get_google_channel_config request
+              #
+              #   # The returned object is of type Google::Cloud::Eventarc::V1::GoogleChannelConfig.
+              #   p result
+              #
               def get_google_channel_config request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1378,6 +1743,22 @@ module Google
               # @return [::Google::Cloud::Eventarc::V1::GoogleChannelConfig]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/eventarc/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Eventarc::V1::Eventarc::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Eventarc::V1::UpdateGoogleChannelConfigRequest.new
+              #
+              #   # Call the update_google_channel_config method.
+              #   result = client.update_google_channel_config request
+              #
+              #   # The returned object is of type Google::Cloud::Eventarc::V1::GoogleChannelConfig.
+              #   p result
+              #
               def update_google_channel_config request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1443,9 +1824,9 @@ module Google
               #   end
               #
               # @!attribute [rw] endpoint
-              #   The hostname or hostname:port of the service endpoint.
-              #   Defaults to `"eventarc.googleapis.com"`.
-              #   @return [::String]
+              #   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
@@ -1482,13 +1863,20 @@ module Google
               # @!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 = "eventarc.googleapis.com"
 
-                config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
+                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.any? { |klass| klass === value }
@@ -1500,6 +1888,7 @@ module Google
                 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
                 # Overrides for http bindings for the RPCs of this service