/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/bigquery/datatransfer/v1/datatransfer.proto
package com.google.cloud.bigquery.datatransfer.v1;
public interface UpdateTransferConfigRequestOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Required. Data transfer configuration to create.
*
*
*
* .google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 1 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the transferConfig field is set.
*/
boolean hasTransferConfig();
/**
*
*
*
* Required. Data transfer configuration to create.
*
*
*
* .google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 1 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The transferConfig.
*/
com.google.cloud.bigquery.datatransfer.v1.TransferConfig getTransferConfig();
/**
*
*
*
* Required. Data transfer configuration to create.
*
*
*
* .google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 1 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.cloud.bigquery.datatransfer.v1.TransferConfigOrBuilder getTransferConfigOrBuilder();
/**
*
*
*
* Optional OAuth2 authorization code to use with this transfer configuration.
* This is required only if `transferConfig.dataSourceId` is 'youtube_channel'
* and new credentials are needed, as indicated by `CheckValidCreds`. In order
* to obtain authorization_code, make a request to the following URL:
* <pre class="prettyprint" suppresswarning="true">
* https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
* </pre>
* * The <var>client_id</var> is the OAuth client_id of the a data source as
* returned by ListDataSources method.
* * <var>data_source_scopes</var> are the scopes returned by ListDataSources
* method.
* Note that this should not be set when `service_account_name` is used to
* update the transfer config.
*
*
* string authorization_code = 3;
*
* @return The authorizationCode.
*/
java.lang.String getAuthorizationCode();
/**
*
*
*
* Optional OAuth2 authorization code to use with this transfer configuration.
* This is required only if `transferConfig.dataSourceId` is 'youtube_channel'
* and new credentials are needed, as indicated by `CheckValidCreds`. In order
* to obtain authorization_code, make a request to the following URL:
* <pre class="prettyprint" suppresswarning="true">
* https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
* </pre>
* * The <var>client_id</var> is the OAuth client_id of the a data source as
* returned by ListDataSources method.
* * <var>data_source_scopes</var> are the scopes returned by ListDataSources
* method.
* Note that this should not be set when `service_account_name` is used to
* update the transfer config.
*
*
* string authorization_code = 3;
*
* @return The bytes for authorizationCode.
*/
com.google.protobuf.ByteString getAuthorizationCodeBytes();
/**
*
*
*
* Required. Required list of fields to be updated in this request.
*
*
* .google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the updateMask field is set.
*/
boolean hasUpdateMask();
/**
*
*
*
* Required. Required list of fields to be updated in this request.
*
*
* .google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The updateMask.
*/
com.google.protobuf.FieldMask getUpdateMask();
/**
*
*
*
* Required. Required list of fields to be updated in this request.
*
*
* .google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder();
/**
*
*
*
* Optional version info. This is required only if
* `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials
* are needed, as indicated by `CheckValidCreds`. In order to obtain version
* info, make a request to the following URL:
* <pre class="prettyprint" suppresswarning="true">
* https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
* </pre>
* * The <var>client_id</var> is the OAuth client_id of the a data source as
* returned by ListDataSources method.
* * <var>data_source_scopes</var> are the scopes returned by ListDataSources
* method.
* Note that this should not be set when `service_account_name` is used to
* update the transfer config.
*
*
* string version_info = 5;
*
* @return The versionInfo.
*/
java.lang.String getVersionInfo();
/**
*
*
*
* Optional version info. This is required only if
* `transferConfig.dataSourceId` is not 'youtube_channel' and new credentials
* are needed, as indicated by `CheckValidCreds`. In order to obtain version
* info, make a request to the following URL:
* <pre class="prettyprint" suppresswarning="true">
* https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=<var>client_id</var>&scope=<var>data_source_scopes</var>
* </pre>
* * The <var>client_id</var> is the OAuth client_id of the a data source as
* returned by ListDataSources method.
* * <var>data_source_scopes</var> are the scopes returned by ListDataSources
* method.
* Note that this should not be set when `service_account_name` is used to
* update the transfer config.
*
*
* string version_info = 5;
*
* @return The bytes for versionInfo.
*/
com.google.protobuf.ByteString getVersionInfoBytes();
/**
*
*
*
* Optional service account email. If this field is set, the transfer config
* will be created with this service account's credentials. It requires that
* the requesting user calling this API has permissions to act as this service
* account.
* Note that not all data sources support service account credentials when
* creating a transfer config. For the latest list of data sources, read about
* [using service
* accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
*
*
* string service_account_name = 6;
*
* @return The serviceAccountName.
*/
java.lang.String getServiceAccountName();
/**
*
*
*
* Optional service account email. If this field is set, the transfer config
* will be created with this service account's credentials. It requires that
* the requesting user calling this API has permissions to act as this service
* account.
* Note that not all data sources support service account credentials when
* creating a transfer config. For the latest list of data sources, read about
* [using service
* accounts](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
*
*
* string service_account_name = 6;
*
* @return The bytes for serviceAccountName.
*/
com.google.protobuf.ByteString getServiceAccountNameBytes();
}