google-cloud-cloud_security_compliance 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08ee5e1b8b1cae430cfe8b2d32be4a401ae6736a06527ba133d0a4ebc0b7ae13'
-  data.tar.gz: 629d1a72deca848735bfb6527ff38e6bca8f9befa5346419f88556849e6f849a
+  metadata.gz: 113ff2adb05c7a19e831cf4c4163b4d42f4e0c892ee5bea60579b45d520b555d
+  data.tar.gz: 577c69122e62667713b1d55cc364558a761e15ff639918a1a4554a8198e873df
 SHA512:
-  metadata.gz: 9cddf8596d19f828e5249f99ca9733f3203b95f632901f77111b6f75d6f383b027c361c5822cfee38e8aa026622bc2bff86faec7b15c0543289c224575cd970c
-  data.tar.gz: f14bbb7794ea8f1454b4a5d6b324bf4a6a453d34776ea0114099027f34be58d5c230600a7025274b567e579accf41c06962f472f5ffc250c885230c43a7d7e58
+  metadata.gz: 5d8e0c694182ef3e6dc637d6a1552fad345c2edac27191669416a7fdf6b6383be4ef2f3d60bfa52896f325858d148a682176645597b66ce08f022392450deee3
+  data.tar.gz: 9fe611bb086b986ca84546f32df882d25b3e6a2f105d967cfaaab4b364c8dde0d27c067e7aee2bb59dd6ccd756046fc82557579979598c999d75270d856b82b5

data/AUTHENTICATION.md

@@ -56,7 +56,7 @@ To configure a credentials file for an individual client initialization:
 ```ruby
 require "google/cloud/cloud_security_compliance"
 
-client = Google::Cloud::CloudSecurityCompliance.config do |config|
+client = Google::Cloud::CloudSecurityCompliance.audit do |config|
   config.credentials = "path/to/credentialfile.json"
 end
 ```
@@ -70,7 +70,7 @@ Google::Cloud::CloudSecurityCompliance.configure do |config|
   config.credentials = "path/to/credentialfile.json"
 end
 
-client = Google::Cloud::CloudSecurityCompliance.config
+client = Google::Cloud::CloudSecurityCompliance.audit
 ```
 
 ### Environment Variables
@@ -100,7 +100,7 @@ require "google/cloud/cloud_security_compliance"
 
 ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
 
-client = Google::Cloud::CloudSecurityCompliance.config
+client = Google::Cloud::CloudSecurityCompliance.audit
 ```
 
 ### Local ADC file

data/README.md

@@ -37,9 +37,9 @@ In order to use this library, you first need to go through the following steps:
 ```ruby
 require "google/cloud/cloud_security_compliance"
 
-client = Google::Cloud::CloudSecurityCompliance.config
-request = ::Google::Cloud::CloudSecurityCompliance::V1::ListFrameworksRequest.new # (request fields as keyword arguments...)
-response = client.list_frameworks request
+client = Google::Cloud::CloudSecurityCompliance.audit
+request = ::Google::Cloud::CloudSecurityCompliance::V1::GenerateFrameworkAuditScopeReportRequest.new # (request fields as keyword arguments...)
+response = client.generate_framework_audit_scope_report request
 ```
 
 ## Debug Logging

data/lib/google/cloud/cloud_security_compliance/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module CloudSecurityCompliance
-      VERSION = "0.1.0"
+      VERSION = "0.2.0"
     end
   end
 end

data/lib/google/cloud/cloud_security_compliance.rb

@@ -45,6 +45,147 @@ end
 module Google
   module Cloud
     module CloudSecurityCompliance
+      ##
+      # Create a new client object for Audit.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::CloudSecurityCompliance::V1::Audit::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-cloud_security_compliance-v1/latest/Google-Cloud-CloudSecurityCompliance-V1-Audit-Client)
+      # for a gRPC client for version V1 of the API.
+      # However, you can specify a different API version by passing it in the
+      # `version` parameter. If the Audit service is
+      # supported by that API version, and the corresponding gem is available, the
+      # appropriate versioned client will be returned.
+      # You can also specify a different transport by passing `:rest` or `:grpc` in
+      # the `transport` parameter.
+      #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the Audit service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::CloudSecurityCompliance.audit_available?}.
+      #
+      # ## About Audit
+      #
+      # Service describing handlers for resources
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [::Object] A client object for the specified version.
+      #
+      def self.audit version: :v1, transport: :grpc, &block
+        require "google/cloud/cloud_security_compliance/#{version.to_s.downcase}"
+
+        package_name = Google::Cloud::CloudSecurityCompliance
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        service_module = Google::Cloud::CloudSecurityCompliance.const_get(package_name).const_get(:Audit)
+        service_module = service_module.const_get(:Rest) if transport == :rest
+        service_module.const_get(:Client).new(&block)
+      end
+
+      ##
+      # Determines whether the Audit service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::CloudSecurityCompliance.audit}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Audit service,
+      # or if the versioned client gem needs an update to support the Audit service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.audit_available? version: :v1, transport: :grpc
+        require "google/cloud/cloud_security_compliance/#{version.to_s.downcase}"
+        package_name = Google::Cloud::CloudSecurityCompliance
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::CloudSecurityCompliance.const_get package_name
+        return false unless service_module.const_defined? :Audit
+        service_module = service_module.const_get :Audit
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
+      ##
+      # Create a new client object for CmEnrollmentService.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::CloudSecurityCompliance::V1::CmEnrollmentService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-cloud_security_compliance-v1/latest/Google-Cloud-CloudSecurityCompliance-V1-CmEnrollmentService-Client)
+      # for a gRPC client for version V1 of the API.
+      # However, you can specify a different API version by passing it in the
+      # `version` parameter. If the CmEnrollmentService service is
+      # supported by that API version, and the corresponding gem is available, the
+      # appropriate versioned client will be returned.
+      # You can also specify a different transport by passing `:rest` or `:grpc` in
+      # the `transport` parameter.
+      #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the CmEnrollmentService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::CloudSecurityCompliance.cm_enrollment_service_available?}.
+      #
+      # ## About CmEnrollmentService
+      #
+      # Service describing CmEnrollment related RPCs for
+      # complianceManager.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [::Object] A client object for the specified version.
+      #
+      def self.cm_enrollment_service version: :v1, transport: :grpc, &block
+        require "google/cloud/cloud_security_compliance/#{version.to_s.downcase}"
+
+        package_name = Google::Cloud::CloudSecurityCompliance
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        service_module = Google::Cloud::CloudSecurityCompliance.const_get(package_name).const_get(:CmEnrollmentService)
+        service_module = service_module.const_get(:Rest) if transport == :rest
+        service_module.const_get(:Client).new(&block)
+      end
+
+      ##
+      # Determines whether the CmEnrollmentService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::CloudSecurityCompliance.cm_enrollment_service}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the CmEnrollmentService service,
+      # or if the versioned client gem needs an update to support the CmEnrollmentService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.cm_enrollment_service_available? version: :v1, transport: :grpc
+        require "google/cloud/cloud_security_compliance/#{version.to_s.downcase}"
+        package_name = Google::Cloud::CloudSecurityCompliance
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::CloudSecurityCompliance.const_get package_name
+        return false unless service_module.const_defined? :CmEnrollmentService
+        service_module = service_module.const_get :CmEnrollmentService
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Create a new client object for Config.
       #
@@ -187,6 +328,76 @@ module Google
         false
       end
 
+      ##
+      # Create a new client object for Monitoring.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::CloudSecurityCompliance::V1::Monitoring::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-cloud_security_compliance-v1/latest/Google-Cloud-CloudSecurityCompliance-V1-Monitoring-Client)
+      # for a gRPC client for version V1 of the API.
+      # However, you can specify a different API version by passing it in the
+      # `version` parameter. If the Monitoring service is
+      # supported by that API version, and the corresponding gem is available, the
+      # appropriate versioned client will be returned.
+      # You can also specify a different transport by passing `:rest` or `:grpc` in
+      # the `transport` parameter.
+      #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the given transport of the Monitoring service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::CloudSecurityCompliance.monitoring_available?}.
+      #
+      # ## About Monitoring
+      #
+      # Service describing handlers for resources
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [::Object] A client object for the specified version.
+      #
+      def self.monitoring version: :v1, transport: :grpc, &block
+        require "google/cloud/cloud_security_compliance/#{version.to_s.downcase}"
+
+        package_name = Google::Cloud::CloudSecurityCompliance
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        service_module = Google::Cloud::CloudSecurityCompliance.const_get(package_name).const_get(:Monitoring)
+        service_module = service_module.const_get(:Rest) if transport == :rest
+        service_module.const_get(:Client).new(&block)
+      end
+
+      ##
+      # Determines whether the Monitoring service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::CloudSecurityCompliance.monitoring}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the Monitoring service,
+      # or if the versioned client gem needs an update to support the Monitoring service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.monitoring_available? version: :v1, transport: :grpc
+        require "google/cloud/cloud_security_compliance/#{version.to_s.downcase}"
+        package_name = Google::Cloud::CloudSecurityCompliance
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::CloudSecurityCompliance.const_get package_name
+        return false unless service_module.const_defined? :Monitoring
+        service_module = service_module.const_get :Monitoring
+        if transport == :rest
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+        end
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Configure the google-cloud-cloud_security_compliance library.
       #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-cloud_security_compliance
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Google LLC