Skip to content

Commit

Permalink
chore: update v2.12.0 gapic-generator-typescript (#520)
Browse files Browse the repository at this point in the history 
- [ ] Regenerate this pull request now.

Committer: @summer-ji-eng
PiperOrigin-RevId: 424244721

Source-Link: googleapis/googleapis@4b6b01f

Source-Link: googleapis/googleapis-gen@8ac83fb
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOGFjODNmYmE2MDZkMDA4YzdlOGE0MmU3ZDU1YjY1OTZlYzRiZTM1ZiJ9
@gcf-owl-bot
gcf-owl-bot[bot] authored Jan 26, 2022
1 parent 7412141 commit c9fa9a6
Showing 30 changed files with 1,201 additions and 90 deletions.
4 changes: 2 additions & 2 deletions packages/google-cloud-bigquery-datatransfer/.jsdoc.js
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright 2021 Google LLC
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
@@ -40,7 +40,7 @@ module.exports = {
includePattern: '\\.js$'
},
templates: {
copyright: 'Copyright 2021 Google LLC',
copyright: 'Copyright 2022 Google LLC',
includeDate: false,
sourceFiles: false,
systemName: '@google-cloud/bigquery-data-transfer',
10 changes: 8 additions & 2 deletions packages/google-cloud-bigquery-datatransfer/linkinator.config.json
View file
Original file line number Diff line number Diff line change
@@ -3,8 +3,14 @@
"skip": [
"https://codecov.io/gh/googleapis/",
"www.googleapis.com",
"img.shields.io"
"img.shields.io",
"https://console.cloud.google.com/cloudshell",
"https://support.google.com"
],
"silent": true,
"concurrency": 5
"concurrency": 5,
"retry": true,
"retryErrors": true,
"retryErrorsCount": 5,
"retryErrorsJitter": 3000
}
72 changes: 42 additions & 30 deletions ...oud-bigquery-datatransfer/protos/google/cloud/bigquery/datatransfer/v1/datatransfer.proto
View file
Original file line number Diff line number Diff line change
@@ -35,16 +35,12 @@ option java_package = "com.google.cloud.bigquery.datatransfer.v1";
option php_namespace = "Google\\Cloud\\BigQuery\\DataTransfer\\V1";
option ruby_package = "Google::Cloud::Bigquery::DataTransfer::V1";

// 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.
// This API allows users to manage their data transfers into BigQuery.
service DataTransferService {
option (google.api.default_host) = "bigquerydatatransfer.googleapis.com";
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";

// Retrieves a supported data source and returns its settings,
// which can be used for UI rendering.
// Retrieves a supported data source and returns its settings.
rpc GetDataSource(GetDataSourceRequest) returns (DataSource) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/dataSources/*}"
@@ -55,8 +51,7 @@ service DataTransferService {
option (google.api.method_signature) = "name";
}

// Lists supported data sources and returns their settings,
// which can be used for UI rendering.
// Lists supported data sources and returns their settings.
rpc ListDataSources(ListDataSourcesRequest) returns (ListDataSourcesResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/dataSources"
@@ -94,8 +89,8 @@ service DataTransferService {
option (google.api.method_signature) = "transfer_config,update_mask";
}

// Deletes a data transfer configuration,
// including any associated transfer runs and logs.
// Deletes a data transfer configuration, including any associated transfer
// runs and logs.
rpc DeleteTransferConfig(DeleteTransferConfigRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/transferConfigs/*}"
@@ -184,7 +179,7 @@ service DataTransferService {
option (google.api.method_signature) = "name";
}

// Returns information about running and completed jobs.
// Returns information about running and completed transfer runs.
rpc ListTransferRuns(ListTransferRunsRequest) returns (ListTransferRunsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/transferConfigs/*}/runs"
@@ -195,7 +190,7 @@ service DataTransferService {
option (google.api.method_signature) = "parent";
}

// Returns user facing log messages for the data transfer run.
// Returns log messages for the transfer run.
rpc ListTransferLogs(ListTransferLogsRequest) returns (ListTransferLogsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/transferConfigs/*/runs/*}/transferLogs"
@@ -208,10 +203,6 @@ service DataTransferService {

// Returns true if valid credentials exist for the given data source and
// requesting user.
// Some data sources doesn't support service account, so we need to talk to
// them on behalf of the end user. This API just checks whether we have OAuth
// token for the particular user, which is a pre-requisite before user can
// create a transfer config.
rpc CheckValidCreds(CheckValidCredsRequest) returns (CheckValidCredsResponse) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/dataSources/*}:checkValidCreds"
@@ -223,14 +214,26 @@ service DataTransferService {
};
option (google.api.method_signature) = "name";
}

// Enroll data sources in a user project. This allows users to create transfer
// configurations for these data sources. They will also appear in the
// ListDataSources RPC and as such, will appear in the BigQuery UI
// 'https://bigquery.cloud.google.com' (and the documents can be found at
// https://cloud.google.com/bigquery/bigquery-web-ui and
// https://cloud.google.com/bigquery/docs/working-with-transfers).
rpc EnrollDataSources(EnrollDataSourcesRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*}:enrollDataSources"
body: "*"
additional_bindings {
post: "/v1/{name=projects/*}:enrollDataSources"
body: "*"
}
};
}
}

// Represents a data source parameter with validation rules, so that
// parameters can be rendered in the UI. These parameters are given to us by
// supported data sources, and include all needed information for rendering
// and validation.
// Thus, whoever uses this api can decide to generate either generic ui,
// or custom data source specific forms.
// A parameter used to define custom fields in a data source definition.
message DataSourceParameter {
// Parameter type.
enum Type {
@@ -308,8 +311,7 @@ message DataSourceParameter {
bool deprecated = 20;
}

// Represents data source metadata. Metadata is sufficient to
// render UI and request proper OAuth tokens.
// Defines the properties and custom parameters for a data source.
message DataSource {
option (google.api.resource) = {
type: "bigquerydatatransfer.googleapis.com/DataSource"
@@ -470,9 +472,9 @@ message ListDataSourcesResponse {
// A request to create a data transfer configuration. If new credentials are
// needed for this transfer configuration, an authorization code must be
// provided. If an authorization code is provided, the transfer configuration
// will be associated with the user id corresponding to the
// authorization code. Otherwise, the transfer configuration will be associated
// with the calling user.
// will be associated with the user id corresponding to the authorization code.
// Otherwise, the transfer configuration will be associated with the calling
// user.
message CreateTransferConfigRequest {
// Required. The BigQuery project id where the transfer configuration should be created.
// Must be in the format projects/{project_id}/locations/{location_id} or
@@ -655,9 +657,7 @@ message ListTransferConfigsResponse {
string next_page_token = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
}

// A request to list data transfer runs. UI can use this method to show/filter
// specific data transfer runs. The data source can use this method to request
// all scheduled transfer runs.
// A request to list data transfer runs.
message ListTransferRunsRequest {
// Represents which runs should be pulled.
enum RunAttempt {
@@ -840,3 +840,15 @@ message StartManualTransferRunsResponse {
// The transfer runs that were created.
repeated TransferRun runs = 1;
}

// A request to enroll a set of data sources so they are visible in the
// BigQuery UI's `Transfer` tab.
message EnrollDataSourcesRequest {
// The name of the project resource in the form:
// `projects/{project_id}`
string name = 1;

// Data sources that are enrolled. It is required to provide at least one
// data source id.
repeated string data_source_ids = 2;
}
15 changes: 14 additions & 1 deletion ...e-cloud-bigquery-datatransfer/protos/google/cloud/bigquery/datatransfer/v1/transfer.proto
View file
Original file line number Diff line number Diff line change
@@ -98,6 +98,12 @@ message ScheduleOptions {
google.protobuf.Timestamp end_time = 2;
}

// Information about a user.
message UserInfo {
// E-mail address of the user.
optional string email = 1;
}

// Represents a data transfer configuration. A transfer configuration
// contains all metadata needed to perform a data transfer. For example,
// `destination_dataset_id` specifies where data should be stored.
@@ -148,7 +154,9 @@ message TransferConfig {
// `first sunday of quarter 00:00`.
// See more explanation about the format here:
// https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
// NOTE: the granularity should be at least 8 hours, or less frequent.
//
// NOTE: The minimum interval time between recurring transfers depends on the
// data source; refer to the documentation for your data source.
string schedule = 7;

// Options customizing the data transfer schedule.
@@ -191,6 +199,11 @@ message TransferConfig {
// Email notifications will be sent according to these preferences
// to the email address of the user who owns this transfer config.
EmailPreferences email_preferences = 18;

// Output only. Information about the user whose credentials are used to transfer data.
// Populated only for `transferConfigs.get` requests. In case the user
// information is not available, this field will not be populated.
optional UserInfo owner_info = 27 [(google.api.field_behavior) = OUTPUT_ONLY];
}

// Represents a data transfer run.
Loading

0 comments on commit c9fa9a6

Please sign in to comment.