diff --git a/google-cloud-bigquerydatatransfer/src/main/java/com/google/cloud/bigquery/datatransfer/v1/DataTransferServiceClient.java b/google-cloud-bigquerydatatransfer/src/main/java/com/google/cloud/bigquery/datatransfer/v1/DataTransferServiceClient.java index 69842f4b..72995595 100644 --- a/google-cloud-bigquerydatatransfer/src/main/java/com/google/cloud/bigquery/datatransfer/v1/DataTransferServiceClient.java +++ b/google-cloud-bigquerydatatransfer/src/main/java/com/google/cloud/bigquery/datatransfer/v1/DataTransferServiceClient.java @@ -46,6 +46,13 @@ *
This class provides the ability to make remote calls to the backing service through method * calls that map to API methods. Sample code to get started: * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * DataSourceName name = DataSourceName.ofProjectDataSourceName("[PROJECT]", "[DATA_SOURCE]"); + * DataSource response = dataTransferServiceClient.getDataSource(name); + * } + * }+ * *
Note: close() needs to be called on the DataTransferServiceClient object to clean up resources * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). @@ -152,6 +159,15 @@ public DataTransferServiceStub getStub() { /** * Retrieves a supported data source and returns its settings, which can be used for UI rendering. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * DataSourceName name = DataSourceName.ofProjectDataSourceName("[PROJECT]", "[DATA_SOURCE]"); + * DataSource response = dataTransferServiceClient.getDataSource(name); + * } + * }+ * * @param name Required. The field will contain name of the resource requested, for example: * `projects/{project_id}/dataSources/{data_source_id}` or * `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}` @@ -167,6 +183,15 @@ public final DataSource getDataSource(DataSourceName name) { /** * Retrieves a supported data source and returns its settings, which can be used for UI rendering. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * String name = DataSourceName.ofProjectDataSourceName("[PROJECT]", "[DATA_SOURCE]").toString(); + * DataSource response = dataTransferServiceClient.getDataSource(name); + * } + * }+ * * @param name Required. The field will contain name of the resource requested, for example: * `projects/{project_id}/dataSources/{data_source_id}` or * `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}` @@ -181,6 +206,19 @@ public final DataSource getDataSource(String name) { /** * Retrieves a supported data source and returns its settings, which can be used for UI rendering. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * GetDataSourceRequest request = + * GetDataSourceRequest.newBuilder() + * .setName( + * DataSourceName.ofProjectDataSourceName("[PROJECT]", "[DATA_SOURCE]").toString()) + * .build(); + * DataSource response = dataTransferServiceClient.getDataSource(request); + * } + * }+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -193,6 +231,20 @@ public final DataSource getDataSource(GetDataSourceRequest request) { * Retrieves a supported data source and returns its settings, which can be used for UI rendering. * *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * GetDataSourceRequest request = + * GetDataSourceRequest.newBuilder() + * .setName( + * DataSourceName.ofProjectDataSourceName("[PROJECT]", "[DATA_SOURCE]").toString()) + * .build(); + * ApiFuture*/ public final UnaryCallablefuture = + * dataTransferServiceClient.getDataSourceCallable().futureCall(request); + * // Do something. + * DataSource response = future.get(); + * } + * }
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); + * for (DataSource element : dataTransferServiceClient.listDataSources(parent).iterateAll()) { + * // doThingsWith(element); + * } + * } + * }+ * * @param parent Required. The BigQuery project id for which data sources should be returned. Must * be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id} * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -218,6 +281,17 @@ public final ListDataSourcesPagedResponse listDataSources(LocationName parent) { /** * Lists supported data sources and returns their settings, which can be used for UI rendering. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * ProjectName parent = ProjectName.of("[PROJECT]"); + * for (DataSource element : dataTransferServiceClient.listDataSources(parent).iterateAll()) { + * // doThingsWith(element); + * } + * } + * }+ * * @param parent Required. The BigQuery project id for which data sources should be returned. Must * be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id} * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -234,6 +308,18 @@ public final ListDataSourcesPagedResponse listDataSources(ProjectName parent) { /** * Lists supported data sources and returns their settings, which can be used for UI rendering. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * String parent = + * DataSourceName.ofProjectDataSourceName("[PROJECT]", "[DATA_SOURCE]").toString(); + * for (DataSource element : dataTransferServiceClient.listDataSources(parent).iterateAll()) { + * // doThingsWith(element); + * } + * } + * }+ * * @param parent Required. The BigQuery project id for which data sources should be returned. Must * be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id} * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -247,6 +333,23 @@ public final ListDataSourcesPagedResponse listDataSources(String parent) { /** * Lists supported data sources and returns their settings, which can be used for UI rendering. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * ListDataSourcesRequest request = + * ListDataSourcesRequest.newBuilder() + * .setParent( + * DataSourceName.ofProjectDataSourceName("[PROJECT]", "[DATA_SOURCE]").toString()) + * .setPageToken("pageToken873572522") + * .setPageSize(883849137) + * .build(); + * for (DataSource element : dataTransferServiceClient.listDataSources(request).iterateAll()) { + * // doThingsWith(element); + * } + * } + * }+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -259,6 +362,24 @@ public final ListDataSourcesPagedResponse listDataSources(ListDataSourcesRequest * Lists supported data sources and returns their settings, which can be used for UI rendering. * *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * ListDataSourcesRequest request = + * ListDataSourcesRequest.newBuilder() + * .setParent( + * DataSourceName.ofProjectDataSourceName("[PROJECT]", "[DATA_SOURCE]").toString()) + * .setPageToken("pageToken873572522") + * .setPageSize(883849137) + * .build(); + * ApiFuture*/ public final UnaryCallablefuture = + * dataTransferServiceClient.listDataSourcesPagedCallable().futureCall(request); + * // Do something. + * for (DataSource element : future.get().iterateAll()) { + * // doThingsWith(element); + * } + * } + * }
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * while (true) { + * ListDataSourcesResponse response = + * dataTransferServiceClient.listDataSourcesCallable().call(request); + * for (DataSource element : response.getResponsesList()) { + * // doThingsWith(element); + * } + * String nextPageToken = response.getNextPageToken(); + * if (!Strings.isNullOrEmpty(nextPageToken)) { + * request = request.toBuilder().setPageToken(nextPageToken).build(); + * } else { + * break; + * } + * } + * } + * }*/ public final UnaryCallable
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); + * TransferConfig transferConfig = TransferConfig.newBuilder().build(); + * TransferConfig response = + * dataTransferServiceClient.createTransferConfig(parent, transferConfig); + * } + * }+ * * @param parent Required. The BigQuery project id where the transfer configuration should be * created. Must be in the format projects/{project_id}/locations/{location_id} or * projects/{project_id}. If specified location and location of the destination bigquery @@ -301,6 +451,17 @@ public final TransferConfig createTransferConfig( /** * Creates a new data transfer configuration. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * ProjectName parent = ProjectName.of("[PROJECT]"); + * TransferConfig transferConfig = TransferConfig.newBuilder().build(); + * TransferConfig response = + * dataTransferServiceClient.createTransferConfig(parent, transferConfig); + * } + * }+ * * @param parent Required. The BigQuery project id where the transfer configuration should be * created. Must be in the format projects/{project_id}/locations/{location_id} or * projects/{project_id}. If specified location and location of the destination bigquery @@ -322,6 +483,19 @@ public final TransferConfig createTransferConfig( /** * Creates a new data transfer configuration. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * String parent = + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]") + * .toString(); + * TransferConfig transferConfig = TransferConfig.newBuilder().build(); + * TransferConfig response = + * dataTransferServiceClient.createTransferConfig(parent, transferConfig); + * } + * }+ * * @param parent Required. The BigQuery project id where the transfer configuration should be * created. Must be in the format projects/{project_id}/locations/{location_id} or * projects/{project_id}. If specified location and location of the destination bigquery @@ -342,6 +516,24 @@ public final TransferConfig createTransferConfig(String parent, TransferConfig t /** * Creates a new data transfer configuration. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * CreateTransferConfigRequest request = + * CreateTransferConfigRequest.newBuilder() + * .setParent( + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]") + * .toString()) + * .setTransferConfig(TransferConfig.newBuilder().build()) + * .setAuthorizationCode("authorizationCode742596102") + * .setVersionInfo("versionInfo688769446") + * .setServiceAccountName("serviceAccountName2137368675") + * .build(); + * TransferConfig response = dataTransferServiceClient.createTransferConfig(request); + * } + * }+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -354,6 +546,25 @@ public final TransferConfig createTransferConfig(CreateTransferConfigRequest req * Creates a new data transfer configuration. * *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * CreateTransferConfigRequest request = + * CreateTransferConfigRequest.newBuilder() + * .setParent( + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]") + * .toString()) + * .setTransferConfig(TransferConfig.newBuilder().build()) + * .setAuthorizationCode("authorizationCode742596102") + * .setVersionInfo("versionInfo688769446") + * .setServiceAccountName("serviceAccountName2137368675") + * .build(); + * ApiFuture*/ public final UnaryCallablefuture = + * dataTransferServiceClient.createTransferConfigCallable().futureCall(request); + * // Do something. + * TransferConfig response = future.get(); + * } + * }
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * TransferConfig transferConfig = TransferConfig.newBuilder().build(); + * FieldMask updateMask = FieldMask.newBuilder().build(); + * TransferConfig response = + * dataTransferServiceClient.updateTransferConfig(transferConfig, updateMask); + * } + * }+ * * @param transferConfig Required. Data transfer configuration to create. * @param updateMask Required. Required list of fields to be updated in this request. * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -382,6 +604,22 @@ public final TransferConfig updateTransferConfig( /** * Updates a data transfer configuration. All fields must be set, even if they are not updated. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * UpdateTransferConfigRequest request = + * UpdateTransferConfigRequest.newBuilder() + * .setTransferConfig(TransferConfig.newBuilder().build()) + * .setAuthorizationCode("authorizationCode742596102") + * .setUpdateMask(FieldMask.newBuilder().build()) + * .setVersionInfo("versionInfo688769446") + * .setServiceAccountName("serviceAccountName2137368675") + * .build(); + * TransferConfig response = dataTransferServiceClient.updateTransferConfig(request); + * } + * }+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -394,6 +632,23 @@ public final TransferConfig updateTransferConfig(UpdateTransferConfigRequest req * Updates a data transfer configuration. All fields must be set, even if they are not updated. * *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * UpdateTransferConfigRequest request = + * UpdateTransferConfigRequest.newBuilder() + * .setTransferConfig(TransferConfig.newBuilder().build()) + * .setAuthorizationCode("authorizationCode742596102") + * .setUpdateMask(FieldMask.newBuilder().build()) + * .setVersionInfo("versionInfo688769446") + * .setServiceAccountName("serviceAccountName2137368675") + * .build(); + * ApiFuture*/ public final UnaryCallablefuture = + * dataTransferServiceClient.updateTransferConfigCallable().futureCall(request); + * // Do something. + * TransferConfig response = future.get(); + * } + * }
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * TransferConfigName name = + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]"); + * dataTransferServiceClient.deleteTransferConfig(name); + * } + * }+ * * @param name Required. The field will contain name of the resource requested, for example: * `projects/{project_id}/transferConfigs/{config_id}` or * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` @@ -421,6 +686,17 @@ public final void deleteTransferConfig(TransferConfigName name) { /** * Deletes a data transfer configuration, including any associated transfer runs and logs. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * String name = + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]") + * .toString(); + * dataTransferServiceClient.deleteTransferConfig(name); + * } + * }+ * * @param name Required. The field will contain name of the resource requested, for example: * `projects/{project_id}/transferConfigs/{config_id}` or * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` @@ -436,6 +712,20 @@ public final void deleteTransferConfig(String name) { /** * Deletes a data transfer configuration, including any associated transfer runs and logs. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * DeleteTransferConfigRequest request = + * DeleteTransferConfigRequest.newBuilder() + * .setName( + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]") + * .toString()) + * .build(); + * dataTransferServiceClient.deleteTransferConfig(request); + * } + * }+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -448,6 +738,21 @@ public final void deleteTransferConfig(DeleteTransferConfigRequest request) { * Deletes a data transfer configuration, including any associated transfer runs and logs. * *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * DeleteTransferConfigRequest request = + * DeleteTransferConfigRequest.newBuilder() + * .setName( + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]") + * .toString()) + * .build(); + * ApiFuture*/ public final UnaryCallablefuture = + * dataTransferServiceClient.deleteTransferConfigCallable().futureCall(request); + * // Do something. + * future.get(); + * } + * }
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * TransferConfigName name = + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]"); + * TransferConfig response = dataTransferServiceClient.getTransferConfig(name); + * } + * }+ * * @param name Required. The field will contain name of the resource requested, for example: * `projects/{project_id}/transferConfigs/{config_id}` or * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` @@ -474,6 +789,17 @@ public final TransferConfig getTransferConfig(TransferConfigName name) { /** * Returns information about a data transfer config. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * String name = + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]") + * .toString(); + * TransferConfig response = dataTransferServiceClient.getTransferConfig(name); + * } + * }+ * * @param name Required. The field will contain name of the resource requested, for example: * `projects/{project_id}/transferConfigs/{config_id}` or * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` @@ -488,6 +814,20 @@ public final TransferConfig getTransferConfig(String name) { /** * Returns information about a data transfer config. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * GetTransferConfigRequest request = + * GetTransferConfigRequest.newBuilder() + * .setName( + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]") + * .toString()) + * .build(); + * TransferConfig response = dataTransferServiceClient.getTransferConfig(request); + * } + * }+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -500,6 +840,21 @@ public final TransferConfig getTransferConfig(GetTransferConfigRequest request) * Returns information about a data transfer config. * *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * GetTransferConfigRequest request = + * GetTransferConfigRequest.newBuilder() + * .setName( + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]") + * .toString()) + * .build(); + * ApiFuture*/ public final UnaryCallablefuture = + * dataTransferServiceClient.getTransferConfigCallable().futureCall(request); + * // Do something. + * TransferConfig response = future.get(); + * } + * }
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]"); + * for (TransferConfig element : + * dataTransferServiceClient.listTransferConfigs(parent).iterateAll()) { + * // doThingsWith(element); + * } + * } + * }+ * * @param parent Required. The BigQuery project id for which data sources should be returned: * `projects/{project_id}` or `projects/{project_id}/locations/{location_id}` * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -525,6 +892,18 @@ public final ListTransferConfigsPagedResponse listTransferConfigs(LocationName p /** * Returns information about all data transfers in the project. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * ProjectName parent = ProjectName.of("[PROJECT]"); + * for (TransferConfig element : + * dataTransferServiceClient.listTransferConfigs(parent).iterateAll()) { + * // doThingsWith(element); + * } + * } + * }+ * * @param parent Required. The BigQuery project id for which data sources should be returned: * `projects/{project_id}` or `projects/{project_id}/locations/{location_id}` * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -541,6 +920,20 @@ public final ListTransferConfigsPagedResponse listTransferConfigs(ProjectName pa /** * Returns information about all data transfers in the project. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * String parent = + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]") + * .toString(); + * for (TransferConfig element : + * dataTransferServiceClient.listTransferConfigs(parent).iterateAll()) { + * // doThingsWith(element); + * } + * } + * }+ * * @param parent Required. The BigQuery project id for which data sources should be returned: * `projects/{project_id}` or `projects/{project_id}/locations/{location_id}` * @throws com.google.api.gax.rpc.ApiException if the remote call fails @@ -555,6 +948,26 @@ public final ListTransferConfigsPagedResponse listTransferConfigs(String parent) /** * Returns information about all data transfers in the project. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * ListTransferConfigsRequest request = + * ListTransferConfigsRequest.newBuilder() + * .setParent( + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]") + * .toString()) + * .addAllDataSourceIds(new ArrayList+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -568,6 +981,26 @@ public final ListTransferConfigsPagedResponse listTransferConfigs( * Returns information about all data transfers in the project. * *()) + * .setPageToken("pageToken873572522") + * .setPageSize(883849137) + * .build(); + * for (TransferConfig element : + * dataTransferServiceClient.listTransferConfigs(request).iterateAll()) { + * // doThingsWith(element); + * } + * } + * }
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * ListTransferConfigsRequest request = + * ListTransferConfigsRequest.newBuilder() + * .setParent( + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]") + * .toString()) + * .addAllDataSourceIds(new ArrayList*/ public final UnaryCallable()) + * .setPageToken("pageToken873572522") + * .setPageSize(883849137) + * .build(); + * ApiFuture future = + * dataTransferServiceClient.listTransferConfigsPagedCallable().futureCall(request); + * // Do something. + * for (TransferConfig element : future.get().iterateAll()) { + * // doThingsWith(element); + * } + * } + * }
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * while (true) { + * ListTransferConfigsResponse response = + * dataTransferServiceClient.listTransferConfigsCallable().call(request); + * for (TransferConfig element : response.getResponsesList()) { + * // doThingsWith(element); + * } + * String nextPageToken = response.getNextPageToken(); + * if (!Strings.isNullOrEmpty(nextPageToken)) { + * request = request.toBuilder().setPageToken(nextPageToken).build(); + * } else { + * break; + * } + * } + * } + * }*/ public final UnaryCallable
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * TransferConfigName parent = + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]"); + * Timestamp startTime = Timestamp.newBuilder().build(); + * Timestamp endTime = Timestamp.newBuilder().build(); + * ScheduleTransferRunsResponse response = + * dataTransferServiceClient.scheduleTransferRuns(parent, startTime, endTime); + * } + * }+ * * @param parent Required. Transfer configuration name in the form: * `projects/{project_id}/transferConfigs/{config_id}` or * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. @@ -619,6 +1083,20 @@ public final ScheduleTransferRunsResponse scheduleTransferRuns( * runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns * instead. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * String parent = + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]") + * .toString(); + * Timestamp startTime = Timestamp.newBuilder().build(); + * Timestamp endTime = Timestamp.newBuilder().build(); + * ScheduleTransferRunsResponse response = + * dataTransferServiceClient.scheduleTransferRuns(parent, startTime, endTime); + * } + * }+ * * @param parent Required. Transfer configuration name in the form: * `projects/{project_id}/transferConfigs/{config_id}` or * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. @@ -646,6 +1124,23 @@ public final ScheduleTransferRunsResponse scheduleTransferRuns( * runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns * instead. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * ScheduleTransferRunsRequest request = + * ScheduleTransferRunsRequest.newBuilder() + * .setParent( + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]") + * .toString()) + * .setStartTime(Timestamp.newBuilder().build()) + * .setEndTime(Timestamp.newBuilder().build()) + * .build(); + * ScheduleTransferRunsResponse response = + * dataTransferServiceClient.scheduleTransferRuns(request); + * } + * }+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -662,6 +1157,23 @@ public final ScheduleTransferRunsResponse scheduleTransferRuns( * instead. * *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * ScheduleTransferRunsRequest request = + * ScheduleTransferRunsRequest.newBuilder() + * .setParent( + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]") + * .toString()) + * .setStartTime(Timestamp.newBuilder().build()) + * .setEndTime(Timestamp.newBuilder().build()) + * .build(); + * ApiFuture*/ public final UnaryCallablefuture = + * dataTransferServiceClient.scheduleTransferRunsCallable().futureCall(request); + * // Do something. + * ScheduleTransferRunsResponse response = future.get(); + * } + * }
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * StartManualTransferRunsRequest request = + * StartManualTransferRunsRequest.newBuilder() + * .setParent( + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]") + * .toString()) + * .build(); + * StartManualTransferRunsResponse response = + * dataTransferServiceClient.startManualTransferRuns(request); + * } + * }+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -689,6 +1216,21 @@ public final StartManualTransferRunsResponse startManualTransferRuns( * (inclusive) and end_time (exclusive), or for a specific run_time. * *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * StartManualTransferRunsRequest request = + * StartManualTransferRunsRequest.newBuilder() + * .setParent( + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]") + * .toString()) + * .build(); + * ApiFuture*/ public final UnaryCallablefuture = + * dataTransferServiceClient.startManualTransferRunsCallable().futureCall(request); + * // Do something. + * StartManualTransferRunsResponse response = future.get(); + * } + * }
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * RunName name = + * RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]"); + * TransferRun response = dataTransferServiceClient.getTransferRun(name); + * } + * }+ * * @param name Required. The field will contain name of the resource requested, for example: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` @@ -714,6 +1266,17 @@ public final TransferRun getTransferRun(RunName name) { /** * Returns information about the particular transfer run. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * String name = + * RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]") + * .toString(); + * TransferRun response = dataTransferServiceClient.getTransferRun(name); + * } + * }+ * * @param name Required. The field will contain name of the resource requested, for example: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` @@ -728,6 +1291,20 @@ public final TransferRun getTransferRun(String name) { /** * Returns information about the particular transfer run. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * GetTransferRunRequest request = + * GetTransferRunRequest.newBuilder() + * .setName( + * RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]") + * .toString()) + * .build(); + * TransferRun response = dataTransferServiceClient.getTransferRun(request); + * } + * }+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -740,6 +1317,21 @@ public final TransferRun getTransferRun(GetTransferRunRequest request) { * Returns information about the particular transfer run. * *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * GetTransferRunRequest request = + * GetTransferRunRequest.newBuilder() + * .setName( + * RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]") + * .toString()) + * .build(); + * ApiFuture*/ public final UnaryCallablefuture = + * dataTransferServiceClient.getTransferRunCallable().futureCall(request); + * // Do something. + * TransferRun response = future.get(); + * } + * }
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * RunName name = + * RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]"); + * dataTransferServiceClient.deleteTransferRun(name); + * } + * }+ * * @param name Required. The field will contain name of the resource requested, for example: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` @@ -766,6 +1368,17 @@ public final void deleteTransferRun(RunName name) { /** * Deletes the specified transfer run. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * String name = + * RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]") + * .toString(); + * dataTransferServiceClient.deleteTransferRun(name); + * } + * }+ * * @param name Required. The field will contain name of the resource requested, for example: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` @@ -780,6 +1393,20 @@ public final void deleteTransferRun(String name) { /** * Deletes the specified transfer run. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * DeleteTransferRunRequest request = + * DeleteTransferRunRequest.newBuilder() + * .setName( + * RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]") + * .toString()) + * .build(); + * dataTransferServiceClient.deleteTransferRun(request); + * } + * }+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -792,6 +1419,21 @@ public final void deleteTransferRun(DeleteTransferRunRequest request) { * Deletes the specified transfer run. * *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * DeleteTransferRunRequest request = + * DeleteTransferRunRequest.newBuilder() + * .setName( + * RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]") + * .toString()) + * .build(); + * ApiFuture*/ public final UnaryCallablefuture = + * dataTransferServiceClient.deleteTransferRunCallable().futureCall(request); + * // Do something. + * future.get(); + * } + * }
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * TransferConfigName parent = + * TransferConfigName.ofProjectTransferConfigName("[PROJECT]", "[TRANSFER_CONFIG]"); + * for (TransferRun element : dataTransferServiceClient.listTransferRuns(parent).iterateAll()) { + * // doThingsWith(element); + * } + * } + * }+ * * @param parent Required. Name of transfer configuration for which transfer runs should be * retrieved. Format of transfer configuration resource name is: * `projects/{project_id}/transferConfigs/{config_id}` or @@ -819,6 +1473,19 @@ public final ListTransferRunsPagedResponse listTransferRuns(TransferConfigName p /** * Returns information about running and completed jobs. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * String parent = + * RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]") + * .toString(); + * for (TransferRun element : dataTransferServiceClient.listTransferRuns(parent).iterateAll()) { + * // doThingsWith(element); + * } + * } + * }+ * * @param parent Required. Name of transfer configuration for which transfer runs should be * retrieved. Format of transfer configuration resource name is: * `projects/{project_id}/transferConfigs/{config_id}` or @@ -835,6 +1502,25 @@ public final ListTransferRunsPagedResponse listTransferRuns(String parent) { /** * Returns information about running and completed jobs. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * ListTransferRunsRequest request = + * ListTransferRunsRequest.newBuilder() + * .setParent( + * RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]") + * .toString()) + * .addAllStates(new ArrayList+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -847,6 +1533,26 @@ public final ListTransferRunsPagedResponse listTransferRuns(ListTransferRunsRequ * Returns information about running and completed jobs. * *()) + * .setPageToken("pageToken873572522") + * .setPageSize(883849137) + * .build(); + * for (TransferRun element : dataTransferServiceClient.listTransferRuns(request).iterateAll()) { + * // doThingsWith(element); + * } + * } + * }
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * ListTransferRunsRequest request = + * ListTransferRunsRequest.newBuilder() + * .setParent( + * RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]") + * .toString()) + * .addAllStates(new ArrayList*/ public final UnaryCallable()) + * .setPageToken("pageToken873572522") + * .setPageSize(883849137) + * .build(); + * ApiFuture future = + * dataTransferServiceClient.listTransferRunsPagedCallable().futureCall(request); + * // Do something. + * for (TransferRun element : future.get().iterateAll()) { + * // doThingsWith(element); + * } + * } + * }
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * while (true) { + * ListTransferRunsResponse response = + * dataTransferServiceClient.listTransferRunsCallable().call(request); + * for (TransferRun element : response.getResponsesList()) { + * // doThingsWith(element); + * } + * String nextPageToken = response.getNextPageToken(); + * if (!Strings.isNullOrEmpty(nextPageToken)) { + * request = request.toBuilder().setPageToken(nextPageToken).build(); + * } else { + * break; + * } + * } + * } + * }*/ public final UnaryCallable
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * RunName parent = + * RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]"); + * for (TransferMessage element : + * dataTransferServiceClient.listTransferLogs(parent).iterateAll()) { + * // doThingsWith(element); + * } + * } + * }+ * * @param parent Required. Transfer run name in the form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` @@ -885,6 +1622,20 @@ public final ListTransferLogsPagedResponse listTransferLogs(RunName parent) { /** * Returns user facing log messages for the data transfer run. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * String parent = + * RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]") + * .toString(); + * for (TransferMessage element : + * dataTransferServiceClient.listTransferLogs(parent).iterateAll()) { + * // doThingsWith(element); + * } + * } + * }+ * * @param parent Required. Transfer run name in the form: * `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or * `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}` @@ -900,6 +1651,26 @@ public final ListTransferLogsPagedResponse listTransferLogs(String parent) { /** * Returns user facing log messages for the data transfer run. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * ListTransferLogsRequest request = + * ListTransferLogsRequest.newBuilder() + * .setParent( + * RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]") + * .toString()) + * .setPageToken("pageToken873572522") + * .setPageSize(883849137) + * .addAllMessageTypes(new ArrayList+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -912,6 +1683,26 @@ public final ListTransferLogsPagedResponse listTransferLogs(ListTransferLogsRequ * Returns user facing log messages for the data transfer run. * *()) + * .build(); + * for (TransferMessage element : + * dataTransferServiceClient.listTransferLogs(request).iterateAll()) { + * // doThingsWith(element); + * } + * } + * }
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * ListTransferLogsRequest request = + * ListTransferLogsRequest.newBuilder() + * .setParent( + * RunName.ofProjectTransferConfigRunName("[PROJECT]", "[TRANSFER_CONFIG]", "[RUN]") + * .toString()) + * .setPageToken("pageToken873572522") + * .setPageSize(883849137) + * .addAllMessageTypes(new ArrayList*/ public final UnaryCallable()) + * .build(); + * ApiFuture future = + * dataTransferServiceClient.listTransferLogsPagedCallable().futureCall(request); + * // Do something. + * for (TransferMessage element : future.get().iterateAll()) { + * // doThingsWith(element); + * } + * } + * }
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * while (true) { + * ListTransferLogsResponse response = + * dataTransferServiceClient.listTransferLogsCallable().call(request); + * for (TransferMessage element : response.getResponsesList()) { + * // doThingsWith(element); + * } + * String nextPageToken = response.getNextPageToken(); + * if (!Strings.isNullOrEmpty(nextPageToken)) { + * request = request.toBuilder().setPageToken(nextPageToken).build(); + * } else { + * break; + * } + * } + * } + * }*/ public final UnaryCallable
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * DataSourceName name = DataSourceName.ofProjectDataSourceName("[PROJECT]", "[DATA_SOURCE]"); + * CheckValidCredsResponse response = dataTransferServiceClient.checkValidCreds(name); + * } + * }+ * * @param name Required. The data source in the form: * `projects/{project_id}/dataSources/{data_source_id}` or * `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`. @@ -954,6 +1772,15 @@ public final CheckValidCredsResponse checkValidCreds(DataSourceName name) { * 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. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * String name = DataSourceName.ofProjectDataSourceName("[PROJECT]", "[DATA_SOURCE]").toString(); + * CheckValidCredsResponse response = dataTransferServiceClient.checkValidCreds(name); + * } + * }+ * * @param name Required. The data source in the form: * `projects/{project_id}/dataSources/{data_source_id}` or * `projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`. @@ -971,6 +1798,19 @@ public final CheckValidCredsResponse checkValidCreds(String name) { * 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. * + *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * CheckValidCredsRequest request = + * CheckValidCredsRequest.newBuilder() + * .setName( + * DataSourceName.ofProjectDataSourceName("[PROJECT]", "[DATA_SOURCE]").toString()) + * .build(); + * CheckValidCredsResponse response = dataTransferServiceClient.checkValidCreds(request); + * } + * }+ * * @param request The request object containing all of the parameters for the API call. * @throws com.google.api.gax.rpc.ApiException if the remote call fails */ @@ -986,6 +1826,20 @@ public final CheckValidCredsResponse checkValidCreds(CheckValidCredsRequest requ * pre-requisite before user can create a transfer config. * *
Sample code: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * CheckValidCredsRequest request = + * CheckValidCredsRequest.newBuilder() + * .setName( + * DataSourceName.ofProjectDataSourceName("[PROJECT]", "[DATA_SOURCE]").toString()) + * .build(); + * ApiFuture*/ public final UnaryCallablefuture = + * dataTransferServiceClient.checkValidCredsCallable().futureCall(request); + * // Do something. + * CheckValidCredsResponse response = future.get(); + * } + * }
Sample for DataTransferServiceClient: + * + *
{@code + * try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + * DataSourceName name = DataSourceName.ofProjectDataSourceName("[PROJECT]", "[DATA_SOURCE]"); + * DataSource response = dataTransferServiceClient.getDataSource(name); + * } + * }*/ @Generated("by gapic-generator-java") package com.google.cloud.bigquery.datatransfer.v1; diff --git a/synth.metadata b/synth.metadata index 104efc4c..5b308912 100644 --- a/synth.metadata +++ b/synth.metadata @@ -11,15 +11,15 @@ "git": { "name": ".", "remote": "https://github.com/googleapis/java-bigquerydatatransfer.git", - "sha": "b807fa5699f7870657d4cd908cfa7213d247a87e" + "sha": "db99d4cdd12bbd5b6deee4785b562a2254a287e8" } }, { "git": { "name": "googleapis", "remote": "https://github.com/googleapis/googleapis.git", - "sha": "ceaaf31b3d13badab7cf9d3b570f5639db5593d9", - "internalRef": "352816749" + "sha": "8d8c008e56f1af31d57f75561e0f1848ffb29eeb", + "internalRef": "356341083" } }, {