Skip to content

Commit

Permalink
Regenerate all APIs with service comments in client documentation
Browse files Browse the repository at this point in the history
The comments are included as they are, as a "remarks" section both the abstract base class and the concrete implementation.
  • Loading branch information
jskeet committed Jul 8, 2020
1 parent 10ad719 commit 6bde7a3
Show file tree
Hide file tree
Showing 167 changed files with 1,559 additions and 69 deletions.
Expand Up @@ -269,6 +269,9 @@ private AssetServiceClient BuildImpl()
}

/// <summary>AssetService client wrapper, for convenient use.</summary>
/// <remarks>
/// Asset service definition.
/// </remarks>
public abstract partial class AssetServiceClient
{
/// <summary>
Expand Down Expand Up @@ -1279,6 +1282,9 @@ internal static AssetServiceClient Create(grpccore::CallInvoker callInvoker, Ass
}

/// <summary>AssetService client wrapper implementation, for convenient use.</summary>
/// <remarks>
/// Asset service definition.
/// </remarks>
public sealed partial class AssetServiceClientImpl : AssetServiceClient
{
private readonly gaxgrpc::ApiCall<ExportAssetsRequest, lro::Operation> _callExportAssets;
Expand Down
2 changes: 1 addition & 1 deletion apis/Google.Cloud.Asset.V1/synth.metadata
Expand Up @@ -4,7 +4,7 @@
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "49883ad9b196aa7b44869d24749104b504cafad0"
"sha": "07460951fc07dd2b3f172d01b04e2a5fefd13ccc"
}
}
]
Expand Down
Expand Up @@ -547,6 +547,22 @@ private AutoMlClient BuildImpl()
}

/// <summary>AutoMl client wrapper, for convenient use.</summary>
/// <remarks>
/// AutoML Server API.
///
/// The resource names are assigned by the server.
/// The server never reuses names that it has created after the resources with
/// those names are deleted.
///
/// An ID of a resource is the last element of the item's resource name. For
/// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`, then
/// the id for the item is `{dataset_id}`.
///
/// Currently the only supported `location_id` is "us-central1".
///
/// On any input that is documented to expect a string parameter in
/// snake_case or kebab-case, either of those cases is accepted.
/// </remarks>
public abstract partial class AutoMlClient
{
/// <summary>
Expand Down Expand Up @@ -3310,6 +3326,22 @@ internal static AutoMlClient Create(grpccore::CallInvoker callInvoker, AutoMlSet
}

/// <summary>AutoMl client wrapper implementation, for convenient use.</summary>
/// <remarks>
/// AutoML Server API.
///
/// The resource names are assigned by the server.
/// The server never reuses names that it has created after the resources with
/// those names are deleted.
///
/// An ID of a resource is the last element of the item's resource name. For
/// `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}`, then
/// the id for the item is `{dataset_id}`.
///
/// Currently the only supported `location_id` is "us-central1".
///
/// On any input that is documented to expect a string parameter in
/// snake_case or kebab-case, either of those cases is accepted.
/// </remarks>
public sealed partial class AutoMlClientImpl : AutoMlClient
{
private readonly gaxgrpc::ApiCall<CreateDatasetRequest, lro::Operation> _callCreateDataset;
Expand Down
Expand Up @@ -158,6 +158,12 @@ private PredictionServiceClient BuildImpl()
}

/// <summary>PredictionService client wrapper, for convenient use.</summary>
/// <remarks>
/// AutoML Prediction API.
///
/// On any input that is documented to expect a string parameter in
/// snake_case or kebab-case, either of those cases is accepted.
/// </remarks>
public abstract partial class PredictionServiceClient
{
/// <summary>
Expand Down Expand Up @@ -1731,6 +1737,12 @@ internal static PredictionServiceClient Create(grpccore::CallInvoker callInvoker
}

/// <summary>PredictionService client wrapper implementation, for convenient use.</summary>
/// <remarks>
/// AutoML Prediction API.
///
/// On any input that is documented to expect a string parameter in
/// snake_case or kebab-case, either of those cases is accepted.
/// </remarks>
public sealed partial class PredictionServiceClientImpl : PredictionServiceClient
{
private readonly gaxgrpc::ApiCall<PredictRequest, PredictResponse> _callPredict;
Expand Down
2 changes: 1 addition & 1 deletion apis/Google.Cloud.AutoML.V1/synth.metadata
Expand Up @@ -4,7 +4,7 @@
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "7272af32a96a42fe5bb9452360e32ae95718abc2"
"sha": "07460951fc07dd2b3f172d01b04e2a5fefd13ccc"
}
}
]
Expand Down
Expand Up @@ -230,6 +230,9 @@ private ConnectionServiceClient BuildImpl()
}

/// <summary>ConnectionService client wrapper, for convenient use.</summary>
/// <remarks>
/// Manages external data source connections and credentials.
/// </remarks>
public abstract partial class ConnectionServiceClient
{
/// <summary>
Expand Down Expand Up @@ -1521,6 +1524,9 @@ internal static ConnectionServiceClient Create(grpccore::CallInvoker callInvoker
}

/// <summary>ConnectionService client wrapper implementation, for convenient use.</summary>
/// <remarks>
/// Manages external data source connections and credentials.
/// </remarks>
public sealed partial class ConnectionServiceClientImpl : ConnectionServiceClient
{
private readonly gaxgrpc::ApiCall<CreateConnectionRequest, Connection> _callCreateConnection;
Expand Down
2 changes: 1 addition & 1 deletion apis/Google.Cloud.BigQuery.Connection.V1/synth.metadata
Expand Up @@ -4,7 +4,7 @@
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "163aa04ede887024d245ab2c6af2528d9460bb9c"
"sha": "07460951fc07dd2b3f172d01b04e2a5fefd13ccc"
}
}
]
Expand Down
Expand Up @@ -337,6 +337,12 @@ private DataTransferServiceClient BuildImpl()
}

/// <summary>DataTransferService client wrapper, for convenient use.</summary>
/// <remarks>
/// The Google BigQuery Data Transfer Service API enables BigQuery users to
/// configure the transfer of their data from other Google Products into
/// BigQuery. This service contains methods that are end user exposed. It backs
/// up the frontend.
/// </remarks>
public abstract partial class DataTransferServiceClient
{
/// <summary>
Expand Down Expand Up @@ -2319,6 +2325,12 @@ internal static DataTransferServiceClient Create(grpccore::CallInvoker callInvok
}

/// <summary>DataTransferService client wrapper implementation, for convenient use.</summary>
/// <remarks>
/// The Google BigQuery Data Transfer Service API enables BigQuery users to
/// configure the transfer of their data from other Google Products into
/// BigQuery. This service contains methods that are end user exposed. It backs
/// up the frontend.
/// </remarks>
public sealed partial class DataTransferServiceClientImpl : DataTransferServiceClient
{
private readonly gaxgrpc::ApiCall<GetDataSourceRequest, DataSource> _callGetDataSource;
Expand Down
2 changes: 1 addition & 1 deletion apis/Google.Cloud.BigQuery.DataTransfer.V1/synth.metadata
Expand Up @@ -4,7 +4,7 @@
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "7272af32a96a42fe5bb9452360e32ae95718abc2"
"sha": "07460951fc07dd2b3f172d01b04e2a5fefd13ccc"
}
}
]
Expand Down
Expand Up @@ -405,6 +405,23 @@ private ReservationServiceClient BuildImpl()
}

/// <summary>ReservationService client wrapper, for convenient use.</summary>
/// <remarks>
/// This API allows users to manage their flat-rate BigQuery reservations.
///
/// A reservation provides computational resource guarantees, in the form of
/// [slots](https://cloud.google.com/bigquery/docs/slots), to users. A slot is a
/// unit of computational power in BigQuery, and serves as the basic unit of
/// parallelism. In a scan of a multi-partitioned table, a single slot operates
/// on a single partition of the table. A reservation resource exists as a child
/// resource of the admin project and location, e.g.:
/// `projects/myproject/locations/US/reservations/reservationName`.
///
/// A capacity commitment is a way to purchase compute capacity for BigQuery jobs
/// (in the form of slots) with some committed period of usage. A capacity
/// commitment resource exists as a child resource of the admin project and
/// location, e.g.:
/// `projects/myproject/locations/US/capacityCommitments/id`.
/// </remarks>
public abstract partial class ReservationServiceClient
{
/// <summary>
Expand Down Expand Up @@ -3701,6 +3718,23 @@ internal static ReservationServiceClient Create(grpccore::CallInvoker callInvoke
}

/// <summary>ReservationService client wrapper implementation, for convenient use.</summary>
/// <remarks>
/// This API allows users to manage their flat-rate BigQuery reservations.
///
/// A reservation provides computational resource guarantees, in the form of
/// [slots](https://cloud.google.com/bigquery/docs/slots), to users. A slot is a
/// unit of computational power in BigQuery, and serves as the basic unit of
/// parallelism. In a scan of a multi-partitioned table, a single slot operates
/// on a single partition of the table. A reservation resource exists as a child
/// resource of the admin project and location, e.g.:
/// `projects/myproject/locations/US/reservations/reservationName`.
///
/// A capacity commitment is a way to purchase compute capacity for BigQuery jobs
/// (in the form of slots) with some committed period of usage. A capacity
/// commitment resource exists as a child resource of the admin project and
/// location, e.g.:
/// `projects/myproject/locations/US/capacityCommitments/id`.
/// </remarks>
public sealed partial class ReservationServiceClientImpl : ReservationServiceClient
{
private readonly gaxgrpc::ApiCall<CreateReservationRequest, Reservation> _callCreateReservation;
Expand Down
2 changes: 1 addition & 1 deletion apis/Google.Cloud.BigQuery.Reservation.V1/synth.metadata
Expand Up @@ -4,7 +4,7 @@
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "7272af32a96a42fe5bb9452360e32ae95718abc2"
"sha": "07460951fc07dd2b3f172d01b04e2a5fefd13ccc"
}
}
]
Expand Down
Expand Up @@ -152,6 +152,11 @@ private BigQueryReadClient BuildImpl()
}

/// <summary>BigQueryRead client wrapper, for convenient use.</summary>
/// <remarks>
/// BigQuery Read API.
///
/// The Read API can be used to read data from BigQuery.
/// </remarks>
public abstract partial class BigQueryReadClient
{
/// <summary>
Expand Down Expand Up @@ -727,6 +732,11 @@ public abstract partial class ReadRowsStream : gaxgrpc::ServerStreamingBase<Read
}

/// <summary>BigQueryRead client wrapper implementation, for convenient use.</summary>
/// <remarks>
/// BigQuery Read API.
///
/// The Read API can be used to read data from BigQuery.
/// </remarks>
public sealed partial class BigQueryReadClientImpl : BigQueryReadClient
{
private readonly gaxgrpc::ApiCall<CreateReadSessionRequest, ReadSession> _callCreateReadSession;
Expand Down
2 changes: 1 addition & 1 deletion apis/Google.Cloud.BigQuery.Storage.V1/synth.metadata
Expand Up @@ -4,7 +4,7 @@
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "7272af32a96a42fe5bb9452360e32ae95718abc2"
"sha": "07460951fc07dd2b3f172d01b04e2a5fefd13ccc"
}
}
]
Expand Down
Expand Up @@ -506,6 +506,11 @@ private BigtableInstanceAdminClient BuildImpl()
}

/// <summary>BigtableInstanceAdmin client wrapper, for convenient use.</summary>
/// <remarks>
/// Service for creating, configuring, and deleting Cloud Bigtable Instances and
/// Clusters. Provides access to the Instance and Cluster schemas only, not the
/// tables' metadata or data stored in those tables.
/// </remarks>
public abstract partial class BigtableInstanceAdminClient
{
/// <summary>
Expand Down Expand Up @@ -3018,6 +3023,11 @@ internal static BigtableInstanceAdminClient Create(grpccore::CallInvoker callInv
}

/// <summary>BigtableInstanceAdmin client wrapper implementation, for convenient use.</summary>
/// <remarks>
/// Service for creating, configuring, and deleting Cloud Bigtable Instances and
/// Clusters. Provides access to the Instance and Cluster schemas only, not the
/// tables' metadata or data stored in those tables.
/// </remarks>
public sealed partial class BigtableInstanceAdminClientImpl : BigtableInstanceAdminClient
{
private readonly gaxgrpc::ApiCall<CreateInstanceRequest, lro::Operation> _callCreateInstance;
Expand Down
Expand Up @@ -507,6 +507,13 @@ private BigtableTableAdminClient BuildImpl()
}

/// <summary>BigtableTableAdmin client wrapper, for convenient use.</summary>
/// <remarks>
/// Service for creating, configuring, and deleting Cloud Bigtable tables.
///
///
/// Provides access to the table schemas only, not the data stored within
/// the tables.
/// </remarks>
public abstract partial class BigtableTableAdminClient
{
/// <summary>
Expand Down Expand Up @@ -4014,6 +4021,13 @@ internal static BigtableTableAdminClient Create(grpccore::CallInvoker callInvoke
}

/// <summary>BigtableTableAdmin client wrapper implementation, for convenient use.</summary>
/// <remarks>
/// Service for creating, configuring, and deleting Cloud Bigtable tables.
///
///
/// Provides access to the table schemas only, not the data stored within
/// the tables.
/// </remarks>
public sealed partial class BigtableTableAdminClientImpl : BigtableTableAdminClient
{
private readonly gaxgrpc::ApiCall<CreateTableRequest, Table> _callCreateTable;
Expand Down
2 changes: 1 addition & 1 deletion apis/Google.Cloud.Bigtable.Admin.V2/synth.metadata
Expand Up @@ -4,7 +4,7 @@
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "7272af32a96a42fe5bb9452360e32ae95718abc2"
"sha": "07460951fc07dd2b3f172d01b04e2a5fefd13ccc"
}
}
]
Expand Down
Expand Up @@ -33,6 +33,9 @@
namespace Google.Cloud.Bigtable.V2
{
/// <summary>BigtableServiceApi client wrapper, for convenient use.</summary>
/// <remarks>
/// Service for reading from and writing to existing Bigtable tables.
/// </remarks>
public partial class BigtableClient
{
/// <summary>Streams back the contents of all requested rows in key order, optionally applying the same Reader filter to each.</summary>
Expand Down Expand Up @@ -270,6 +273,9 @@ public partial class BigtableClient
}

/// <summary>BigtableServiceApi client wrapper, for convenient use.</summary>
/// <remarks>
/// Service for reading from and writing to existing Bigtable tables.
/// </remarks>
public sealed partial class BigtableClientImpl : BigtableClient
{
/// <inheritdoc/>
Expand Down
Expand Up @@ -195,6 +195,9 @@ private BigtableServiceApiClient BuildImpl()
}

/// <summary>BigtableServiceApi client wrapper, for convenient use.</summary>
/// <remarks>
/// Service for reading from and writing to existing Bigtable tables.
/// </remarks>
public abstract partial class BigtableServiceApiClient
{
/// <summary>
Expand Down Expand Up @@ -2069,6 +2072,9 @@ public abstract partial class MutateRowsStream : gaxgrpc::ServerStreamingBase<Mu
}

/// <summary>BigtableServiceApi client wrapper implementation, for convenient use.</summary>
/// <remarks>
/// Service for reading from and writing to existing Bigtable tables.
/// </remarks>
public sealed partial class BigtableServiceApiClientImpl : BigtableServiceApiClient
{
private readonly gaxgrpc::ApiServerStreamingCall<ReadRowsRequest, ReadRowsResponse> _callReadRows;
Expand Down
2 changes: 1 addition & 1 deletion apis/Google.Cloud.Bigtable.V2/synth.metadata
Expand Up @@ -4,7 +4,7 @@
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "7272af32a96a42fe5bb9452360e32ae95718abc2"
"sha": "07460951fc07dd2b3f172d01b04e2a5fefd13ccc"
}
}
]
Expand Down
Expand Up @@ -272,6 +272,9 @@ private CloudBillingClient BuildImpl()
}

/// <summary>CloudBilling client wrapper, for convenient use.</summary>
/// <remarks>
/// Retrieves GCP Console billing accounts and associates them with projects.
/// </remarks>
public abstract partial class CloudBillingClient
{
/// <summary>
Expand Down Expand Up @@ -1838,6 +1841,9 @@ internal static CloudBillingClient Create(grpccore::CallInvoker callInvoker, Clo
}

/// <summary>CloudBilling client wrapper implementation, for convenient use.</summary>
/// <remarks>
/// Retrieves GCP Console billing accounts and associates them with projects.
/// </remarks>
public sealed partial class CloudBillingClientImpl : CloudBillingClient
{
private readonly gaxgrpc::ApiCall<GetBillingAccountRequest, BillingAccount> _callGetBillingAccount;
Expand Down

0 comments on commit 6bde7a3

Please sign in to comment.