class Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Client
Client
for the NetworkSecurity
service.
Network Security API provides resources to configure authentication and authorization policies. Refer to per API resource documentation for more information.
Attributes
@private
Get the associated client for long-running operations.
@return [::Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Operations]
Public Class Methods
Configure the NetworkSecurity
Client
class.
See {::Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all NetworkSecurity clients ::Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/network_security/v1beta1/network_security/client.rb, line 58 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "NetworkSecurity", "V1beta1"] 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 end yield @configure if block_given? @configure end
Create a new NetworkSecurity
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Client.new # Create a client using a custom configuration client = ::Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the NetworkSecurity
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/network_security/v1beta1/network_security/client.rb, line 113 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/networksecurity/v1beta1/network_security_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 == Client.configure.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 end @network_security_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Configure the NetworkSecurity
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::NetworkSecurity::V1beta1::NetworkSecurity::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/network_security/v1beta1/network_security/client.rb, line 92 def configure yield @config if block_given? @config end
Creates a new ClientTlsPolicy in a given project and location.
@overload create_client_tls_policy
(request, options = nil)
Pass arguments to `create_client_tls_policy` via a request object, either of type {::Google::Cloud::NetworkSecurity::V1beta1::CreateClientTlsPolicyRequest} or an equivalent Hash. @param request [::Google::Cloud::NetworkSecurity::V1beta1::CreateClientTlsPolicyRequest, ::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_client_tls_policy
(parent: nil, client_tls_policy_id: nil, client_tls_policy: nil)
Pass arguments to `create_client_tls_policy` 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 ClientTlsPolicy. Must be in the format `projects/*/locations/{location}`. @param client_tls_policy_id [::String] Required. Short name of the ClientTlsPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "client_mtls_policy". @param client_tls_policy [::Google::Cloud::NetworkSecurity::V1beta1::ClientTlsPolicy, ::Hash] Required. ClientTlsPolicy resource to be created.
@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/network_security/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::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 this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
# File lib/google/cloud/network_security/v1beta1/network_security/client.rb, line 1369 def create_client_tls_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1beta1::CreateClientTlsPolicyRequest # 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_client_tls_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::NetworkSecurity::V1beta1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_client_tls_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.create_client_tls_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @network_security_stub.call_rpc :create_client_tls_policy, 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
Creates a new ServerTlsPolicy
in a given project and location.
@overload create_server_tls_policy
(request, options = nil)
Pass arguments to `create_server_tls_policy` via a request object, either of type {::Google::Cloud::NetworkSecurity::V1beta1::CreateServerTlsPolicyRequest} or an equivalent Hash. @param request [::Google::Cloud::NetworkSecurity::V1beta1::CreateServerTlsPolicyRequest, ::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_server_tls_policy
(parent: nil, server_tls_policy_id: nil, server_tls_policy: nil)
Pass arguments to `create_server_tls_policy` 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 ServerTlsPolicy. Must be in the format `projects/*/locations/{location}`. @param server_tls_policy_id [::String] Required. Short name of the ServerTlsPolicy resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "server_mtls_policy". @param server_tls_policy [::Google::Cloud::NetworkSecurity::V1beta1::ServerTlsPolicy, ::Hash] Required. ServerTlsPolicy resource to be created.
@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/network_security/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::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 this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
# File lib/google/cloud/network_security/v1beta1/network_security/client.rb, line 889 def create_server_tls_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1beta1::CreateServerTlsPolicyRequest # 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_server_tls_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::NetworkSecurity::V1beta1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_server_tls_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.create_server_tls_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @network_security_stub.call_rpc :create_server_tls_policy, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Deletes a single ClientTlsPolicy.
@overload delete_client_tls_policy
(request, options = nil)
Pass arguments to `delete_client_tls_policy` via a request object, either of type {::Google::Cloud::NetworkSecurity::V1beta1::DeleteClientTlsPolicyRequest} or an equivalent Hash. @param request [::Google::Cloud::NetworkSecurity::V1beta1::DeleteClientTlsPolicyRequest, ::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_client_tls_policy
(name: nil)
Pass arguments to `delete_client_tls_policy` 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. A name of the ClientTlsPolicy to delete. Must be in the format `projects/*/locations/{location}/clientTlsPolicies/*`.
@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/network_security/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::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 this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
# File lib/google/cloud/network_security/v1beta1/network_security/client.rb, line 1563 def delete_client_tls_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1beta1::DeleteClientTlsPolicyRequest # 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_client_tls_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::NetworkSecurity::V1beta1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_client_tls_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_client_tls_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @network_security_stub.call_rpc :delete_client_tls_policy, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Deletes a single ServerTlsPolicy
.
@overload delete_server_tls_policy
(request, options = nil)
Pass arguments to `delete_server_tls_policy` via a request object, either of type {::Google::Cloud::NetworkSecurity::V1beta1::DeleteServerTlsPolicyRequest} or an equivalent Hash. @param request [::Google::Cloud::NetworkSecurity::V1beta1::DeleteServerTlsPolicyRequest, ::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_server_tls_policy
(name: nil)
Pass arguments to `delete_server_tls_policy` 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. A name of the ServerTlsPolicy to delete. Must be in the format `projects/*/locations/{location}/serverTlsPolicies/*`.
@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/network_security/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::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 this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
# File lib/google/cloud/network_security/v1beta1/network_security/client.rb, line 1083 def delete_server_tls_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1beta1::DeleteServerTlsPolicyRequest # 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_server_tls_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::NetworkSecurity::V1beta1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_server_tls_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_server_tls_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @network_security_stub.call_rpc :delete_server_tls_policy, 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
Gets details of a single ClientTlsPolicy.
@overload get_client_tls_policy
(request, options = nil)
Pass arguments to `get_client_tls_policy` via a request object, either of type {::Google::Cloud::NetworkSecurity::V1beta1::GetClientTlsPolicyRequest} or an equivalent Hash. @param request [::Google::Cloud::NetworkSecurity::V1beta1::GetClientTlsPolicyRequest, ::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_client_tls_policy
(name: nil)
Pass arguments to `get_client_tls_policy` 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. A name of the ClientTlsPolicy to get. Must be in the format `projects/*/locations/{location}/clientTlsPolicies/*`.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::NetworkSecurity::V1beta1::ClientTlsPolicy] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::NetworkSecurity::V1beta1::ClientTlsPolicy]
@raise [::Google::Cloud::Error] if the RPC 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::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
# File lib/google/cloud/network_security/v1beta1/network_security/client.rb, line 1270 def get_client_tls_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1beta1::GetClientTlsPolicyRequest # 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_client_tls_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::NetworkSecurity::V1beta1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_client_tls_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.get_client_tls_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @network_security_stub.call_rpc :get_client_tls_policy, 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
Gets details of a single ServerTlsPolicy
.
@overload get_server_tls_policy
(request, options = nil)
Pass arguments to `get_server_tls_policy` via a request object, either of type {::Google::Cloud::NetworkSecurity::V1beta1::GetServerTlsPolicyRequest} or an equivalent Hash. @param request [::Google::Cloud::NetworkSecurity::V1beta1::GetServerTlsPolicyRequest, ::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_server_tls_policy
(name: nil)
Pass arguments to `get_server_tls_policy` 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. A name of the ServerTlsPolicy to get. Must be in the format `projects/*/locations/{location}/serverTlsPolicies/*`.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::NetworkSecurity::V1beta1::ServerTlsPolicy] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::NetworkSecurity::V1beta1::ServerTlsPolicy]
@raise [::Google::Cloud::Error] if the RPC 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::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
# File lib/google/cloud/network_security/v1beta1/network_security/client.rb, line 790 def get_server_tls_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1beta1::GetServerTlsPolicyRequest # 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_server_tls_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::NetworkSecurity::V1beta1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_server_tls_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.get_server_tls_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @network_security_stub.call_rpc :get_server_tls_policy, 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
Lists ClientTlsPolicies in a given project and location.
@overload list_client_tls_policies
(request, options = nil)
Pass arguments to `list_client_tls_policies` via a request object, either of type {::Google::Cloud::NetworkSecurity::V1beta1::ListClientTlsPoliciesRequest} or an equivalent Hash. @param request [::Google::Cloud::NetworkSecurity::V1beta1::ListClientTlsPoliciesRequest, ::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_client_tls_policies
(parent: nil, page_size: nil, page_token: nil)
Pass arguments to `list_client_tls_policies` 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 project and location from which the ClientTlsPolicies should be listed, specified in the format `projects/*/locations/{location}`. @param page_size [::Integer] Maximum number of ClientTlsPolicies to return per call. @param page_token [::String] The value returned by the last `ListClientTlsPoliciesResponse` Indicates that this is a continuation of a prior `ListClientTlsPolicies` call, and that the system should return the next page of data.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1beta1::ClientTlsPolicy>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1beta1::ClientTlsPolicy>]
@raise [::Google::Cloud::Error] if the RPC 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::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 all elements by calling #each, and the enumerable # will lazily make API calls to fetch subsequent pages. Other # methods are also available for managing paging directly. result.each do |response| # Each element is of type ::Google::Cloud::NetworkSecurity::V1beta1::ClientTlsPolicy. p response end
# File lib/google/cloud/network_security/v1beta1/network_security/client.rb, line 1183 def list_client_tls_policies request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1beta1::ListClientTlsPoliciesRequest # 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_client_tls_policies.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::NetworkSecurity::V1beta1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_client_tls_policies.timeout, metadata: metadata, retry_policy: @config.rpcs.list_client_tls_policies.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @network_security_stub.call_rpc :list_client_tls_policies, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @network_security_stub, :list_client_tls_policies, 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
Lists ServerTlsPolicies in a given project and location.
@overload list_server_tls_policies
(request, options = nil)
Pass arguments to `list_server_tls_policies` via a request object, either of type {::Google::Cloud::NetworkSecurity::V1beta1::ListServerTlsPoliciesRequest} or an equivalent Hash. @param request [::Google::Cloud::NetworkSecurity::V1beta1::ListServerTlsPoliciesRequest, ::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_server_tls_policies
(parent: nil, page_size: nil, page_token: nil)
Pass arguments to `list_server_tls_policies` 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 project and location from which the ServerTlsPolicies should be listed, specified in the format `projects/*/locations/{location}`. @param page_size [::Integer] Maximum number of ServerTlsPolicies to return per call. @param page_token [::String] The value returned by the last `ListServerTlsPoliciesResponse` Indicates that this is a continuation of a prior `ListServerTlsPolicies` call, and that the system should return the next page of data.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1beta1::ServerTlsPolicy>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::NetworkSecurity::V1beta1::ServerTlsPolicy>]
@raise [::Google::Cloud::Error] if the RPC 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::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 all elements by calling #each, and the enumerable # will lazily make API calls to fetch subsequent pages. Other # methods are also available for managing paging directly. result.each do |response| # Each element is of type ::Google::Cloud::NetworkSecurity::V1beta1::ServerTlsPolicy. p response end
# File lib/google/cloud/network_security/v1beta1/network_security/client.rb, line 703 def list_server_tls_policies request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1beta1::ListServerTlsPoliciesRequest # 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_server_tls_policies.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::NetworkSecurity::V1beta1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_server_tls_policies.timeout, metadata: metadata, retry_policy: @config.rpcs.list_server_tls_policies.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @network_security_stub.call_rpc :list_server_tls_policies, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @network_security_stub, :list_server_tls_policies, 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
Updates the parameters of a single ClientTlsPolicy.
@overload update_client_tls_policy
(request, options = nil)
Pass arguments to `update_client_tls_policy` via a request object, either of type {::Google::Cloud::NetworkSecurity::V1beta1::UpdateClientTlsPolicyRequest} or an equivalent Hash. @param request [::Google::Cloud::NetworkSecurity::V1beta1::UpdateClientTlsPolicyRequest, ::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_client_tls_policy
(update_mask: nil, client_tls_policy: nil)
Pass arguments to `update_client_tls_policy` 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 ClientTlsPolicy 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 client_tls_policy [::Google::Cloud::NetworkSecurity::V1beta1::ClientTlsPolicy, ::Hash] Required. Updated ClientTlsPolicy resource.
@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/network_security/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::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 this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
# File lib/google/cloud/network_security/v1beta1/network_security/client.rb, line 1469 def update_client_tls_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1beta1::UpdateClientTlsPolicyRequest # 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_client_tls_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::NetworkSecurity::V1beta1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.client_tls_policy&.name header_params["client_tls_policy.name"] = request.client_tls_policy.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_client_tls_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.update_client_tls_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @network_security_stub.call_rpc :update_client_tls_policy, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Updates the parameters of a single ServerTlsPolicy
.
@overload update_server_tls_policy
(request, options = nil)
Pass arguments to `update_server_tls_policy` via a request object, either of type {::Google::Cloud::NetworkSecurity::V1beta1::UpdateServerTlsPolicyRequest} or an equivalent Hash. @param request [::Google::Cloud::NetworkSecurity::V1beta1::UpdateServerTlsPolicyRequest, ::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_server_tls_policy
(update_mask: nil, server_tls_policy: nil)
Pass arguments to `update_server_tls_policy` 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 ServerTlsPolicy 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 server_tls_policy [::Google::Cloud::NetworkSecurity::V1beta1::ServerTlsPolicy, ::Hash] Required. Updated ServerTlsPolicy resource.
@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/network_security/v1beta1" # Create a client object. The client can be reused for multiple calls. client = Google::Cloud::NetworkSecurity::V1beta1::NetworkSecurity::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 this # object to check the status of an operation, cancel it, or wait # for results. Here is how to block until completion: result.wait_until_done! timeout: 60 if result.response? p result.response else puts "Error!" end
# File lib/google/cloud/network_security/v1beta1/network_security/client.rb, line 989 def update_server_tls_policy request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::NetworkSecurity::V1beta1::UpdateServerTlsPolicyRequest # 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_server_tls_policy.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::NetworkSecurity::V1beta1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.server_tls_policy&.name header_params["server_tls_policy.name"] = request.server_tls_policy.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_server_tls_policy.timeout, metadata: metadata, retry_policy: @config.rpcs.update_server_tls_policy.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @network_security_stub.call_rpc :update_server_tls_policy, 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