Skip to content

Commit 44de556

Browse files
Google APIscopybara-github
authored andcommitted
docs: fix grammar in comments of proto fields
docs: repalce double quotes with backticks for formats in comments PiperOrigin-RevId: 747886245
1 parent f3f5b91 commit 44de556

12 files changed

Lines changed: 80 additions & 42 deletions

google/cloud/financialservices/v1/BUILD.bazel

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -314,9 +314,7 @@ ruby_grpc_library(
314314
ruby_cloud_gapic_library(
315315
name = "financialservices_ruby_gapic",
316316
srcs = [":financialservices_proto_with_info"],
317-
extra_protoc_parameters = [
318-
"ruby-cloud-gem-name=google-cloud-financialservices-v1",
319-
],
317+
extra_protoc_parameters = ["ruby-cloud-gem-name=google-cloud-financial_services-v1"],
320318
grpc_service_config = "financialservices_v1_grpc_service_config.json",
321319
rest_numeric_enums = True,
322320
service_yaml = "financialservices_v1.yaml",
@@ -351,7 +349,6 @@ load(
351349

352350
csharp_proto_library(
353351
name = "financialservices_csharp_proto",
354-
extra_opts = [],
355352
deps = [":financialservices_proto"],
356353
)
357354

google/cloud/financialservices/v1/backtest_result.proto

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2024 Google LLC
1+
// Copyright 2025 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -23,10 +23,13 @@ import "google/cloud/financialservices/v1/line_of_business.proto";
2323
import "google/protobuf/field_mask.proto";
2424
import "google/protobuf/timestamp.proto";
2525

26+
option csharp_namespace = "Google.Cloud.FinancialServices.V1";
2627
option go_package = "cloud.google.com/go/financialservices/apiv1/financialservicespb;financialservicespb";
2728
option java_multiple_files = true;
2829
option java_outer_classname = "BacktestResultProto";
2930
option java_package = "com.google.cloud.financialservices.v1";
31+
option php_namespace = "Google\\Cloud\\FinancialServices\\V1";
32+
option ruby_package = "Google::Cloud::FinancialServices::V1";
3033

3134
// BacktestResult is created to test the performance of a model on a dataset.
3235
message BacktestResult {
@@ -68,7 +71,7 @@ message BacktestResult {
6871

6972
// Output only. The resource name of the BacktestResult.
7073
// format:
71-
// "/projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}"
74+
// `/projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}`
7275
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
7376

7477
// Output only. The timestamp of creation of this resource.
@@ -87,7 +90,7 @@ message BacktestResult {
8790

8891
// Required. The resource name of the Dataset to backtest on
8992
// Format:
90-
// "/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}"
93+
// `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`
9194
string dataset = 6 [
9295
(google.api.field_behavior) = REQUIRED,
9396
(google.api.resource_reference) = {
@@ -97,7 +100,7 @@ message BacktestResult {
97100

98101
// Required. The resource name of the Model to use or to backtest.
99102
// Format:
100-
// "/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}"
103+
// `/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}`
101104
string model = 7 [
102105
(google.api.field_behavior) = REQUIRED,
103106
(google.api.resource_reference) = {

google/cloud/financialservices/v1/bigquery_destination.proto

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2024 Google LLC
1+
// Copyright 2025 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -18,10 +18,13 @@ package google.cloud.financialservices.v1;
1818

1919
import "google/api/field_behavior.proto";
2020

21+
option csharp_namespace = "Google.Cloud.FinancialServices.V1";
2122
option go_package = "cloud.google.com/go/financialservices/apiv1/financialservicespb;financialservicespb";
2223
option java_multiple_files = true;
2324
option java_outer_classname = "BigQueryDestinationProto";
2425
option java_package = "com.google.cloud.financialservices.v1";
26+
option php_namespace = "Google\\Cloud\\FinancialServices\\V1";
27+
option ruby_package = "Google::Cloud::FinancialServices::V1";
2528

2629
// BigQueryDestination is a wrapper for BigQuery output information.
2730
message BigQueryDestination {
@@ -44,7 +47,7 @@ message BigQueryDestination {
4447
// VPC-SC restrictions apply.
4548
string table_uri = 1 [(google.api.field_behavior) = OPTIONAL];
4649

47-
// Required. Whether or not to overwrite destination table. By default the
50+
// Required. Whether or not to overwrite the destination table. By default the
4851
// table won't be overwritten and an error will be returned if the table
4952
// exists and contains data.
5053
WriteDisposition write_disposition = 2

google/cloud/financialservices/v1/dataset.proto

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2024 Google LLC
1+
// Copyright 2025 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -23,10 +23,13 @@ import "google/protobuf/timestamp.proto";
2323
import "google/type/datetime.proto";
2424
import "google/type/interval.proto";
2525

26+
option csharp_namespace = "Google.Cloud.FinancialServices.V1";
2627
option go_package = "cloud.google.com/go/financialservices/apiv1/financialservicespb;financialservicespb";
2728
option java_multiple_files = true;
2829
option java_outer_classname = "DatasetProto";
2930
option java_package = "com.google.cloud.financialservices.v1";
31+
option php_namespace = "Google\\Cloud\\FinancialServices\\V1";
32+
option ruby_package = "Google::Cloud::FinancialServices::V1";
3033

3134
// The Dataset resource contains summary information about a dataset.
3235
message Dataset {
@@ -55,7 +58,7 @@ message Dataset {
5558

5659
// Output only. The resource name of the Dataset.
5760
// format:
58-
// "/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}"
61+
// `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`
5962
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
6063

6164
// Output only. The timestamp of creation of this resource.

google/cloud/financialservices/v1/engine_config.proto

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2024 Google LLC
1+
// Copyright 2025 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -23,10 +23,13 @@ import "google/cloud/financialservices/v1/line_of_business.proto";
2323
import "google/protobuf/field_mask.proto";
2424
import "google/protobuf/timestamp.proto";
2525

26+
option csharp_namespace = "Google.Cloud.FinancialServices.V1";
2627
option go_package = "cloud.google.com/go/financialservices/apiv1/financialservicespb;financialservicespb";
2728
option java_multiple_files = true;
2829
option java_outer_classname = "EngineConfigProto";
2930
option java_package = "com.google.cloud.financialservices.v1";
31+
option php_namespace = "Google\\Cloud\\FinancialServices\\V1";
32+
option ruby_package = "Google::Cloud::FinancialServices::V1";
3033

3134
// The EngineConfig resource creates the configuration for training a model.
3235
message EngineConfig {
@@ -41,7 +44,7 @@ message EngineConfig {
4144
// Required. The resource name of the Primary Dataset used in this model
4245
// tuning. For information about how primary and auxiliary datasets are
4346
// used, refer to the engine version's documentation. Format:
44-
// "/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}"
47+
// `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`
4548
string primary_dataset = 1 [
4649
(google.api.field_behavior) = REQUIRED,
4750
(google.api.resource_reference) = {
@@ -74,12 +77,12 @@ message EngineConfig {
7477
message HyperparameterSource {
7578
// Required. The resource name of the source EngineConfig whose outputs are
7679
// used. Format:
77-
// "/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}"
80+
// `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`
7881
string source_engine_config = 1 [(google.api.field_behavior) = REQUIRED];
7982

8083
// Output only. The resource name of the EngineVersion that was used in the
8184
// tuning run. Format:
82-
// "/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}"
85+
// `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`
8386
string source_engine_version = 2
8487
[(google.api.field_behavior) = OUTPUT_ONLY];
8588
}
@@ -117,7 +120,7 @@ message EngineConfig {
117120

118121
// Output only. The resource name of the EngineConfig.
119122
// format:
120-
// "/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}"
123+
// `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}`
121124
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
122125

123126
// Output only. The timestamp of creation of this resource.
@@ -136,7 +139,7 @@ message EngineConfig {
136139

137140
// Required. The resource name of the EngineVersion used in this model tuning.
138141
// format:
139-
// "/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}"
142+
// `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`
140143
string engine_version = 6 [
141144
(google.api.field_behavior) = REQUIRED,
142145
(google.api.resource_reference) = {

google/cloud/financialservices/v1/engine_version.proto

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2024 Google LLC
1+
// Copyright 2025 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -21,10 +21,13 @@ import "google/api/resource.proto";
2121
import "google/cloud/financialservices/v1/line_of_business.proto";
2222
import "google/protobuf/timestamp.proto";
2323

24+
option csharp_namespace = "Google.Cloud.FinancialServices.V1";
2425
option go_package = "cloud.google.com/go/financialservices/apiv1/financialservicespb;financialservicespb";
2526
option java_multiple_files = true;
2627
option java_outer_classname = "EngineVersionProto";
2728
option java_package = "com.google.cloud.financialservices.v1";
29+
option php_namespace = "Google\\Cloud\\FinancialServices\\V1";
30+
option ruby_package = "Google::Cloud::FinancialServices::V1";
2831

2932
// EngineVersion controls which version of the engine is used to tune, train,
3033
// and run the model.
@@ -53,7 +56,7 @@ message EngineVersion {
5356

5457
// Output only. Identifier. The resource name of the EngineVersion
5558
// format:
56-
// "/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}"
59+
// `/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}`
5760
string name = 1 [
5861
(google.api.field_behavior) = OUTPUT_ONLY,
5962
(google.api.field_behavior) = IDENTIFIER

google/cloud/financialservices/v1/financialservices_v1.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,10 @@ publishing:
7373
common:
7474
destinations:
7575
- PACKAGE_MANAGER
76+
php_settings:
77+
common:
78+
destinations:
79+
- PACKAGE_MANAGER
7680
python_settings:
7781
common:
7882
destinations:
@@ -81,6 +85,14 @@ publishing:
8185
common:
8286
destinations:
8387
- PACKAGE_MANAGER
88+
dotnet_settings:
89+
common:
90+
destinations:
91+
- PACKAGE_MANAGER
92+
ruby_settings:
93+
common:
94+
destinations:
95+
- PACKAGE_MANAGER
8496
go_settings:
8597
common:
8698
destinations:

google/cloud/financialservices/v1/instance.proto

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2024 Google LLC
1+
// Copyright 2025 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -23,10 +23,13 @@ import "google/cloud/financialservices/v1/line_of_business.proto";
2323
import "google/protobuf/field_mask.proto";
2424
import "google/protobuf/timestamp.proto";
2525

26+
option csharp_namespace = "Google.Cloud.FinancialServices.V1";
2627
option go_package = "cloud.google.com/go/financialservices/apiv1/financialservicespb;financialservicespb";
2728
option java_multiple_files = true;
2829
option java_outer_classname = "InstanceProto";
2930
option java_package = "com.google.cloud.financialservices.v1";
31+
option php_namespace = "Google\\Cloud\\FinancialServices\\V1";
32+
option ruby_package = "Google::Cloud::FinancialServices::V1";
3033

3134
// Instance is a container for the rest of API resources.
3235
// Only resources in the same instance can interact with each other.
@@ -58,7 +61,7 @@ message Instance {
5861
}
5962

6063
// Output only. The full path to the Instance resource in this API.
61-
// format: "projects/{project}/locations/{location}/instances/{instance}"
64+
// format: `projects/{project}/locations/{location}/instances/{instance}`
6265
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
6366

6467
// Output only. Timestamp when the Instance was created.
@@ -80,7 +83,7 @@ message Instance {
8083

8184
// Required. The KMS key name used for CMEK (encryption-at-rest).
8285
// format:
83-
// "projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}"
86+
// `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}`
8487
// VPC-SC restrictions apply.
8588
string kms_key = 6 [(google.api.field_behavior) = REQUIRED];
8689
}
@@ -244,7 +247,7 @@ message ImportRegisteredPartiesRequest {
244247
}
245248

246249
// Required. The full path to the Instance resource in this API.
247-
// format: "projects/{project}/locations/{location}/instances/{instance}"
250+
// format: `projects/{project}/locations/{location}/instances/{instance}`
248251
string name = 1 [
249252
(google.api.field_behavior) = REQUIRED,
250253
(google.api.resource_reference) = {
@@ -254,7 +257,7 @@ message ImportRegisteredPartiesRequest {
254257

255258
// Optional. List of BigQuery tables. Union of tables will be taken if there
256259
// is more than one table. VPC-SC restrictions apply. format:
257-
// "bq://{project}.{bqDatasetID}.{bqTableID}" Use of `datasets` is preferred
260+
// `bq://{project}.{bqDatasetID}.{bqTableID}` Use of `datasets` is preferred
258261
// over the latter due to its simplicity and the reduced risk of errors
259262
// `party_tables` and `datasets` must not be provided at the
260263
// same time
@@ -263,8 +266,8 @@ message ImportRegisteredPartiesRequest {
263266
// Required. Mode of the request.
264267
UpdateMode mode = 3 [(google.api.field_behavior) = REQUIRED];
265268

266-
// Optional. Is the request will not register the parties, just determine what
267-
// woud happen.
269+
// Optional. If the request will not register the parties, just determine what
270+
// would happen.
268271
bool validate_only = 4 [(google.api.field_behavior) = OPTIONAL];
269272

270273
// Required. LineOfBusiness for the specified registered parties.
@@ -298,7 +301,7 @@ message ImportRegisteredPartiesResponse {
298301
// Request to export a list of currently registered parties.
299302
message ExportRegisteredPartiesRequest {
300303
// Required. The full path to the Instance resource in this API.
301-
// format: "projects/{project}/locations/{location}/instances/{instance}"
304+
// format: `projects/{project}/locations/{location}/instances/{instance}`
302305
string name = 1 [
303306
(google.api.field_behavior) = REQUIRED,
304307
(google.api.resource_reference) = {

google/cloud/financialservices/v1/line_of_business.proto

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2024 Google LLC
1+
// Copyright 2025 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -16,10 +16,13 @@ syntax = "proto3";
1616

1717
package google.cloud.financialservices.v1;
1818

19+
option csharp_namespace = "Google.Cloud.FinancialServices.V1";
1920
option go_package = "cloud.google.com/go/financialservices/apiv1/financialservicespb;financialservicespb";
2021
option java_multiple_files = true;
2122
option java_outer_classname = "LineOfBusinessProto";
2223
option java_package = "com.google.cloud.financialservices.v1";
24+
option php_namespace = "Google\\Cloud\\FinancialServices\\V1";
25+
option ruby_package = "Google::Cloud::FinancialServices::V1";
2326

2427
// Indicate which LineOfBusiness a party belongs to.
2528
enum LineOfBusiness {

google/cloud/financialservices/v1/model.proto

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Copyright 2024 Google LLC
1+
// Copyright 2025 Google LLC
22
//
33
// Licensed under the Apache License, Version 2.0 (the "License");
44
// you may not use this file except in compliance with the License.
@@ -23,10 +23,13 @@ import "google/cloud/financialservices/v1/line_of_business.proto";
2323
import "google/protobuf/field_mask.proto";
2424
import "google/protobuf/timestamp.proto";
2525

26+
option csharp_namespace = "Google.Cloud.FinancialServices.V1";
2627
option go_package = "cloud.google.com/go/financialservices/apiv1/financialservicespb;financialservicespb";
2728
option java_multiple_files = true;
2829
option java_outer_classname = "ModelProto";
2930
option java_package = "com.google.cloud.financialservices.v1";
31+
option php_namespace = "Google\\Cloud\\FinancialServices\\V1";
32+
option ruby_package = "Google::Cloud::FinancialServices::V1";
3033

3134
// Model represents a trained model.
3235
message Model {
@@ -55,7 +58,7 @@ message Model {
5558

5659
// Output only. The resource name of the Model.
5760
// format:
58-
// "/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}"
61+
// `/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}`
5962
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
6063

6164
// Output only. The timestamp of creation of this resource.
@@ -83,7 +86,7 @@ message Model {
8386

8487
// Required. The resource name of the EngineConfig the model training will be
8588
// based on. Format:
86-
// "/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engineConfig}"
89+
// `/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engineConfig}`
8790
string engine_config = 7 [
8891
(google.api.field_behavior) = REQUIRED,
8992
(google.api.resource_reference) = {
@@ -94,7 +97,7 @@ message Model {
9497
// Required. The resource name of the Primary Dataset used in this model
9598
// training. For information about how primary and auxiliary datasets are
9699
// used, refer to the engine version's documentation. Format:
97-
// "/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}"
100+
// `/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}`
98101
string primary_dataset = 8 [
99102
(google.api.field_behavior) = REQUIRED,
100103
(google.api.resource_reference) = {

0 commit comments

Comments
 (0)