google-cloud-chronicle 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b67cf867c44baa2839572aab76521897db3b843ed774d9826027c796016783bd
-  data.tar.gz: aa00be671bc5a818dd9ffc4df3cc2b41615cc4a7d8c9bbf0cb74c645078bb3fc
+  metadata.gz: 581d62a281c22a3b869ea6250259025ee774964f51d4d224de98df94da6265e2
+  data.tar.gz: caa25c4c7d7afc58a30cb5197a0fbd0efcb3c8e5d32797423e25946179d73029
 SHA512:
-  metadata.gz: d87a735d12ca017671d264999b10d32331cb0e3895de98f55149f001cc447549d1aea1bd92feea0bcc1ddec08ad8f58cdbbf1a11ffbe4ceefd67cdb93a748400
-  data.tar.gz: a91971effc5777980616927923b6579eca20105af3b42e0067d43295d761b59887495ddae3c01e7e12d54bb63d996603b171b9fd5922be0e438ae0b083542177
+  metadata.gz: 5d8d1b821dc8b958a357ed01132d913ab9641f4e7f91c08c3f458cf7aac5c5514d94848f44fcd0be65cee74a466a66efdc323cfe9966ad352177f45930d7c619
+  data.tar.gz: aa03ec3581f44c96b19e7ac8ced9089869831f1189f9343a5d94af158bd814f96ddd9df99043d6cd16a1fa7852c0f928cd1e5c914f9aeaeb83b87e504e453c92

data/AUTHENTICATION.md

@@ -56,7 +56,7 @@ To configure a credentials file for an individual client initialization:
 ```ruby
 require "google/cloud/chronicle"
 
-client = Google::Cloud::Chronicle.data_access_control_service do |config|
+client = Google::Cloud::Chronicle.big_query_export_service do |config|
   config.credentials = "path/to/credentialfile.json"
 end
 ```
@@ -70,7 +70,7 @@ Google::Cloud::Chronicle.configure do |config|
   config.credentials = "path/to/credentialfile.json"
 end
 
-client = Google::Cloud::Chronicle.data_access_control_service
+client = Google::Cloud::Chronicle.big_query_export_service
 ```
 
 ### Environment Variables
@@ -100,7 +100,7 @@ require "google/cloud/chronicle"
 
 ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
 
-client = Google::Cloud::Chronicle.data_access_control_service
+client = Google::Cloud::Chronicle.big_query_export_service
 ```
 
 ### 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/chronicle"
 
-client = Google::Cloud::Chronicle.data_access_control_service
-request = ::Google::Cloud::Chronicle::V1::CreateDataAccessLabelRequest.new # (request fields as keyword arguments...)
-response = client.create_data_access_label request
+client = Google::Cloud::Chronicle.big_query_export_service
+request = ::Google::Cloud::Chronicle::V1::GetBigQueryExportRequest.new # (request fields as keyword arguments...)
+response = client.get_big_query_export request
 ```
 
 ## Debug Logging

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

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module Chronicle
-      VERSION = "0.3.0"
+      VERSION = "0.4.0"
     end
   end
 end

data/lib/google/cloud/chronicle.rb

@@ -45,6 +45,216 @@ end
 module Google
   module Cloud
     module Chronicle
+      ##
+      # Create a new client object for BigQueryExportService.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::Chronicle::V1::BigQueryExportService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-BigQueryExportService-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 BigQueryExportService 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 BigQueryExportService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Chronicle.big_query_export_service_available?}.
+      #
+      # ## About BigQueryExportService
+      #
+      # Service for managing BigQuery export configurations for Chronicle instances.
+      #
+      # @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.big_query_export_service version: :v1, transport: :grpc, &block
+        require "google/cloud/chronicle/#{version.to_s.downcase}"
+
+        package_name = Google::Cloud::Chronicle
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        service_module = Google::Cloud::Chronicle.const_get(package_name).const_get(:BigQueryExportService)
+        service_module = service_module.const_get(:Rest) if transport == :rest
+        service_module.const_get(:Client).new(&block)
+      end
+
+      ##
+      # Determines whether the BigQueryExportService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Chronicle.big_query_export_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 BigQueryExportService service,
+      # or if the versioned client gem needs an update to support the BigQueryExportService 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.big_query_export_service_available? version: :v1, transport: :grpc
+        require "google/cloud/chronicle/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Chronicle
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Chronicle.const_get package_name
+        return false unless service_module.const_defined? :BigQueryExportService
+        service_module = service_module.const_get :BigQueryExportService
+        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 DashboardQueryService.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::Chronicle::V1::DashboardQueryService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DashboardQueryService-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 DashboardQueryService 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 DashboardQueryService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Chronicle.dashboard_query_service_available?}.
+      #
+      # ## About DashboardQueryService
+      #
+      # A service providing functionality for managing dashboards' queries.
+      #
+      # @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.dashboard_query_service version: :v1, transport: :grpc, &block
+        require "google/cloud/chronicle/#{version.to_s.downcase}"
+
+        package_name = Google::Cloud::Chronicle
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        service_module = Google::Cloud::Chronicle.const_get(package_name).const_get(:DashboardQueryService)
+        service_module = service_module.const_get(:Rest) if transport == :rest
+        service_module.const_get(:Client).new(&block)
+      end
+
+      ##
+      # Determines whether the DashboardQueryService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Chronicle.dashboard_query_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 DashboardQueryService service,
+      # or if the versioned client gem needs an update to support the DashboardQueryService 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.dashboard_query_service_available? version: :v1, transport: :grpc
+        require "google/cloud/chronicle/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Chronicle
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Chronicle.const_get package_name
+        return false unless service_module.const_defined? :DashboardQueryService
+        service_module = service_module.const_get :DashboardQueryService
+        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 DashboardChartService.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::Chronicle::V1::DashboardChartService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DashboardChartService-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 DashboardChartService 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 DashboardChartService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Chronicle.dashboard_chart_service_available?}.
+      #
+      # ## About DashboardChartService
+      #
+      # A service providing functionality for managing dashboards' charts.
+      #
+      # @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.dashboard_chart_service version: :v1, transport: :grpc, &block
+        require "google/cloud/chronicle/#{version.to_s.downcase}"
+
+        package_name = Google::Cloud::Chronicle
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        service_module = Google::Cloud::Chronicle.const_get(package_name).const_get(:DashboardChartService)
+        service_module = service_module.const_get(:Rest) if transport == :rest
+        service_module.const_get(:Client).new(&block)
+      end
+
+      ##
+      # Determines whether the DashboardChartService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Chronicle.dashboard_chart_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 DashboardChartService service,
+      # or if the versioned client gem needs an update to support the DashboardChartService 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.dashboard_chart_service_available? version: :v1, transport: :grpc
+        require "google/cloud/chronicle/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Chronicle
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Chronicle.const_get package_name
+        return false unless service_module.const_defined? :DashboardChartService
+        service_module = service_module.const_get :DashboardChartService
+        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 DataAccessControlService.
       #
@@ -256,6 +466,147 @@ module Google
         false
       end
 
+      ##
+      # Create a new client object for NativeDashboardService.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::Chronicle::V1::NativeDashboardService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-NativeDashboardService-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 NativeDashboardService 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 NativeDashboardService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Chronicle.native_dashboard_service_available?}.
+      #
+      # ## About NativeDashboardService
+      #
+      # A service providing functionality for managing native dashboards.
+      #
+      # @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.native_dashboard_service version: :v1, transport: :grpc, &block
+        require "google/cloud/chronicle/#{version.to_s.downcase}"
+
+        package_name = Google::Cloud::Chronicle
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        service_module = Google::Cloud::Chronicle.const_get(package_name).const_get(:NativeDashboardService)
+        service_module = service_module.const_get(:Rest) if transport == :rest
+        service_module.const_get(:Client).new(&block)
+      end
+
+      ##
+      # Determines whether the NativeDashboardService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Chronicle.native_dashboard_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 NativeDashboardService service,
+      # or if the versioned client gem needs an update to support the NativeDashboardService 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.native_dashboard_service_available? version: :v1, transport: :grpc
+        require "google/cloud/chronicle/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Chronicle
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Chronicle.const_get package_name
+        return false unless service_module.const_defined? :NativeDashboardService
+        service_module = service_module.const_get :NativeDashboardService
+        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 FeaturedContentNativeDashboardService.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::Chronicle::V1::FeaturedContentNativeDashboardService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-FeaturedContentNativeDashboardService-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 FeaturedContentNativeDashboardService 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 FeaturedContentNativeDashboardService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Chronicle.featured_content_native_dashboard_service_available?}.
+      #
+      # ## About FeaturedContentNativeDashboardService
+      #
+      # This service provides functionality for managing
+      # FeaturedContentNativeDashboard.
+      #
+      # @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.featured_content_native_dashboard_service version: :v1, transport: :grpc, &block
+        require "google/cloud/chronicle/#{version.to_s.downcase}"
+
+        package_name = Google::Cloud::Chronicle
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        service_module = Google::Cloud::Chronicle.const_get(package_name).const_get(:FeaturedContentNativeDashboardService)
+        service_module = service_module.const_get(:Rest) if transport == :rest
+        service_module.const_get(:Client).new(&block)
+      end
+
+      ##
+      # Determines whether the FeaturedContentNativeDashboardService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Chronicle.featured_content_native_dashboard_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 FeaturedContentNativeDashboardService service,
+      # or if the versioned client gem needs an update to support the FeaturedContentNativeDashboardService 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.featured_content_native_dashboard_service_available? version: :v1, transport: :grpc
+        require "google/cloud/chronicle/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Chronicle
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Chronicle.const_get package_name
+        return false unless service_module.const_defined? :FeaturedContentNativeDashboardService
+        service_module = service_module.const_get :FeaturedContentNativeDashboardService
+        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 InstanceService.
       #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-chronicle
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Google LLC