Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -1056,9 +1056,9 @@ async def sample_import_registered_parties():
registered parties from BigQuery tables
specified by the customer.
name (:class:`str`):
Required. The full path to the
Instance resource in this API. format:
"projects/{project}/locations/{location}/instances/{instance}"
Required. The full path to the Instance resource in this
API. format:
``projects/{project}/locations/{location}/instances/{instance}``

This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand All @@ -1079,7 +1079,7 @@ async def sample_import_registered_parties():
Optional. List of BigQuery tables. Union of tables will
be taken if there is more than one table. VPC-SC
restrictions apply. format:
"bq://{project}.{bqDatasetID}.{bqTableID}" Use of
``bq://{project}.{bqDatasetID}.{bqTableID}`` Use of
``datasets`` is preferred over the latter due to its
simplicity and the reduced risk of errors
``party_tables`` and ``datasets`` must not be provided
Expand Down Expand Up @@ -1224,9 +1224,9 @@ async def sample_export_registered_parties():
The request object. Request to export a list of currently
registered parties.
name (:class:`str`):
Required. The full path to the
Instance resource in this API. format:
"projects/{project}/locations/{location}/instances/{instance}"
Required. The full path to the Instance resource in this
API. format:
``projects/{project}/locations/{location}/instances/{instance}``

This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1599,9 +1599,9 @@ def sample_import_registered_parties():
registered parties from BigQuery tables
specified by the customer.
name (str):
Required. The full path to the
Instance resource in this API. format:
"projects/{project}/locations/{location}/instances/{instance}"
Required. The full path to the Instance resource in this
API. format:
``projects/{project}/locations/{location}/instances/{instance}``

This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand All @@ -1622,7 +1622,7 @@ def sample_import_registered_parties():
Optional. List of BigQuery tables. Union of tables will
be taken if there is more than one table. VPC-SC
restrictions apply. format:
"bq://{project}.{bqDatasetID}.{bqTableID}" Use of
``bq://{project}.{bqDatasetID}.{bqTableID}`` Use of
``datasets`` is preferred over the latter due to its
simplicity and the reduced risk of errors
``party_tables`` and ``datasets`` must not be provided
Expand Down Expand Up @@ -1766,9 +1766,9 @@ def sample_export_registered_parties():
The request object. Request to export a list of currently
registered parties.
name (str):
Required. The full path to the
Instance resource in this API. format:
"projects/{project}/locations/{location}/instances/{instance}"
Required. The full path to the Instance resource in this
API. format:
``projects/{project}/locations/{location}/instances/{instance}``

This corresponds to the ``name`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ class BacktestResult(proto.Message):
name (str):
Output only. The resource name of the BacktestResult.
format:
"/projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}".
``/projects/{project_num}/locations/{location}/instances/{instance}/backtestResults/{backtest_result}``
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. The timestamp of creation of
this resource.
Expand All @@ -65,11 +65,11 @@ class BacktestResult(proto.Message):
dataset (str):
Required. The resource name of the Dataset to backtest on
Format:
"/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}".
``/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}``
model (str):
Required. The resource name of the Model to use or to
backtest. Format:
"/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}".
``/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}``
end_time (google.protobuf.timestamp_pb2.Timestamp):
Required. End_time specifies the latest time from which
labels are used and from which data is used to generate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ class BigQueryDestination(proto.Message):
Note that the BigQuery dataset must already
exist. VPC-SC restrictions apply.
write_disposition (google.cloud.financialservices_v1.types.BigQueryDestination.WriteDisposition):
Required. Whether or not to overwrite
Required. Whether or not to overwrite the
destination table. By default the table won't be
overwritten and an error will be returned if the
table exists and contains data.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ class Dataset(proto.Message):
Attributes:
name (str):
Output only. The resource name of the Dataset. format:
"/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}".
``/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}``
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. The timestamp of creation of
this resource.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ class EngineConfig(proto.Message):
Attributes:
name (str):
Output only. The resource name of the EngineConfig. format:
"/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}".
``/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}``
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. The timestamp of creation of
this resource.
Expand All @@ -64,7 +64,7 @@ class EngineConfig(proto.Message):
engine_version (str):
Required. The resource name of the EngineVersion used in
this model tuning. format:
"/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}".
``/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}``
tuning (google.cloud.financialservices_v1.types.EngineConfig.Tuning):
Optional. Configuration for tuning in creation of the
EngineConfig. This field is required if
Expand Down Expand Up @@ -140,7 +140,7 @@ class Tuning(proto.Message):
this model tuning. For information about how primary and
auxiliary datasets are used, refer to the engine version's
documentation. Format:
"/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}".
``/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}``
end_time (google.protobuf.timestamp_pb2.Timestamp):
Required. End_time specifies the latest time from which
labels are used and from which data is used to generate
Expand Down Expand Up @@ -188,11 +188,11 @@ class HyperparameterSource(proto.Message):
source_engine_config (str):
Required. The resource name of the source EngineConfig whose
outputs are used. Format:
"/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}".
``/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engine_config}``
source_engine_version (str):
Output only. The resource name of the EngineVersion that was
used in the tuning run. Format:
"/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}".
``/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}``
"""

source_engine_config: str = proto.Field(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ class EngineVersion(proto.Message):
name (str):
Output only. Identifier. The resource name of the
EngineVersion format:
"/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}".
``/projects/{project_num}/locations/{location}/instances/{instance}/engineVersions/{engine_version}``
state (google.cloud.financialservices_v1.types.EngineVersion.State):
Output only. The state of the version.
expected_limitation_start_time (google.protobuf.timestamp_pb2.Timestamp):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ class Instance(proto.Message):

Attributes:
name (str):
Output only. The full path to the Instance
resource in this API. format:
"projects/{project}/locations/{location}/instances/{instance}".
Output only. The full path to the Instance resource in this
API. format:
``projects/{project}/locations/{location}/instances/{instance}``
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. Timestamp when the Instance was
created. Assigned by the server.
Expand All @@ -70,8 +70,7 @@ class Instance(proto.Message):
kms_key (str):
Required. The KMS key name used for CMEK
(encryption-at-rest). format:

"projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}"
``projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey}``
VPC-SC restrictions apply.
"""

Expand Down Expand Up @@ -372,21 +371,21 @@ class ImportRegisteredPartiesRequest(proto.Message):

Attributes:
name (str):
Required. The full path to the Instance
resource in this API. format:
"projects/{project}/locations/{location}/instances/{instance}".
Required. The full path to the Instance resource in this
API. format:
``projects/{project}/locations/{location}/instances/{instance}``
party_tables (MutableSequence[str]):
Optional. List of BigQuery tables. Union of tables will be
taken if there is more than one table. VPC-SC restrictions
apply. format: "bq://{project}.{bqDatasetID}.{bqTableID}"
apply. format: ``bq://{project}.{bqDatasetID}.{bqTableID}``
Use of ``datasets`` is preferred over the latter due to its
simplicity and the reduced risk of errors ``party_tables``
and ``datasets`` must not be provided at the same time
mode (google.cloud.financialservices_v1.types.ImportRegisteredPartiesRequest.UpdateMode):
Required. Mode of the request.
validate_only (bool):
Optional. Is the request will not register
the parties, just determine what woud happen.
Optional. If the request will not register
the parties, just determine what would happen.
line_of_business (google.cloud.financialservices_v1.types.LineOfBusiness):
Required. LineOfBusiness for the specified
registered parties.
Expand Down Expand Up @@ -493,9 +492,9 @@ class ExportRegisteredPartiesRequest(proto.Message):

Attributes:
name (str):
Required. The full path to the Instance
resource in this API. format:
"projects/{project}/locations/{location}/instances/{instance}".
Required. The full path to the Instance resource in this
API. format:
``projects/{project}/locations/{location}/instances/{instance}``
dataset (google.cloud.financialservices_v1.types.BigQueryDestination):
Required. The location to output the
RegisteredParties.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class Model(proto.Message):
Attributes:
name (str):
Output only. The resource name of the Model. format:
"/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}".
``/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}``
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. The timestamp of creation of
this resource.
Expand All @@ -67,13 +67,13 @@ class Model(proto.Message):
engine_config (str):
Required. The resource name of the EngineConfig the model
training will be based on. Format:
"/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engineConfig}".
``/projects/{project_num}/locations/{location}/instances/{instance}/engineConfigs/{engineConfig}``
primary_dataset (str):
Required. The resource name of the Primary Dataset used in
this model training. For information about how primary and
auxiliary datasets are used, refer to the engine version's
documentation. Format:
"/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}".
``/projects/{project_num}/locations/{location}/instances/{instance}/datasets/{dataset}``
end_time (google.protobuf.timestamp_pb2.Timestamp):
Required. End_time specifies the latest time from which
labels are used and from which data is used to generate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ class PredictionResult(proto.Message):
name (str):
Output only. The resource name of the PredictionResult.
format:
"/projects/{project_num}/locations/{location}/instances/{instance}/predictionResults/{prediction_result}".
``/projects/{project_num}/locations/{location}/instances/{instance}/predictionResults/{prediction_result}``
create_time (google.protobuf.timestamp_pb2.Timestamp):
Output only. The timestamp of creation of
this resource.
Expand All @@ -65,11 +65,11 @@ class PredictionResult(proto.Message):
dataset (str):
Required. The resource name of the Dataset to do predictions
on Format:
"/projects/{project_num}/locations/{location}/instances/{instance}/dataset/{dataset_id}".
``/projects/{project_num}/locations/{location}/instances/{instance}/dataset/{dataset_id}``
model (str):
Required. The resource name of the Model to use to use to
make predictions Format:
"/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}".
``/projects/{project_num}/locations/{location}/instances/{instance}/models/{model}``
end_time (google.protobuf.timestamp_pb2.Timestamp):
Required. Specifies the latest time from which data is used
to generate features for predictions. This time should be no
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@ class OperationMetadata(proto.Message):
Output only. Identifies whether the user has requested
cancellation of the operation.

Successfully cancelled operations have a
[google.longrunning.Operation.error][] value with a
Successfully cancelled operations have a [Operation.error][]
value with a
[google.rpc.Status.code][google.rpc.Status.code] of 1,
corresponding to ``Code.CANCELLED``.
api_version (str):
Expand Down
Loading