Skip to content

Commit ec5769d

Browse files
yoshi-code-botyoshi-code-bot
authored
feat: Initial generation of google-cloud-chronicle-v1 (#30407)
1 parent 85f10b2 commit ec5769d

137 files changed

Lines changed: 29044 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.release-please-manifest.json‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,8 @@
193193
"google-cloud-channel+FILLER": "0.0.0",
194194
"google-cloud-channel-v1": "2.1.0",
195195
"google-cloud-channel-v1+FILLER": "0.0.0",
196+
"google-cloud-chronicle-v1": "0.0.1",
197+
"google-cloud-chronicle-v1+FILLER": "0.0.0",
196198
"google-cloud-cloud_controls_partner": "2.0.1",
197199
"google-cloud-cloud_controls_partner+FILLER": "0.0.0",
198200
"google-cloud-cloud_controls_partner-v1": "2.1.0",

‎google-cloud-chronicle-v1/.OwlBot.yaml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
deep-copy-regex:
2+
- source: /google/cloud/chronicle/v1/[^/]+-ruby/(.*)
3+
dest: /owl-bot-staging/google-cloud-chronicle-v1/$1

‎google-cloud-chronicle-v1/.gitignore‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Ignore bundler lockfiles
2+
Gemfile.lock
3+
gems.locked
4+
5+
# Ignore documentation output
6+
doc/*
7+
.yardoc/*
8+
9+
# Ignore test output
10+
coverage/*
11+
12+
# Ignore build artifacts
13+
pkg/*
14+
15+
# Ignore files commonly present in certain dev environments
16+
.vagrant
17+
.DS_STORE
18+
.idea
19+
*.iml
20+
21+
# Ignore synth output
22+
__pycache__

‎google-cloud-chronicle-v1/.owlbot-manifest.json‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
{
2+
"generated": [
3+
".gitignore",
4+
".repo-metadata.json",
5+
".rubocop.yml",
6+
".toys.rb",
7+
".yardopts",
8+
"AUTHENTICATION.md",
9+
"CHANGELOG.md",
10+
"Gemfile",
11+
"LICENSE.md",
12+
"README.md",
13+
"Rakefile",
14+
"gapic_metadata.json",
15+
"google-cloud-chronicle-v1.gemspec",
16+
"lib/google-cloud-chronicle-v1.rb",
17+
"lib/google/cloud/chronicle/v1.rb",
18+
"lib/google/cloud/chronicle/v1/data_access_control_pb.rb",
19+
"lib/google/cloud/chronicle/v1/data_access_control_service.rb",
20+
"lib/google/cloud/chronicle/v1/data_access_control_service/client.rb",
21+
"lib/google/cloud/chronicle/v1/data_access_control_service/credentials.rb",
22+
"lib/google/cloud/chronicle/v1/data_access_control_service/paths.rb",
23+
"lib/google/cloud/chronicle/v1/data_access_control_service/rest.rb",
24+
"lib/google/cloud/chronicle/v1/data_access_control_service/rest/client.rb",
25+
"lib/google/cloud/chronicle/v1/data_access_control_service/rest/service_stub.rb",
26+
"lib/google/cloud/chronicle/v1/data_access_control_services_pb.rb",
27+
"lib/google/cloud/chronicle/v1/entity_pb.rb",
28+
"lib/google/cloud/chronicle/v1/entity_service.rb",
29+
"lib/google/cloud/chronicle/v1/entity_service/client.rb",
30+
"lib/google/cloud/chronicle/v1/entity_service/credentials.rb",
31+
"lib/google/cloud/chronicle/v1/entity_service/paths.rb",
32+
"lib/google/cloud/chronicle/v1/entity_service/rest.rb",
33+
"lib/google/cloud/chronicle/v1/entity_service/rest/client.rb",
34+
"lib/google/cloud/chronicle/v1/entity_service/rest/service_stub.rb",
35+
"lib/google/cloud/chronicle/v1/entity_services_pb.rb",
36+
"lib/google/cloud/chronicle/v1/instance_pb.rb",
37+
"lib/google/cloud/chronicle/v1/instance_service.rb",
38+
"lib/google/cloud/chronicle/v1/instance_service/client.rb",
39+
"lib/google/cloud/chronicle/v1/instance_service/credentials.rb",
40+
"lib/google/cloud/chronicle/v1/instance_service/paths.rb",
41+
"lib/google/cloud/chronicle/v1/instance_service/rest.rb",
42+
"lib/google/cloud/chronicle/v1/instance_service/rest/client.rb",
43+
"lib/google/cloud/chronicle/v1/instance_service/rest/service_stub.rb",
44+
"lib/google/cloud/chronicle/v1/instance_services_pb.rb",
45+
"lib/google/cloud/chronicle/v1/reference_list_pb.rb",
46+
"lib/google/cloud/chronicle/v1/reference_list_service.rb",
47+
"lib/google/cloud/chronicle/v1/reference_list_service/client.rb",
48+
"lib/google/cloud/chronicle/v1/reference_list_service/credentials.rb",
49+
"lib/google/cloud/chronicle/v1/reference_list_service/paths.rb",
50+
"lib/google/cloud/chronicle/v1/reference_list_service/rest.rb",
51+
"lib/google/cloud/chronicle/v1/reference_list_service/rest/client.rb",
52+
"lib/google/cloud/chronicle/v1/reference_list_service/rest/service_stub.rb",
53+
"lib/google/cloud/chronicle/v1/reference_list_services_pb.rb",
54+
"lib/google/cloud/chronicle/v1/rest.rb",
55+
"lib/google/cloud/chronicle/v1/rule_pb.rb",
56+
"lib/google/cloud/chronicle/v1/rule_service.rb",
57+
"lib/google/cloud/chronicle/v1/rule_service/client.rb",
58+
"lib/google/cloud/chronicle/v1/rule_service/credentials.rb",
59+
"lib/google/cloud/chronicle/v1/rule_service/operations.rb",
60+
"lib/google/cloud/chronicle/v1/rule_service/paths.rb",
61+
"lib/google/cloud/chronicle/v1/rule_service/rest.rb",
62+
"lib/google/cloud/chronicle/v1/rule_service/rest/client.rb",
63+
"lib/google/cloud/chronicle/v1/rule_service/rest/operations.rb",
64+
"lib/google/cloud/chronicle/v1/rule_service/rest/service_stub.rb",
65+
"lib/google/cloud/chronicle/v1/rule_services_pb.rb",
66+
"lib/google/cloud/chronicle/v1/version.rb",
67+
"proto_docs/README.md",
68+
"proto_docs/google/api/client.rb",
69+
"proto_docs/google/api/field_behavior.rb",
70+
"proto_docs/google/api/launch_stage.rb",
71+
"proto_docs/google/api/resource.rb",
72+
"proto_docs/google/cloud/chronicle/v1/data_access_control.rb",
73+
"proto_docs/google/cloud/chronicle/v1/entity.rb",
74+
"proto_docs/google/cloud/chronicle/v1/instance.rb",
75+
"proto_docs/google/cloud/chronicle/v1/reference_list.rb",
76+
"proto_docs/google/cloud/chronicle/v1/rule.rb",
77+
"proto_docs/google/longrunning/operations.rb",
78+
"proto_docs/google/protobuf/any.rb",
79+
"proto_docs/google/protobuf/duration.rb",
80+
"proto_docs/google/protobuf/empty.rb",
81+
"proto_docs/google/protobuf/field_mask.rb",
82+
"proto_docs/google/protobuf/timestamp.rb",
83+
"proto_docs/google/rpc/status.rb",
84+
"proto_docs/google/type/interval.rb",
85+
"snippets/Gemfile",
86+
"snippets/data_access_control_service/create_data_access_label.rb",
87+
"snippets/data_access_control_service/create_data_access_scope.rb",
88+
"snippets/data_access_control_service/delete_data_access_label.rb",
89+
"snippets/data_access_control_service/delete_data_access_scope.rb",
90+
"snippets/data_access_control_service/get_data_access_label.rb",
91+
"snippets/data_access_control_service/get_data_access_scope.rb",
92+
"snippets/data_access_control_service/list_data_access_labels.rb",
93+
"snippets/data_access_control_service/list_data_access_scopes.rb",
94+
"snippets/data_access_control_service/update_data_access_label.rb",
95+
"snippets/data_access_control_service/update_data_access_scope.rb",
96+
"snippets/entity_service/create_watchlist.rb",
97+
"snippets/entity_service/delete_watchlist.rb",
98+
"snippets/entity_service/get_watchlist.rb",
99+
"snippets/entity_service/list_watchlists.rb",
100+
"snippets/entity_service/update_watchlist.rb",
101+
"snippets/instance_service/get_instance.rb",
102+
"snippets/reference_list_service/create_reference_list.rb",
103+
"snippets/reference_list_service/get_reference_list.rb",
104+
"snippets/reference_list_service/list_reference_lists.rb",
105+
"snippets/reference_list_service/update_reference_list.rb",
106+
"snippets/rule_service/create_retrohunt.rb",
107+
"snippets/rule_service/create_rule.rb",
108+
"snippets/rule_service/delete_rule.rb",
109+
"snippets/rule_service/get_retrohunt.rb",
110+
"snippets/rule_service/get_rule.rb",
111+
"snippets/rule_service/get_rule_deployment.rb",
112+
"snippets/rule_service/list_retrohunts.rb",
113+
"snippets/rule_service/list_rule_deployments.rb",
114+
"snippets/rule_service/list_rule_revisions.rb",
115+
"snippets/rule_service/list_rules.rb",
116+
"snippets/rule_service/update_rule.rb",
117+
"snippets/rule_service/update_rule_deployment.rb",
118+
"snippets/snippet_metadata_google.cloud.chronicle.v1.json",
119+
"test/google/cloud/chronicle/v1/data_access_control_service_paths_test.rb",
120+
"test/google/cloud/chronicle/v1/data_access_control_service_rest_test.rb",
121+
"test/google/cloud/chronicle/v1/data_access_control_service_test.rb",
122+
"test/google/cloud/chronicle/v1/entity_service_paths_test.rb",
123+
"test/google/cloud/chronicle/v1/entity_service_rest_test.rb",
124+
"test/google/cloud/chronicle/v1/entity_service_test.rb",
125+
"test/google/cloud/chronicle/v1/instance_service_paths_test.rb",
126+
"test/google/cloud/chronicle/v1/instance_service_rest_test.rb",
127+
"test/google/cloud/chronicle/v1/instance_service_test.rb",
128+
"test/google/cloud/chronicle/v1/reference_list_service_paths_test.rb",
129+
"test/google/cloud/chronicle/v1/reference_list_service_rest_test.rb",
130+
"test/google/cloud/chronicle/v1/reference_list_service_test.rb",
131+
"test/google/cloud/chronicle/v1/rule_service_operations_test.rb",
132+
"test/google/cloud/chronicle/v1/rule_service_paths_test.rb",
133+
"test/google/cloud/chronicle/v1/rule_service_rest_test.rb",
134+
"test/google/cloud/chronicle/v1/rule_service_test.rb",
135+
"test/helper.rb"
136+
],
137+
"static": [
138+
".OwlBot.yaml"
139+
]
140+
}

‎google-cloud-chronicle-v1/.repo-metadata.json‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"api_id": "chronicle.googleapis.com",
3+
"api_shortname": "chronicle",
4+
"client_documentation": "https://cloud.google.com/ruby/docs/reference/google-cloud-chronicle-v1/latest",
5+
"distribution_name": "google-cloud-chronicle-v1",
6+
"is_cloud": true,
7+
"language": "ruby",
8+
"name": "chronicle",
9+
"name_pretty": "Chronicle V1 API",
10+
"product_documentation": "https://cloud.google.com/chronicle/docs/secops/secops-overview",
11+
"release_level": "unreleased",
12+
"repo": "googleapis/google-cloud-ruby",
13+
"requires_billing": true,
14+
"ruby-cloud-description": "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. Note that google-cloud-chronicle-v1 is a version-specific client library. For most uses, we recommend installing the main client library google-cloud-chronicle instead. See the readme for more details.",
15+
"ruby-cloud-product-url": "https://cloud.google.com/chronicle/docs/secops/secops-overview",
16+
"library_type": "GAPIC_AUTO"
17+
}

‎google-cloud-chronicle-v1/.rubocop.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
inherit_gem:
2+
google-style: google-style.yml
3+
4+
AllCops:
5+
Exclude:
6+
- "google-cloud-chronicle-v1.gemspec"
7+
- "lib/**/*_pb.rb"
8+
- "proto_docs/**/*"
9+
- "test/**/*"
10+
- "acceptance/**/*"
11+
- "samples/acceptance/**/*"
12+
- "Rakefile"
13+
14+
Layout/LineLength:
15+
Enabled: false
16+
Metrics/AbcSize:
17+
Enabled: false
18+
Metrics/ClassLength:
19+
Enabled: false
20+
Metrics/CyclomaticComplexity:
21+
Enabled: false
22+
Metrics/MethodLength:
23+
Enabled: false
24+
Metrics/ModuleLength:
25+
Enabled: false
26+
Metrics/PerceivedComplexity:
27+
Enabled: false
28+
Naming/AccessorMethodName:
29+
Exclude:
30+
- "snippets/**/*.rb"
31+
Naming/FileName:
32+
Exclude:
33+
- "lib/google-cloud-chronicle-v1.rb"

‎google-cloud-chronicle-v1/.toys.rb‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
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+
toys_version! ">= 0.15.3"
20+
21+
if ENV["RUBY_COMMON_TOOLS"]
22+
common_tools_dir = File.expand_path ENV["RUBY_COMMON_TOOLS"]
23+
load File.join(common_tools_dir, "toys", "gapic")
24+
else
25+
load_git remote: "https://github.com/googleapis/ruby-common-tools.git",
26+
path: "toys/gapic",
27+
update: true
28+
end

‎google-cloud-chronicle-v1/.yardopts‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
--no-private
2+
--title="Chronicle V1 API"
3+
--exclude _pb\.rb$
4+
--markup markdown
5+
--markup-provider redcarpet
6+
7+
./lib/**/*.rb
8+
./proto_docs/**/*.rb
9+
-
10+
README.md
11+
LICENSE.md
12+
AUTHENTICATION.md

‎google-cloud-chronicle-v1/AUTHENTICATION.md‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# Authentication
2+
3+
The recommended way to authenticate to the google-cloud-chronicle-v1 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-v1 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/v1"
58+
59+
client = ::Google::Cloud::Chronicle::V1::DataAccessControlService::Client.new 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/v1"
68+
69+
::Google::Cloud::Chronicle::V1::DataAccessControlService::Client.configure do |config|
70+
config.credentials = "path/to/credentialfile.json"
71+
end
72+
73+
client = ::Google::Cloud::Chronicle::V1::DataAccessControlService::Client.new
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-v1
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/v1"
100+
101+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
102+
103+
client = ::Google::Cloud::Chronicle::V1::DataAccessControlService::Client.new
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).

‎google-cloud-chronicle-v1/CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# Release History
2+

0 commit comments

Comments
 (0)