google-cloud-chronicle 0.a → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 973c50711ad1ff1aef0acc45aa5d242b336aef4ab42725dc8393ed07020660c2
4
- data.tar.gz: d4b4aff1e109a1a385e7dc6be51875a0609bcfaed3374d4c28280a7b182fa15d
3
+ metadata.gz: 58c9688437cd1b69076bbe33fe35deafba9d5f10c0988db540f9139534f04047
4
+ data.tar.gz: cb48ffc30fcb8728165b37cd27e84e889e1cc6db6bb23e4fe76a0e5ca02befdb
5
5
  SHA512:
6
- metadata.gz: 283311fd5ff05ec149df7055ac35147eed5ae9264b98ad63d0c6428696bc0dbd1706eadbf5bbfe679f8fb0bca72948aca4184dce50658c635f1cd711bc28a6fd
7
- data.tar.gz: 8173e74e58e4320bc8115e622c6ad03f6611c18f139df587d830e97f79c4531c63ddd765ea9b66c5996f311bb140a34a3d9fefab00f5b9e509149847c22dece4
6
+ metadata.gz: 8eab69b2532d4b445534b9060ed8375b2541e4e53407b7cfebcfa2f852c664f718d3f6ea3fe58eefff0954437b4485d241c961c1f7d8f82239819354661821bc
7
+ data.tar.gz: 916678cd76f89d2a075a718718aefc476448232405aa5827d27b342f6d808667c1dbd47d35b0ed3f52c37516992cb00e7fe437f432a1ba354815b88edc59318a
data/.yardopts ADDED
@@ -0,0 +1,11 @@
1
+ --no-private
2
+ --title="Chronicle API"
3
+ --exclude _pb\.rb$
4
+ --markup markdown
5
+ --markup-provider redcarpet
6
+
7
+ ./lib/**/*.rb
8
+ -
9
+ README.md
10
+ AUTHENTICATION.md
11
+ LICENSE.md
data/AUTHENTICATION.md ADDED
@@ -0,0 +1,122 @@
1
+ # Authentication
2
+
3
+ The recommended way to authenticate to the google-cloud-chronicle library is to use
4
+ [Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
5
+ To review all of your authentication options, see [Credentials lookup](#credential-lookup).
6
+
7
+ ## Quickstart
8
+
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
11
+
12
+ **NOTE:** This method is _not_ recommended for running in production. User credentials
13
+ should be used only during development.
14
+
15
+ 1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
16
+ 2. Set up a local ADC file with your user credentials:
17
+
18
+ ```sh
19
+ gcloud auth application-default login
20
+ ```
21
+
22
+ 3. Write code as if already authenticated.
23
+
24
+ For more information about setting up authentication for a local development environment, see
25
+ [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
26
+
27
+ ## Credential Lookup
28
+
29
+ The google-cloud-chronicle library provides several mechanisms to configure your system.
30
+ Generally, using Application Default Credentials to facilitate automatic
31
+ credentials discovery is the easist method. But if you need to explicitly specify
32
+ credentials, there are several methods available to you.
33
+
34
+ Credentials are accepted in the following ways, in the following order or precedence:
35
+
36
+ 1. Credentials specified in method arguments
37
+ 2. Credentials specified in configuration
38
+ 3. Credentials pointed to or included in environment variables
39
+ 4. Credentials found in local ADC file
40
+ 5. Credentials returned by the metadata server for the attached service account (GCP)
41
+
42
+ ### Configuration
43
+
44
+ You can configure a path to a JSON credentials file, either for an individual client object or
45
+ globally, for all client objects. The JSON file can contain credentials created for
46
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
47
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
48
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
49
+
50
+ Note: Service account keys are a security risk if not managed correctly. You should
51
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
52
+ whenever possible.
53
+
54
+ To configure a credentials file for an individual client initialization:
55
+
56
+ ```ruby
57
+ require "google/cloud/chronicle"
58
+
59
+ client = Google::Cloud::Chronicle.data_access_control_service do |config|
60
+ config.credentials = "path/to/credentialfile.json"
61
+ end
62
+ ```
63
+
64
+ To configure a credentials file globally for all clients:
65
+
66
+ ```ruby
67
+ require "google/cloud/chronicle"
68
+
69
+ Google::Cloud::Chronicle.configure do |config|
70
+ config.credentials = "path/to/credentialfile.json"
71
+ end
72
+
73
+ client = Google::Cloud::Chronicle.data_access_control_service
74
+ ```
75
+
76
+ ### Environment Variables
77
+
78
+ You can also use an environment variable to provide a JSON credentials file.
79
+ The environment variable can contain a path to the credentials file or, for
80
+ environments such as Docker containers where writing files is not encouraged,
81
+ you can include the credentials file itself.
82
+
83
+ The JSON file can contain credentials created for
84
+ [workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
85
+ [workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
86
+ [service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
87
+
88
+ Note: Service account keys are a security risk if not managed correctly. You should
89
+ [choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
90
+ whenever possible.
91
+
92
+ The environment variables that google-cloud-chronicle
93
+ checks for credentials are:
94
+
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
97
+
98
+ ```ruby
99
+ require "google/cloud/chronicle"
100
+
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
102
+
103
+ client = Google::Cloud::Chronicle.data_access_control_service
104
+ ```
105
+
106
+ ### Local ADC file
107
+
108
+ You can set up a local ADC file with your user credentials for authentication during
109
+ development. If credentials are not provided in code or in environment variables,
110
+ then the local ADC credentials are discovered.
111
+
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
113
+
114
+ ### Google Cloud Platform environments
115
+
116
+ When running on Google Cloud Platform (GCP), including Google Compute Engine
117
+ (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
118
+ Functions (GCF) and Cloud Run, credentials are retrieved from the attached
119
+ service account automatically. Code should be written as if already authenticated.
120
+
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
data/README.md CHANGED
@@ -1,8 +1,134 @@
1
- # Placeholder for Ruby gem google-cloud-chronicle
2
-
3
- This is a placeholder for the future Google-authored gem google-cloud-chronicle.
4
- This placeholder is being released on 2025-05-15 in order to reserve the name.
5
- The final gem should be available shortly after that date. If it has not been
6
- released in a timely manner, or if this placeholder interferes with your work,
7
- you can contact the Google Ruby team by opening an issue in the GitHub
8
- repository https://github.com/googleapis/google-cloud-ruby.
1
+ # Ruby Client for the Chronicle API
2
+
3
+ The Google Cloud Security Operations API, popularly known as the Chronicle API, serves endpoints that enable security analysts to analyze and mitigate a security threat throughout its lifecycle.
4
+
5
+ The Google Cloud Security Operations API, popularly known as the Chronicle API, serves endpoints that enable security analysts to analyze and mitigate a security threat throughout its lifecycle.
6
+
7
+ Actual client classes for the various versions of this API are defined in
8
+ _versioned_ client gems, with names of the form `google-cloud-chronicle-v*`.
9
+ The gem `google-cloud-chronicle` is the main client library that brings the
10
+ versioned gems in as dependencies, and provides high-level methods for
11
+ constructing clients. More information on versioned clients can be found below
12
+ in the section titled *Which client should I use?*.
13
+
14
+ View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-chronicle/latest)
15
+ for this library, google-cloud-chronicle, to see the convenience methods for
16
+ constructing client objects. Reference documentation for the client objects
17
+ themselves can be found in the client library documentation for the versioned
18
+ client gems:
19
+ [google-cloud-chronicle-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest).
20
+
21
+ See also the [Product Documentation](https://cloud.google.com/chronicle/docs/secops/secops-overview)
22
+ for more usage information.
23
+
24
+ ## Quick Start
25
+
26
+ ```
27
+ $ gem install google-cloud-chronicle
28
+ ```
29
+
30
+ In order to use this library, you first need to go through the following steps:
31
+
32
+ 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
33
+ 1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
34
+ 1. [Enable the API.](https://console.cloud.google.com/apis/library/chronicle.googleapis.com)
35
+ 1. {file:AUTHENTICATION.md Set up authentication.}
36
+
37
+ ## Debug Logging
38
+
39
+ This library comes with opt-in Debug Logging that can help you troubleshoot
40
+ your application's integration with the API. When logging is activated, key
41
+ events such as requests and responses, along with data payloads and metadata
42
+ such as headers and client configuration, are logged to the standard error
43
+ stream.
44
+
45
+ **WARNING:** Client Library Debug Logging includes your data payloads in
46
+ plaintext, which could include sensitive data such as PII for yourself or your
47
+ customers, private keys, or other security data that could be compromising if
48
+ leaked. Always practice good data hygiene with your application logs, and follow
49
+ the principle of least access. Google also recommends that Client Library Debug
50
+ Logging be enabled only temporarily during active debugging, and not used
51
+ permanently in production.
52
+
53
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
54
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
55
+ list of client library gem names. This will select the default logging behavior,
56
+ which writes logs to the standard error stream. On a local workstation, this may
57
+ result in logs appearing on the console. When running on a Google Cloud hosting
58
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
59
+ results in logs appearing alongside your application logs in the
60
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
61
+
62
+ Debug logging also requires that the versioned clients for this service be
63
+ sufficiently recent, released after about Dec 10, 2024. If logging is not
64
+ working, try updating the versioned clients in your bundle or installed gems:
65
+ [google-cloud-chronicle-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest).
66
+
67
+ ## Supported Ruby Versions
68
+
69
+ This library is supported on Ruby 3.0+.
70
+
71
+ Google provides official support for Ruby versions that are actively supported
72
+ by Ruby Core—that is, Ruby versions that are either in normal maintenance or
73
+ in security maintenance, and not end of life. Older versions of Ruby _may_
74
+ still work, but are unsupported and not recommended. See
75
+ https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
76
+ support schedule.
77
+
78
+ ## Which client should I use?
79
+
80
+ Most modern Ruby client libraries for Google APIs come in two flavors: the main
81
+ client library with a name such as `google-cloud-chronicle`,
82
+ and lower-level _versioned_ client libraries with names such as
83
+ `google-cloud-chronicle-v1`.
84
+ _In most cases, you should install the main client._
85
+
86
+ ### What's the difference between the main client and a versioned client?
87
+
88
+ A _versioned client_ provides a basic set of data types and client classes for
89
+ a _single version_ of a specific service. (That is, for a service with multiple
90
+ versions, there might be a separate versioned client for each service version.)
91
+ Most versioned clients are written and maintained by a code generator.
92
+
93
+ The _main client_ is designed to provide you with the _recommended_ client
94
+ interfaces for the service. There will be only one main client for any given
95
+ service, even a service with multiple versions. The main client includes
96
+ factory methods for constructing the client objects we recommend for most
97
+ users. In some cases, those will be classes provided by an underlying versioned
98
+ client; in other cases, they will be handwritten higher-level client objects
99
+ with additional capabilities, convenience methods, or best practices built in.
100
+ Generally, the main client will default to a recommended service version,
101
+ although in some cases you can override this if you need to talk to a specific
102
+ service version.
103
+
104
+ ### Why would I want to use the main client?
105
+
106
+ We recommend that most users install the main client gem for a service. You can
107
+ identify this gem as the one _without_ a version in its name, e.g.
108
+ `google-cloud-chronicle`.
109
+ The main client is recommended because it will embody the best practices for
110
+ accessing the service, and may also provide more convenient interfaces or
111
+ tighter integration into frameworks and third-party libraries. In addition, the
112
+ documentation and samples published by Google will generally demonstrate use of
113
+ the main client.
114
+
115
+ ### Why would I want to use a versioned client?
116
+
117
+ You can use a versioned client if you are content with a possibly lower-level
118
+ class interface, you explicitly want to avoid features provided by the main
119
+ client, or you want to access a specific service version not be covered by the
120
+ main client. You can identify versioned client gems because the service version
121
+ is part of the name, e.g. `google-cloud-chronicle-v1`.
122
+
123
+ ### What about the google-apis-<name> clients?
124
+
125
+ Client library gems with names that begin with `google-apis-` are based on an
126
+ older code generation technology. They talk to a REST/JSON backend (whereas
127
+ most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
128
+ not offer the same performance, features, and ease of use provided by more
129
+ modern clients.
130
+
131
+ The `google-apis-` clients have wide coverage across Google services, so you
132
+ might need to use one if there is no modern client available for the service.
133
+ However, if a modern client is available, we generally recommend it over the
134
+ older `google-apis-` clients.
@@ -1,10 +1,12 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # Copyright 2025 Google LLC
2
4
  #
3
5
  # Licensed under the Apache License, Version 2.0 (the "License");
4
6
  # you may not use this file except in compliance with the License.
5
7
  # You may obtain a copy of the License at
6
8
  #
7
- # http://www.apache.org/licenses/LICENSE-2.0
9
+ # https://www.apache.org/licenses/LICENSE-2.0
8
10
  #
9
11
  # Unless required by applicable law or agreed to in writing, software
10
12
  # distributed under the License is distributed on an "AS IS" BASIS,
@@ -12,10 +14,13 @@
12
14
  # See the License for the specific language governing permissions and
13
15
  # limitations under the License.
14
16
 
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
15
20
  module Google
16
21
  module Cloud
17
22
  module Chronicle
18
- VERSION = "0.a"
23
+ VERSION = "0.1.0"
19
24
  end
20
25
  end
21
26
  end
@@ -0,0 +1,437 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ # Require this file early so that the version constant gets defined before
20
+ # requiring "google/cloud". This is because google-cloud-core will load the
21
+ # entrypoint (gem name) file, which in turn re-requires this file (hence
22
+ # causing a require cycle) unless the version constant is already defined.
23
+ require "google/cloud/chronicle/version"
24
+
25
+ require "googleauth"
26
+ gem "google-cloud-core"
27
+ require "google/cloud" unless defined? ::Google::Cloud.new
28
+ require "google/cloud/config"
29
+
30
+ # Set the default configuration
31
+ ::Google::Cloud.configure.add_config! :chronicle do |config|
32
+ config.add_field! :endpoint, nil, match: ::String
33
+ config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
34
+ config.add_field! :scope, nil, match: [::Array, ::String]
35
+ config.add_field! :lib_name, nil, match: ::String
36
+ config.add_field! :lib_version, nil, match: ::String
37
+ config.add_field! :interceptors, nil, match: ::Array
38
+ config.add_field! :timeout, nil, match: ::Numeric
39
+ config.add_field! :metadata, nil, match: ::Hash
40
+ config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
41
+ config.add_field! :quota_project, nil, match: ::String
42
+ config.add_field! :universe_domain, nil, match: ::String
43
+ end
44
+
45
+ module Google
46
+ module Cloud
47
+ module Chronicle
48
+ ##
49
+ # Create a new client object for DataAccessControlService.
50
+ #
51
+ # By default, this returns an instance of
52
+ # [Google::Cloud::Chronicle::V1::DataAccessControlService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-DataAccessControlService-Client)
53
+ # for a gRPC client for version V1 of the API.
54
+ # However, you can specify a different API version by passing it in the
55
+ # `version` parameter. If the DataAccessControlService service is
56
+ # supported by that API version, and the corresponding gem is available, the
57
+ # appropriate versioned client will be returned.
58
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
59
+ # the `transport` parameter.
60
+ #
61
+ # Raises an exception if the currently installed versioned client gem for the
62
+ # given API version does not support the given transport of the DataAccessControlService service.
63
+ # You can determine whether the method will succeed by calling
64
+ # {Google::Cloud::Chronicle.data_access_control_service_available?}.
65
+ #
66
+ # ## About DataAccessControlService
67
+ #
68
+ # DataAccessControlService exposes resources and endpoints related to data
69
+ # access control.
70
+ #
71
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
72
+ # Defaults to `:v1`.
73
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
74
+ # @return [::Object] A client object for the specified version.
75
+ #
76
+ def self.data_access_control_service version: :v1, transport: :grpc, &block
77
+ require "google/cloud/chronicle/#{version.to_s.downcase}"
78
+
79
+ package_name = Google::Cloud::Chronicle
80
+ .constants
81
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
82
+ .first
83
+ service_module = Google::Cloud::Chronicle.const_get(package_name).const_get(:DataAccessControlService)
84
+ service_module = service_module.const_get(:Rest) if transport == :rest
85
+ service_module.const_get(:Client).new(&block)
86
+ end
87
+
88
+ ##
89
+ # Determines whether the DataAccessControlService service is supported by the current client.
90
+ # If true, you can retrieve a client object by calling {Google::Cloud::Chronicle.data_access_control_service}.
91
+ # If false, that method will raise an exception. This could happen if the given
92
+ # API version does not exist or does not support the DataAccessControlService service,
93
+ # or if the versioned client gem needs an update to support the DataAccessControlService service.
94
+ #
95
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
96
+ # Defaults to `:v1`.
97
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
98
+ # @return [boolean] Whether the service is available.
99
+ #
100
+ def self.data_access_control_service_available? version: :v1, transport: :grpc
101
+ require "google/cloud/chronicle/#{version.to_s.downcase}"
102
+ package_name = Google::Cloud::Chronicle
103
+ .constants
104
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
105
+ .first
106
+ return false unless package_name
107
+ service_module = Google::Cloud::Chronicle.const_get package_name
108
+ return false unless service_module.const_defined? :DataAccessControlService
109
+ service_module = service_module.const_get :DataAccessControlService
110
+ if transport == :rest
111
+ return false unless service_module.const_defined? :Rest
112
+ service_module = service_module.const_get :Rest
113
+ end
114
+ service_module.const_defined? :Client
115
+ rescue ::LoadError
116
+ false
117
+ end
118
+
119
+ ##
120
+ # Create a new client object for EntityService.
121
+ #
122
+ # By default, this returns an instance of
123
+ # [Google::Cloud::Chronicle::V1::EntityService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-EntityService-Client)
124
+ # for a gRPC client for version V1 of the API.
125
+ # However, you can specify a different API version by passing it in the
126
+ # `version` parameter. If the EntityService service is
127
+ # supported by that API version, and the corresponding gem is available, the
128
+ # appropriate versioned client will be returned.
129
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
130
+ # the `transport` parameter.
131
+ #
132
+ # Raises an exception if the currently installed versioned client gem for the
133
+ # given API version does not support the given transport of the EntityService service.
134
+ # You can determine whether the method will succeed by calling
135
+ # {Google::Cloud::Chronicle.entity_service_available?}.
136
+ #
137
+ # ## About EntityService
138
+ #
139
+ # EntityService contains apis for finding entities.
140
+ #
141
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
142
+ # Defaults to `:v1`.
143
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
144
+ # @return [::Object] A client object for the specified version.
145
+ #
146
+ def self.entity_service version: :v1, transport: :grpc, &block
147
+ require "google/cloud/chronicle/#{version.to_s.downcase}"
148
+
149
+ package_name = Google::Cloud::Chronicle
150
+ .constants
151
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
152
+ .first
153
+ service_module = Google::Cloud::Chronicle.const_get(package_name).const_get(:EntityService)
154
+ service_module = service_module.const_get(:Rest) if transport == :rest
155
+ service_module.const_get(:Client).new(&block)
156
+ end
157
+
158
+ ##
159
+ # Determines whether the EntityService service is supported by the current client.
160
+ # If true, you can retrieve a client object by calling {Google::Cloud::Chronicle.entity_service}.
161
+ # If false, that method will raise an exception. This could happen if the given
162
+ # API version does not exist or does not support the EntityService service,
163
+ # or if the versioned client gem needs an update to support the EntityService service.
164
+ #
165
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
166
+ # Defaults to `:v1`.
167
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
168
+ # @return [boolean] Whether the service is available.
169
+ #
170
+ def self.entity_service_available? version: :v1, transport: :grpc
171
+ require "google/cloud/chronicle/#{version.to_s.downcase}"
172
+ package_name = Google::Cloud::Chronicle
173
+ .constants
174
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
175
+ .first
176
+ return false unless package_name
177
+ service_module = Google::Cloud::Chronicle.const_get package_name
178
+ return false unless service_module.const_defined? :EntityService
179
+ service_module = service_module.const_get :EntityService
180
+ if transport == :rest
181
+ return false unless service_module.const_defined? :Rest
182
+ service_module = service_module.const_get :Rest
183
+ end
184
+ service_module.const_defined? :Client
185
+ rescue ::LoadError
186
+ false
187
+ end
188
+
189
+ ##
190
+ # Create a new client object for InstanceService.
191
+ #
192
+ # By default, this returns an instance of
193
+ # [Google::Cloud::Chronicle::V1::InstanceService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-InstanceService-Client)
194
+ # for a gRPC client for version V1 of the API.
195
+ # However, you can specify a different API version by passing it in the
196
+ # `version` parameter. If the InstanceService service is
197
+ # supported by that API version, and the corresponding gem is available, the
198
+ # appropriate versioned client will be returned.
199
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
200
+ # the `transport` parameter.
201
+ #
202
+ # Raises an exception if the currently installed versioned client gem for the
203
+ # given API version does not support the given transport of the InstanceService service.
204
+ # You can determine whether the method will succeed by calling
205
+ # {Google::Cloud::Chronicle.instance_service_available?}.
206
+ #
207
+ # ## About InstanceService
208
+ #
209
+ # InstanceService provides the entry interface for the Chronicle API.
210
+ #
211
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
212
+ # Defaults to `:v1`.
213
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
214
+ # @return [::Object] A client object for the specified version.
215
+ #
216
+ def self.instance_service version: :v1, transport: :grpc, &block
217
+ require "google/cloud/chronicle/#{version.to_s.downcase}"
218
+
219
+ package_name = Google::Cloud::Chronicle
220
+ .constants
221
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
222
+ .first
223
+ service_module = Google::Cloud::Chronicle.const_get(package_name).const_get(:InstanceService)
224
+ service_module = service_module.const_get(:Rest) if transport == :rest
225
+ service_module.const_get(:Client).new(&block)
226
+ end
227
+
228
+ ##
229
+ # Determines whether the InstanceService service is supported by the current client.
230
+ # If true, you can retrieve a client object by calling {Google::Cloud::Chronicle.instance_service}.
231
+ # If false, that method will raise an exception. This could happen if the given
232
+ # API version does not exist or does not support the InstanceService service,
233
+ # or if the versioned client gem needs an update to support the InstanceService service.
234
+ #
235
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
236
+ # Defaults to `:v1`.
237
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
238
+ # @return [boolean] Whether the service is available.
239
+ #
240
+ def self.instance_service_available? version: :v1, transport: :grpc
241
+ require "google/cloud/chronicle/#{version.to_s.downcase}"
242
+ package_name = Google::Cloud::Chronicle
243
+ .constants
244
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
245
+ .first
246
+ return false unless package_name
247
+ service_module = Google::Cloud::Chronicle.const_get package_name
248
+ return false unless service_module.const_defined? :InstanceService
249
+ service_module = service_module.const_get :InstanceService
250
+ if transport == :rest
251
+ return false unless service_module.const_defined? :Rest
252
+ service_module = service_module.const_get :Rest
253
+ end
254
+ service_module.const_defined? :Client
255
+ rescue ::LoadError
256
+ false
257
+ end
258
+
259
+ ##
260
+ # Create a new client object for ReferenceListService.
261
+ #
262
+ # By default, this returns an instance of
263
+ # [Google::Cloud::Chronicle::V1::ReferenceListService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-ReferenceListService-Client)
264
+ # for a gRPC client for version V1 of the API.
265
+ # However, you can specify a different API version by passing it in the
266
+ # `version` parameter. If the ReferenceListService service is
267
+ # supported by that API version, and the corresponding gem is available, the
268
+ # appropriate versioned client will be returned.
269
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
270
+ # the `transport` parameter.
271
+ #
272
+ # Raises an exception if the currently installed versioned client gem for the
273
+ # given API version does not support the given transport of the ReferenceListService service.
274
+ # You can determine whether the method will succeed by calling
275
+ # {Google::Cloud::Chronicle.reference_list_service_available?}.
276
+ #
277
+ # ## About ReferenceListService
278
+ #
279
+ # ReferenceListService provides an interface for managing reference lists.
280
+ #
281
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
282
+ # Defaults to `:v1`.
283
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
284
+ # @return [::Object] A client object for the specified version.
285
+ #
286
+ def self.reference_list_service version: :v1, transport: :grpc, &block
287
+ require "google/cloud/chronicle/#{version.to_s.downcase}"
288
+
289
+ package_name = Google::Cloud::Chronicle
290
+ .constants
291
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
292
+ .first
293
+ service_module = Google::Cloud::Chronicle.const_get(package_name).const_get(:ReferenceListService)
294
+ service_module = service_module.const_get(:Rest) if transport == :rest
295
+ service_module.const_get(:Client).new(&block)
296
+ end
297
+
298
+ ##
299
+ # Determines whether the ReferenceListService service is supported by the current client.
300
+ # If true, you can retrieve a client object by calling {Google::Cloud::Chronicle.reference_list_service}.
301
+ # If false, that method will raise an exception. This could happen if the given
302
+ # API version does not exist or does not support the ReferenceListService service,
303
+ # or if the versioned client gem needs an update to support the ReferenceListService service.
304
+ #
305
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
306
+ # Defaults to `:v1`.
307
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
308
+ # @return [boolean] Whether the service is available.
309
+ #
310
+ def self.reference_list_service_available? version: :v1, transport: :grpc
311
+ require "google/cloud/chronicle/#{version.to_s.downcase}"
312
+ package_name = Google::Cloud::Chronicle
313
+ .constants
314
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
315
+ .first
316
+ return false unless package_name
317
+ service_module = Google::Cloud::Chronicle.const_get package_name
318
+ return false unless service_module.const_defined? :ReferenceListService
319
+ service_module = service_module.const_get :ReferenceListService
320
+ if transport == :rest
321
+ return false unless service_module.const_defined? :Rest
322
+ service_module = service_module.const_get :Rest
323
+ end
324
+ service_module.const_defined? :Client
325
+ rescue ::LoadError
326
+ false
327
+ end
328
+
329
+ ##
330
+ # Create a new client object for RuleService.
331
+ #
332
+ # By default, this returns an instance of
333
+ # [Google::Cloud::Chronicle::V1::RuleService::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest/Google-Cloud-Chronicle-V1-RuleService-Client)
334
+ # for a gRPC client for version V1 of the API.
335
+ # However, you can specify a different API version by passing it in the
336
+ # `version` parameter. If the RuleService service is
337
+ # supported by that API version, and the corresponding gem is available, the
338
+ # appropriate versioned client will be returned.
339
+ # You can also specify a different transport by passing `:rest` or `:grpc` in
340
+ # the `transport` parameter.
341
+ #
342
+ # Raises an exception if the currently installed versioned client gem for the
343
+ # given API version does not support the given transport of the RuleService service.
344
+ # You can determine whether the method will succeed by calling
345
+ # {Google::Cloud::Chronicle.rule_service_available?}.
346
+ #
347
+ # ## About RuleService
348
+ #
349
+ # RuleService provides interface for user-created rules.
350
+ #
351
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
352
+ # Defaults to `:v1`.
353
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
354
+ # @return [::Object] A client object for the specified version.
355
+ #
356
+ def self.rule_service version: :v1, transport: :grpc, &block
357
+ require "google/cloud/chronicle/#{version.to_s.downcase}"
358
+
359
+ package_name = Google::Cloud::Chronicle
360
+ .constants
361
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
362
+ .first
363
+ service_module = Google::Cloud::Chronicle.const_get(package_name).const_get(:RuleService)
364
+ service_module = service_module.const_get(:Rest) if transport == :rest
365
+ service_module.const_get(:Client).new(&block)
366
+ end
367
+
368
+ ##
369
+ # Determines whether the RuleService service is supported by the current client.
370
+ # If true, you can retrieve a client object by calling {Google::Cloud::Chronicle.rule_service}.
371
+ # If false, that method will raise an exception. This could happen if the given
372
+ # API version does not exist or does not support the RuleService service,
373
+ # or if the versioned client gem needs an update to support the RuleService service.
374
+ #
375
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
376
+ # Defaults to `:v1`.
377
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
378
+ # @return [boolean] Whether the service is available.
379
+ #
380
+ def self.rule_service_available? version: :v1, transport: :grpc
381
+ require "google/cloud/chronicle/#{version.to_s.downcase}"
382
+ package_name = Google::Cloud::Chronicle
383
+ .constants
384
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
385
+ .first
386
+ return false unless package_name
387
+ service_module = Google::Cloud::Chronicle.const_get package_name
388
+ return false unless service_module.const_defined? :RuleService
389
+ service_module = service_module.const_get :RuleService
390
+ if transport == :rest
391
+ return false unless service_module.const_defined? :Rest
392
+ service_module = service_module.const_get :Rest
393
+ end
394
+ service_module.const_defined? :Client
395
+ rescue ::LoadError
396
+ false
397
+ end
398
+
399
+ ##
400
+ # Configure the google-cloud-chronicle library.
401
+ #
402
+ # The following configuration parameters are supported:
403
+ #
404
+ # * `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) -
405
+ # The path to the keyfile as a String, the contents of the keyfile as a
406
+ # Hash, or a Google::Auth::Credentials object.
407
+ # * `lib_name` (*type:* `String`) -
408
+ # The library name as recorded in instrumentation and logging.
409
+ # * `lib_version` (*type:* `String`) -
410
+ # The library version as recorded in instrumentation and logging.
411
+ # * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
412
+ # An array of interceptors that are run before calls are executed.
413
+ # * `timeout` (*type:* `Numeric`) -
414
+ # Default timeout in seconds.
415
+ # * `metadata` (*type:* `Hash{Symbol=>String}`) -
416
+ # Additional headers to be sent with the call.
417
+ # * `retry_policy` (*type:* `Hash`) -
418
+ # The retry policy. The value is a hash with the following keys:
419
+ # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
420
+ # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
421
+ # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
422
+ # * `:retry_codes` (*type:* `Array<String>`) -
423
+ # The error codes that should trigger a retry.
424
+ #
425
+ # @return [::Google::Cloud::Config] The default configuration used by this library
426
+ #
427
+ def self.configure
428
+ yield ::Google::Cloud.configure.chronicle if block_given?
429
+
430
+ ::Google::Cloud.configure.chronicle
431
+ end
432
+ end
433
+ end
434
+ end
435
+
436
+ helper_path = ::File.join __dir__, "chronicle", "helpers.rb"
437
+ require "google/cloud/chronicle/helpers" if ::File.file? helper_path
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2025 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+ require "google/cloud/chronicle" unless defined? Google::Cloud::Chronicle::VERSION
metadata CHANGED
@@ -1,26 +1,62 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-chronicle
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.a
4
+ version: 0.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  bindir: bin
9
9
  cert_chain: []
10
10
  date: 1980-01-02 00:00:00.000000000 Z
11
- dependencies: []
12
- description: Placeholder for the future Google-authored gem google-cloud-chronicle.
13
- This placeholder is being released on 2025-05-15 in order to reserve the name. The
14
- final gem should be available shortly after that date. If it has not been released
15
- in a timely manner, or if this placeholder interferes with your work, you can contact
16
- the Google Ruby team by opening an issue in the GitHub repository https://github.com/googleapis/google-cloud-ruby.
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: google-cloud-chronicle-v1
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - ">="
17
+ - !ruby/object:Gem::Version
18
+ version: '0.0'
19
+ - - "<"
20
+ - !ruby/object:Gem::Version
21
+ version: 2.a
22
+ type: :runtime
23
+ prerelease: false
24
+ version_requirements: !ruby/object:Gem::Requirement
25
+ requirements:
26
+ - - ">="
27
+ - !ruby/object:Gem::Version
28
+ version: '0.0'
29
+ - - "<"
30
+ - !ruby/object:Gem::Version
31
+ version: 2.a
32
+ - !ruby/object:Gem::Dependency
33
+ name: google-cloud-core
34
+ requirement: !ruby/object:Gem::Requirement
35
+ requirements:
36
+ - - "~>"
37
+ - !ruby/object:Gem::Version
38
+ version: '1.6'
39
+ type: :runtime
40
+ prerelease: false
41
+ version_requirements: !ruby/object:Gem::Requirement
42
+ requirements:
43
+ - - "~>"
44
+ - !ruby/object:Gem::Version
45
+ version: '1.6'
46
+ description: The Google Cloud Security Operations API, popularly known as the Chronicle
47
+ API, serves endpoints that enable security analysts to analyze and mitigate a security
48
+ threat throughout its lifecycle.
17
49
  email: googleapis-packages@google.com
18
50
  executables: []
19
51
  extensions: []
20
52
  extra_rdoc_files: []
21
53
  files:
54
+ - ".yardopts"
55
+ - AUTHENTICATION.md
22
56
  - LICENSE.md
23
57
  - README.md
58
+ - lib/google-cloud-chronicle.rb
59
+ - lib/google/cloud/chronicle.rb
24
60
  - lib/google/cloud/chronicle/version.rb
25
61
  homepage: https://github.com/googleapis/google-cloud-ruby
26
62
  licenses:
@@ -40,7 +76,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
40
76
  - !ruby/object:Gem::Version
41
77
  version: '0'
42
78
  requirements: []
43
- rubygems_version: 3.6.8
79
+ rubygems_version: 3.6.9
44
80
  specification_version: 4
45
- summary: Placeholder for the future Google-authored gem google-cloud-chronicle
81
+ summary: The Google Cloud Security Operations API, popularly known as the Chronicle
82
+ API, serves endpoints that enable security analysts to analyze and mitigate a security
83
+ threat throughout its lifecycle.
46
84
  test_files: []