google-cloud-chronicle-v1 0.6.0 → 0.8.0

data/lib/google/cloud/chronicle/v1/reference_list_service/rest/client.rb

@@ -86,6 +86,11 @@ module Google
 
                   default_config.rpcs.update_reference_list.timeout = 60.0
 
+                  default_config.rpcs.verify_reference_list.timeout = 60.0
+                  default_config.rpcs.verify_reference_list.retry_policy = {
+                    initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
+                  }
+
                   default_config
                 end
                 yield @configure if block_given?
@@ -547,6 +552,91 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # VerifyReferenceList validates list content and returns line errors, if any.
+              #
+              # @overload verify_reference_list(request, options = nil)
+              #   Pass arguments to `verify_reference_list` via a request object, either of type
+              #   {::Google::Cloud::Chronicle::V1::VerifyReferenceListRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Chronicle::V1::VerifyReferenceListRequest, ::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 verify_reference_list(instance: nil, syntax_type: nil, entries: nil)
+              #   Pass arguments to `verify_reference_list` 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 instance [::String]
+              #     Required. The name of the parent resource, which is the SecOps instance
+              #     associated with the request. Format:
+              #     `projects/{project}/locations/{location}/instances/{instance}`
+              #   @param syntax_type [::Google::Cloud::Chronicle::V1::ReferenceListSyntaxType]
+              #     Required. Type (format) of list lines.
+              #   @param entries [::Array<::Google::Cloud::Chronicle::V1::ReferenceListEntry, ::Hash>]
+              #     Required. The entries of the reference list.
+              #     Each line may be either an item in the list or a comment.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Chronicle::V1::VerifyReferenceListResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Chronicle::V1::VerifyReferenceListResponse]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/chronicle/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Chronicle::V1::ReferenceListService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Chronicle::V1::VerifyReferenceListRequest.new
+              #
+              #   # Call the verify_reference_list method.
+              #   result = client.verify_reference_list request
+              #
+              #   # The returned object is of type Google::Cloud::Chronicle::V1::VerifyReferenceListResponse.
+              #   p result
+              #
+              def verify_reference_list request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Chronicle::V1::VerifyReferenceListRequest
+
+                # 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
+                call_metadata = @config.rpcs.verify_reference_list.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                call_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::Chronicle::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.verify_reference_list.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.verify_reference_list.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @reference_list_service_stub.verify_reference_list request, options do |result, operation|
+                  yield result, operation if block_given?
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Configuration class for the ReferenceListService REST API.
               #
@@ -617,6 +707,7 @@ module Google
               #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
               #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
               #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #    *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
               #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
               #       trigger a retry.
               #   @return [::Hash]
@@ -689,6 +780,7 @@ module Google
                 #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
                 #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
                 #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+                #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
                 #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
                 #         trigger a retry.
                 #
@@ -713,6 +805,11 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :update_reference_list
+                  ##
+                  # RPC-specific configuration for `verify_reference_list`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :verify_reference_list
 
                   # @private
                   def initialize parent_rpcs = nil
@@ -724,6 +821,8 @@ module Google
                     @create_reference_list = ::Gapic::Config::Method.new create_reference_list_config
                     update_reference_list_config = parent_rpcs.update_reference_list if parent_rpcs.respond_to? :update_reference_list
                     @update_reference_list = ::Gapic::Config::Method.new update_reference_list_config
+                    verify_reference_list_config = parent_rpcs.verify_reference_list if parent_rpcs.respond_to? :verify_reference_list
+                    @verify_reference_list = ::Gapic::Config::Method.new verify_reference_list_config
 
                     yield self if block_given?
                   end

data/lib/google/cloud/chronicle/v1/reference_list_service/rest/service_stub.rb

@@ -233,6 +233,46 @@ module Google
                 end
               end
 
+              ##
+              # Baseline implementation for the verify_reference_list REST call
+              #
+              # @param request_pb [::Google::Cloud::Chronicle::V1::VerifyReferenceListRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::Chronicle::V1::VerifyReferenceListResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::Chronicle::V1::VerifyReferenceListResponse]
+              #   A result object deserialized from the server's reply
+              def verify_reference_list request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_verify_reference_list_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "verify_reference_list",
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::Chronicle::V1::VerifyReferenceListResponse.decode_json response.body, ignore_unknown_fields: true
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
+              end
+
               ##
               # @private
               #
@@ -318,6 +358,28 @@ module Google
                                                         )
                 transcoder.transcode request_pb
               end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the verify_reference_list REST call
+              #
+              # @param request_pb [::Google::Cloud::Chronicle::V1::VerifyReferenceListRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_verify_reference_list_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1/{instance}:verifyReferenceList",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["instance", %r{^projects/[^/]+/locations/[^/]+/instances/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
             end
           end
         end

data/lib/google/cloud/chronicle/v1/reference_list_services_pb.rb

@@ -41,6 +41,8 @@ module Google
             rpc :CreateReferenceList, ::Google::Cloud::Chronicle::V1::CreateReferenceListRequest, ::Google::Cloud::Chronicle::V1::ReferenceList
             # Updates an existing reference list.
             rpc :UpdateReferenceList, ::Google::Cloud::Chronicle::V1::UpdateReferenceListRequest, ::Google::Cloud::Chronicle::V1::ReferenceList
+            # VerifyReferenceList validates list content and returns line errors, if any.
+            rpc :VerifyReferenceList, ::Google::Cloud::Chronicle::V1::VerifyReferenceListRequest, ::Google::Cloud::Chronicle::V1::VerifyReferenceListResponse
           end
 
           Stub = Service.rpc_stub_class

data/lib/google/cloud/chronicle/v1/rest.rb

@@ -27,6 +27,7 @@ require "google/cloud/chronicle/v1/featured_content_native_dashboard_service/res
 require "google/cloud/chronicle/v1/instance_service/rest"
 require "google/cloud/chronicle/v1/reference_list_service/rest"
 require "google/cloud/chronicle/v1/rule_service/rest"
+require "google/cloud/chronicle/v1/rule_execution_error_service/rest"
 require "google/cloud/chronicle/v1/version"
 
 module Google

data/lib/google/cloud/chronicle/v1/rule_execution_error_pb.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/chronicle/v1/rule_execution_error.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/rpc/status_pb'
+require 'google/type/interval_pb'
+
+
+descriptor_data = "\n4google/cloud/chronicle/v1/rule_execution_error.proto\x12\x19google.cloud.chronicle.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x19google/api/resource.proto\x1a\x17google/rpc/status.proto\x1a\x1agoogle/type/interval.proto\"\x9c\x01\n\x1eListRuleExecutionErrorsRequest\x12\x43\n\x06parent\x18\x01 \x01(\tB3\xe0\x41\x02\xfa\x41-\x12+chronicle.googleapis.com/RuleExecutionError\x12\x11\n\tpage_size\x18\x02 \x01(\x05\x12\x12\n\npage_token\x18\x03 \x01(\t\x12\x0e\n\x06\x66ilter\x18\x04 \x01(\t\"\x88\x01\n\x1fListRuleExecutionErrorsResponse\x12L\n\x15rule_execution_errors\x18\x01 \x03(\x0b\x32-.google.cloud.chronicle.v1.RuleExecutionError\x12\x17\n\x0fnext_page_token\x18\x02 \x01(\t\"\xa3\x03\n\x12RuleExecutionError\x12\x35\n\x04rule\x18\x04 \x01(\tB%\xe0\x41\x03\xfa\x41\x1f\n\x1d\x63hronicle.googleapis.com/RuleH\x00\x12\x44\n\x0c\x63urated_rule\x18\x05 \x01(\tB,\xe0\x41\x03\xfa\x41&\n$chronicle.googleapis.com/CuratedRuleH\x00\x12\x11\n\x04name\x18\x01 \x01(\tB\x03\xe0\x41\x03\x12&\n\x05\x65rror\x18\x02 \x01(\x0b\x32\x12.google.rpc.StatusB\x03\xe0\x41\x03\x12.\n\ntime_range\x18\x03 \x01(\x0b\x32\x15.google.type.IntervalB\x03\xe0\x41\x03:\x9a\x01\xea\x41\x96\x01\n+chronicle.googleapis.com/RuleExecutionError\x12gprojects/{project}/locations/{location}/instances/{instance}/ruleExecutionErrors/{rule_execution_error}B\x08\n\x06source2\xb1\x03\n\x19RuleExecutionErrorService\x12\xe6\x01\n\x17ListRuleExecutionErrors\x12\x39.google.cloud.chronicle.v1.ListRuleExecutionErrorsRequest\x1a:.google.cloud.chronicle.v1.ListRuleExecutionErrorsResponse\"T\xda\x41\x06parent\x82\xd3\xe4\x93\x02\x45\x12\x43/v1/{parent=projects/*/locations/*/instances/*}/ruleExecutionErrors\x1a\xaa\x01\xca\x41\x18\x63hronicle.googleapis.com\xd2\x41\x8b\x01https://www.googleapis.com/auth/chronicle,https://www.googleapis.com/auth/chronicle.readonly,https://www.googleapis.com/auth/cloud-platformB\xd0\x02\n\x1d\x63om.google.cloud.chronicle.v1B\x17RuleExecutionErrorProtoP\x01Z;cloud.google.com/go/chronicle/apiv1/chroniclepb;chroniclepb\xaa\x02\x19Google.Cloud.Chronicle.V1\xca\x02\x19Google\\Cloud\\Chronicle\\V1\xea\x02\x1cGoogle::Cloud::Chronicle::V1\xea\x41\x7f\n$chronicle.googleapis.com/CuratedRule\x12Wprojects/{project}/locations/{location}/instances/{instance}/curatedRules/{curatedRule}b\x06proto3"
+
+pool = ::Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
+
+module Google
+  module Cloud
+    module Chronicle
+      module V1
+        ListRuleExecutionErrorsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.chronicle.v1.ListRuleExecutionErrorsRequest").msgclass
+        ListRuleExecutionErrorsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.chronicle.v1.ListRuleExecutionErrorsResponse").msgclass
+        RuleExecutionError = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.chronicle.v1.RuleExecutionError").msgclass
+      end
+    end
+  end
+end