google-cloud-network_security-v1beta1 0.5.1 → 0.7.0

data/lib/google/cloud/network_security/v1beta1/network_security/rest/client.rb

@@ -36,6 +36,9 @@ module Google
             # information.
             #
             class Client
+              # @private
+              DEFAULT_ENDPOINT_TEMPLATE = "networksecurity.$UNIVERSE_DOMAIN$"
+
               include Paths
 
               # @private
@@ -98,6 +101,15 @@ module Google
                 @config
               end
 
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @network_security_stub.universe_domain
+              end
+
               ##
               # Create a new NetworkSecurity REST client object.
               #
@@ -125,8 +137,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)
@@ -140,12 +153,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
 
@@ -153,10 +168,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
 
-                @network_security_stub = ::Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
+                @network_security_stub = ::Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Rest::ServiceStub.new(
+                  endpoint: @config.endpoint,
+                  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                  universe_domain: @config.universe_domain,
+                  credentials: credentials
+                )
               end
 
               ##
@@ -218,6 +239,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1beta1::AuthorizationPolicy>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/network_security/v1beta1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::NetworkSecurity::V1beta1::ListAuthorizationPoliciesRequest.new
+              #
+              #   # Call the list_authorization_policies method.
+              #   result = client.list_authorization_policies 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::NetworkSecurity::V1beta1::AuthorizationPolicy.
+              #     p item
+              #   end
+              #
               def list_authorization_policies request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -282,6 +323,22 @@ module Google
               # @return [::Google::Cloud::NetworkSecurity::V1beta1::AuthorizationPolicy]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/network_security/v1beta1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::NetworkSecurity::V1beta1::GetAuthorizationPolicyRequest.new
+              #
+              #   # Call the get_authorization_policy method.
+              #   result = client.get_authorization_policy request
+              #
+              #   # The returned object is of type Google::Cloud::NetworkSecurity::V1beta1::AuthorizationPolicy.
+              #   p result
+              #
               def get_authorization_policy request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -352,6 +409,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/network_security/v1beta1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::NetworkSecurity::V1beta1::CreateAuthorizationPolicyRequest.new
+              #
+              #   # Call the create_authorization_policy method.
+              #   result = client.create_authorization_policy 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_authorization_policy request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -421,6 +501,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/network_security/v1beta1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::NetworkSecurity::V1beta1::UpdateAuthorizationPolicyRequest.new
+              #
+              #   # Call the update_authorization_policy method.
+              #   result = client.update_authorization_policy 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_authorization_policy request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -485,6 +588,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/network_security/v1beta1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::NetworkSecurity::V1beta1::DeleteAuthorizationPolicyRequest.new
+              #
+              #   # Call the delete_authorization_policy method.
+              #   result = client.delete_authorization_policy 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_authorization_policy request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -556,6 +682,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1beta1::ServerTlsPolicy>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/network_security/v1beta1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::NetworkSecurity::V1beta1::ListServerTlsPoliciesRequest.new
+              #
+              #   # Call the list_server_tls_policies method.
+              #   result = client.list_server_tls_policies 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::NetworkSecurity::V1beta1::ServerTlsPolicy.
+              #     p item
+              #   end
+              #
               def list_server_tls_policies request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -620,6 +766,22 @@ module Google
               # @return [::Google::Cloud::NetworkSecurity::V1beta1::ServerTlsPolicy]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/network_security/v1beta1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::NetworkSecurity::V1beta1::GetServerTlsPolicyRequest.new
+              #
+              #   # Call the get_server_tls_policy method.
+              #   result = client.get_server_tls_policy request
+              #
+              #   # The returned object is of type Google::Cloud::NetworkSecurity::V1beta1::ServerTlsPolicy.
+              #   p result
+              #
               def get_server_tls_policy request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -690,6 +852,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/network_security/v1beta1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::NetworkSecurity::V1beta1::CreateServerTlsPolicyRequest.new
+              #
+              #   # Call the create_server_tls_policy method.
+              #   result = client.create_server_tls_policy 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_server_tls_policy request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -760,6 +945,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/network_security/v1beta1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::NetworkSecurity::V1beta1::UpdateServerTlsPolicyRequest.new
+              #
+              #   # Call the update_server_tls_policy method.
+              #   result = client.update_server_tls_policy 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_server_tls_policy request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -824,6 +1032,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/network_security/v1beta1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::NetworkSecurity::V1beta1::DeleteServerTlsPolicyRequest.new
+              #
+              #   # Call the delete_server_tls_policy method.
+              #   result = client.delete_server_tls_policy 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_server_tls_policy request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -895,6 +1126,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1beta1::ClientTlsPolicy>]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/network_security/v1beta1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::NetworkSecurity::V1beta1::ListClientTlsPoliciesRequest.new
+              #
+              #   # Call the list_client_tls_policies method.
+              #   result = client.list_client_tls_policies 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::NetworkSecurity::V1beta1::ClientTlsPolicy.
+              #     p item
+              #   end
+              #
               def list_client_tls_policies request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -959,6 +1210,22 @@ module Google
               # @return [::Google::Cloud::NetworkSecurity::V1beta1::ClientTlsPolicy]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/network_security/v1beta1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::NetworkSecurity::V1beta1::GetClientTlsPolicyRequest.new
+              #
+              #   # Call the get_client_tls_policy method.
+              #   result = client.get_client_tls_policy request
+              #
+              #   # The returned object is of type Google::Cloud::NetworkSecurity::V1beta1::ClientTlsPolicy.
+              #   p result
+              #
               def get_client_tls_policy request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1029,6 +1296,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/network_security/v1beta1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::NetworkSecurity::V1beta1::CreateClientTlsPolicyRequest.new
+              #
+              #   # Call the create_client_tls_policy method.
+              #   result = client.create_client_tls_policy 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_client_tls_policy request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1099,6 +1389,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/network_security/v1beta1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::NetworkSecurity::V1beta1::UpdateClientTlsPolicyRequest.new
+              #
+              #   # Call the update_client_tls_policy method.
+              #   result = client.update_client_tls_policy 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_client_tls_policy request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1163,6 +1476,29 @@ module Google
               # @return [::Gapic::Operation]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/network_security/v1beta1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::NetworkSecurity::V1beta1::DeleteClientTlsPolicyRequest.new
+              #
+              #   # Call the delete_client_tls_policy method.
+              #   result = client.delete_client_tls_policy 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_client_tls_policy request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -1229,9 +1565,9 @@ module Google
               #   end
               #
               # @!attribute [rw] endpoint
-              #   The hostname or hostname:port of the service endpoint.
-              #   Defaults to `"networksecurity.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
@@ -1268,13 +1604,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 = "networksecurity.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 }
@@ -1286,6 +1629,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