Skip to content

Commit b7ad711

Browse files
docs: [google-cloud-financialservices] fix grammar in comments of proto fields (#13791)
- [ ] Regenerate this pull request now. docs: repalce double quotes with backticks for formats in comments PiperOrigin-RevId: 747886245 Source-Link: googleapis/googleapis@44de556 Source-Link: googleapis/googleapis-gen@e865fbf Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWZpbmFuY2lhbHNlcnZpY2VzLy5Pd2xCb3QueWFtbCIsImgiOiJlODY1ZmJmMTgzNDMxMDRlZmM4Mzg1MGFlNzI4YjQ4MGQ5MjY1Yjk2In0= --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent 23762ec commit b7ad711

File tree

11 files changed

+46
-47
lines changed

11 files changed

+46
-47
lines changed

packages/google-cloud-financialservices/google/cloud/financialservices_v1/services/aml/async_client.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1056,9 +1056,9 @@ async def sample_import_registered_parties():
10561056
registered parties from BigQuery tables
10571057
specified by the customer.
10581058
name (:class:`str`):
1059-
Required. The full path to the
1060-
Instance resource in this API. format:
1061-
"projects/{project}/locations/{location}/instances/{instance}"
1059+
Required. The full path to the Instance resource in this
1060+
API. format:
1061+
``projects/{project}/locations/{location}/instances/{instance}``
10621062
10631063
This corresponds to the ``name`` field
10641064
on the ``request`` instance; if ``request`` is provided, this
@@ -1079,7 +1079,7 @@ async def sample_import_registered_parties():
10791079
Optional. List of BigQuery tables. Union of tables will
10801080
be taken if there is more than one table. VPC-SC
10811081
restrictions apply. format:
1082-
"bq://{project}.{bqDatasetID}.{bqTableID}" Use of
1082+
``bq://{project}.{bqDatasetID}.{bqTableID}`` Use of
10831083
``datasets`` is preferred over the latter due to its
10841084
simplicity and the reduced risk of errors
10851085
``party_tables`` and ``datasets`` must not be provided
@@ -1224,9 +1224,9 @@ async def sample_export_registered_parties():
12241224
The request object. Request to export a list of currently
12251225
registered parties.
12261226
name (:class:`str`):
1227-
Required. The full path to the
1228-
Instance resource in this API. format:
1229-
"projects/{project}/locations/{location}/instances/{instance}"
1227+
Required. The full path to the Instance resource in this
1228+
API. format:
1229+
``projects/{project}/locations/{location}/instances/{instance}``
12301230
12311231
This corresponds to the ``name`` field
12321232
on the ``request`` instance; if ``request`` is provided, this

packages/google-cloud-financialservices/google/cloud/financialservices_v1/services/aml/client.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1599,9 +1599,9 @@ def sample_import_registered_parties():
15991599
registered parties from BigQuery tables
16001600
specified by the customer.
16011601
name (str):
1602-
Required. The full path to the
1603-
Instance resource in this API. format:
1604-
"projects/{project}/locations/{location}/instances/{instance}"
1602+
Required. The full path to the Instance resource in this
1603+
API. format:
1604+
``projects/{project}/locations/{location}/instances/{instance}``
16051605
16061606
This corresponds to the ``name`` field
16071607
on the ``request`` instance; if ``request`` is provided, this
@@ -1622,7 +1622,7 @@ def sample_import_registered_parties():
16221622
Optional. List of BigQuery tables. Union of tables will
16231623
be taken if there is more than one table. VPC-SC
16241624
restrictions apply. format:
1625-
"bq://{project}.{bqDatasetID}.{bqTableID}" Use of
1625+
``bq://{project}.{bqDatasetID}.{bqTableID}`` Use of
16261626
``datasets`` is preferred over the latter due to its
16271627
simplicity and the reduced risk of errors
16281628
``party_tables`` and ``datasets`` must not be provided
@@ -1766,9 +1766,9 @@ def sample_export_registered_parties():
17661766
The request object. Request to export a list of currently
17671767
registered parties.
17681768
name (str):
1769-
Required. The full path to the
1770-
Instance resource in this API. format:
1771-
"projects/{project}/locations/{location}/instances/{instance}"
1769+
Required. The full path to the Instance resource in this
1770+
API. format:
1771+
``projects/{project}/locations/{location}/instances/{instance}``
17721772
17731773
This corresponds to the ``name`` field
17741774
on the ``request`` instance; if ``request`` is provided, this

packages/google-cloud-financialservices/google/cloud/financialservices_v1/types/backtest_result.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ class BacktestResult(proto.Message):
5050
name (str):
5151
Output only. The resource name of the BacktestResult.
5252
format:
53-
"/projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}".
53+
``/projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}``
5454
create_time (google.protobuf.timestamp_pb2.Timestamp):
5555
Output only. The timestamp of creation of
5656
this resource.
@@ -65,11 +65,11 @@ class BacktestResult(proto.Message):
6565
dataset (str):
6666
Required. The resource name of the Dataset to backtest on
6767
Format:
68-
"/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}".
68+
``/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}``
6969
model (str):
7070
Required. The resource name of the Model to use or to
7171
backtest. Format:
72-
"/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}".
72+
``/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}``
7373
end_time (google.protobuf.timestamp_pb2.Timestamp):
7474
Required. End_time specifies the latest time from which
7575
labels are used and from which data is used to generate

packages/google-cloud-financialservices/google/cloud/financialservices_v1/types/bigquery_destination.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ class BigQueryDestination(proto.Message):
3838
Note that the BigQuery dataset must already
3939
exist. VPC-SC restrictions apply.
4040
write_disposition (google.cloud.financialservices_v1.types.BigQueryDestination.WriteDisposition):
41-
Required. Whether or not to overwrite
41+
Required. Whether or not to overwrite the
4242
destination table. By default the table won't be
4343
overwritten and an error will be returned if the
4444
table exists and contains data.

packages/google-cloud-financialservices/google/cloud/financialservices_v1/types/dataset.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class Dataset(proto.Message):
4444
Attributes:
4545
name (str):
4646
Output only. The resource name of the Dataset. format:
47-
"/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}".
47+
``/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}``
4848
create_time (google.protobuf.timestamp_pb2.Timestamp):
4949
Output only. The timestamp of creation of
5050
this resource.

packages/google-cloud-financialservices/google/cloud/financialservices_v1/types/engine_config.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ class EngineConfig(proto.Message):
4949
Attributes:
5050
name (str):
5151
Output only. The resource name of the EngineConfig. format:
52-
"/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}".
52+
``/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}``
5353
create_time (google.protobuf.timestamp_pb2.Timestamp):
5454
Output only. The timestamp of creation of
5555
this resource.
@@ -64,7 +64,7 @@ class EngineConfig(proto.Message):
6464
engine_version (str):
6565
Required. The resource name of the EngineVersion used in
6666
this model tuning. format:
67-
"/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}".
67+
``/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}``
6868
tuning (google.cloud.financialservices_v1.types.EngineConfig.Tuning):
6969
Optional. Configuration for tuning in creation of the
7070
EngineConfig. This field is required if
@@ -140,7 +140,7 @@ class Tuning(proto.Message):
140140
this model tuning. For information about how primary and
141141
auxiliary datasets are used, refer to the engine version's
142142
documentation. Format:
143-
"/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}".
143+
``/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}``
144144
end_time (google.protobuf.timestamp_pb2.Timestamp):
145145
Required. End_time specifies the latest time from which
146146
labels are used and from which data is used to generate
@@ -188,11 +188,11 @@ class HyperparameterSource(proto.Message):
188188
source_engine_config (str):
189189
Required. The resource name of the source EngineConfig whose
190190
outputs are used. Format:
191-
"/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}".
191+
``/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}``
192192
source_engine_version (str):
193193
Output only. The resource name of the EngineVersion that was
194194
used in the tuning run. Format:
195-
"/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}".
195+
``/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}``
196196
"""
197197

198198
source_engine_config: str = proto.Field(

packages/google-cloud-financialservices/google/cloud/financialservices_v1/types/engine_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ class EngineVersion(proto.Message):
4343
name (str):
4444
Output only. Identifier. The resource name of the
4545
EngineVersion format:
46-
"/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}".
46+
``/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}``
4747
state (google.cloud.financialservices_v1.types.EngineVersion.State):
4848
Output only. The state of the version.
4949
expected_limitation_start_time (google.protobuf.timestamp_pb2.Timestamp):

packages/google-cloud-financialservices/google/cloud/financialservices_v1/types/instance.py

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ class Instance(proto.Message):
5353
5454
Attributes:
5555
name (str):
56-
Output only. The full path to the Instance
57-
resource in this API. format:
58-
"projects/{project}/locations/{location}/instances/{instance}".
56+
Output only. The full path to the Instance resource in this
57+
API. format:
58+
``projects/{project}/locations/{location}/instances/{instance}``
5959
create_time (google.protobuf.timestamp_pb2.Timestamp):
6060
Output only. Timestamp when the Instance was
6161
created. Assigned by the server.
@@ -70,8 +70,7 @@ class Instance(proto.Message):
7070
kms_key (str):
7171
Required. The KMS key name used for CMEK
7272
(encryption-at-rest). format:
73-
74-
"projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}"
73+
``projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}``
7574
VPC-SC restrictions apply.
7675
"""
7776

@@ -372,21 +371,21 @@ class ImportRegisteredPartiesRequest(proto.Message):
372371
373372
Attributes:
374373
name (str):
375-
Required. The full path to the Instance
376-
resource in this API. format:
377-
"projects/{project}/locations/{location}/instances/{instance}".
374+
Required. The full path to the Instance resource in this
375+
API. format:
376+
``projects/{project}/locations/{location}/instances/{instance}``
378377
party_tables (MutableSequence[str]):
379378
Optional. List of BigQuery tables. Union of tables will be
380379
taken if there is more than one table. VPC-SC restrictions
381-
apply. format: "bq://{project}.{bqDatasetID}.{bqTableID}"
380+
apply. format: ``bq://{project}.{bqDatasetID}.{bqTableID}``
382381
Use of ``datasets`` is preferred over the latter due to its
383382
simplicity and the reduced risk of errors ``party_tables``
384383
and ``datasets`` must not be provided at the same time
385384
mode (google.cloud.financialservices_v1.types.ImportRegisteredPartiesRequest.UpdateMode):
386385
Required. Mode of the request.
387386
validate_only (bool):
388-
Optional. Is the request will not register
389-
the parties, just determine what woud happen.
387+
Optional. If the request will not register
388+
the parties, just determine what would happen.
390389
line_of_business (google.cloud.financialservices_v1.types.LineOfBusiness):
391390
Required. LineOfBusiness for the specified
392391
registered parties.
@@ -493,9 +492,9 @@ class ExportRegisteredPartiesRequest(proto.Message):
493492
494493
Attributes:
495494
name (str):
496-
Required. The full path to the Instance
497-
resource in this API. format:
498-
"projects/{project}/locations/{location}/instances/{instance}".
495+
Required. The full path to the Instance resource in this
496+
API. format:
497+
``projects/{project}/locations/{location}/instances/{instance}``
499498
dataset (google.cloud.financialservices_v1.types.BigQueryDestination):
500499
Required. The location to output the
501500
RegisteredParties.

packages/google-cloud-financialservices/google/cloud/financialservices_v1/types/model.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class Model(proto.Message):
4848
Attributes:
4949
name (str):
5050
Output only. The resource name of the Model. format:
51-
"/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}".
51+
``/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}``
5252
create_time (google.protobuf.timestamp_pb2.Timestamp):
5353
Output only. The timestamp of creation of
5454
this resource.
@@ -67,13 +67,13 @@ class Model(proto.Message):
6767
engine_config (str):
6868
Required. The resource name of the EngineConfig the model
6969
training will be based on. Format:
70-
"/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engineConfig}".
70+
``/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engineConfig}``
7171
primary_dataset (str):
7272
Required. The resource name of the Primary Dataset used in
7373
this model training. For information about how primary and
7474
auxiliary datasets are used, refer to the engine version's
7575
documentation. Format:
76-
"/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}".
76+
``/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}``
7777
end_time (google.protobuf.timestamp_pb2.Timestamp):
7878
Required. End_time specifies the latest time from which
7979
labels are used and from which data is used to generate

packages/google-cloud-financialservices/google/cloud/financialservices_v1/types/prediction_result.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ class PredictionResult(proto.Message):
5050
name (str):
5151
Output only. The resource name of the PredictionResult.
5252
format:
53-
"/projects/{project_num}/locations/{location}/instances/{instance}/predictionResults/{prediction_result}".
53+
``/projects/{project_num}/locations/{location}/instances/{instance}/predictionResults/{prediction_result}``
5454
create_time (google.protobuf.timestamp_pb2.Timestamp):
5555
Output only. The timestamp of creation of
5656
this resource.
@@ -65,11 +65,11 @@ class PredictionResult(proto.Message):
6565
dataset (str):
6666
Required. The resource name of the Dataset to do predictions
6767
on Format:
68-
"/projects/{project_num}/locations/{location}/instances/{instance}/dataset/{dataset_id}".
68+
``/projects/{project_num}/locations/{location}/instances/{instance}/dataset/{dataset_id}``
6969
model (str):
7070
Required. The resource name of the Model to use to use to
7171
make predictions Format:
72-
"/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}".
72+
``/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}``
7373
end_time (google.protobuf.timestamp_pb2.Timestamp):
7474
Required. Specifies the latest time from which data is used
7575
to generate features for predictions. This time should be no

0 commit comments

Comments
 (0)