google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest
*/
class CreateTransferConfigRequest extends \Google\Protobuf\Internal\Message
{
/**
* 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 dataset do not
* match - the request will fail.
*
* Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
*/
private $parent = '';
/**
* Required. Data transfer configuration to create.
*
* Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 2 [(.google.api.field_behavior) = REQUIRED];
*/
private $transfer_config = null;
/**
* 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:
*
* https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes
*
* * The client_id is the OAuth client_id of the a data source as
* returned by ListDataSources method.
* * data_source_scopes are the scopes returned by ListDataSources
* method.
* Note that this should not be set when `service_account_name` is used to
* create the transfer config.
*
* Generated from protobuf field string authorization_code = 3;
*/
private $authorization_code = '';
/**
* 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:
*
* https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes
*
* * The client_id is the OAuth client_id of the a data source as
* returned by ListDataSources method.
* * data_source_scopes are the scopes returned by ListDataSources
* method.
* Note that this should not be set when `service_account_name` is used to
* create the transfer config.
*
* Generated from protobuf field string version_info = 5;
*/
private $version_info = '';
/**
* Optional service account name. 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).
*
* Generated from protobuf field string service_account_name = 6;
*/
private $service_account_name = '';
/**
* Constructor.
*
* @param array $data {
* Optional. Data for populating the Message object.
*
* @type string $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 dataset do not
* match - the request will fail.
* @type \Google\Cloud\BigQuery\DataTransfer\V1\TransferConfig $transfer_config
* Required. Data transfer configuration to create.
* @type string $authorization_code
* 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:
*
* https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes
*
* * The client_id is the OAuth client_id of the a data source as
* returned by ListDataSources method.
* * data_source_scopes are the scopes returned by ListDataSources
* method.
* Note that this should not be set when `service_account_name` is used to
* create the transfer config.
* @type string $version_info
* 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:
*
* https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes
*
* * The client_id is the OAuth client_id of the a data source as
* returned by ListDataSources method.
* * data_source_scopes are the scopes returned by ListDataSources
* method.
* Note that this should not be set when `service_account_name` is used to
* create the transfer config.
* @type string $service_account_name
* Optional service account name. 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).
* }
*/
public function __construct($data = NULL) {
\GPBMetadata\Google\Cloud\Bigquery\Datatransfer\V1\Datatransfer::initOnce();
parent::__construct($data);
}
/**
* 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 dataset do not
* match - the request will fail.
*
* Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
* @return string
*/
public function getParent()
{
return $this->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 dataset do not
* match - the request will fail.
*
* Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
* @param string $var
* @return $this
*/
public function setParent($var)
{
GPBUtil::checkString($var, True);
$this->parent = $var;
return $this;
}
/**
* Required. Data transfer configuration to create.
*
* Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 2 [(.google.api.field_behavior) = REQUIRED];
* @return \Google\Cloud\BigQuery\DataTransfer\V1\TransferConfig|null
*/
public function getTransferConfig()
{
return $this->transfer_config;
}
public function hasTransferConfig()
{
return isset($this->transfer_config);
}
public function clearTransferConfig()
{
unset($this->transfer_config);
}
/**
* Required. Data transfer configuration to create.
*
* Generated from protobuf field .google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 2 [(.google.api.field_behavior) = REQUIRED];
* @param \Google\Cloud\BigQuery\DataTransfer\V1\TransferConfig $var
* @return $this
*/
public function setTransferConfig($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\BigQuery\DataTransfer\V1\TransferConfig::class);
$this->transfer_config = $var;
return $this;
}
/**
* 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:
*
* https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes
*
* * The client_id is the OAuth client_id of the a data source as
* returned by ListDataSources method.
* * data_source_scopes are the scopes returned by ListDataSources
* method.
* Note that this should not be set when `service_account_name` is used to
* create the transfer config.
*
* Generated from protobuf field string authorization_code = 3;
* @return string
*/
public function getAuthorizationCode()
{
return $this->authorization_code;
}
/**
* 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:
*
* https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code&client_id=client_id&scope=data_source_scopes
*
* * The client_id is the OAuth client_id of the a data source as
* returned by ListDataSources method.
* * data_source_scopes are the scopes returned by ListDataSources
* method.
* Note that this should not be set when `service_account_name` is used to
* create the transfer config.
*
* Generated from protobuf field string authorization_code = 3;
* @param string $var
* @return $this
*/
public function setAuthorizationCode($var)
{
GPBUtil::checkString($var, True);
$this->authorization_code = $var;
return $this;
}
/**
* 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:
*
* https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes
*
* * The client_id is the OAuth client_id of the a data source as
* returned by ListDataSources method.
* * data_source_scopes are the scopes returned by ListDataSources
* method.
* Note that this should not be set when `service_account_name` is used to
* create the transfer config.
*
* Generated from protobuf field string version_info = 5;
* @return string
*/
public function getVersionInfo()
{
return $this->version_info;
}
/**
* 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:
*
* https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scopes
*
* * The client_id is the OAuth client_id of the a data source as
* returned by ListDataSources method.
* * data_source_scopes are the scopes returned by ListDataSources
* method.
* Note that this should not be set when `service_account_name` is used to
* create the transfer config.
*
* Generated from protobuf field string version_info = 5;
* @param string $var
* @return $this
*/
public function setVersionInfo($var)
{
GPBUtil::checkString($var, True);
$this->version_info = $var;
return $this;
}
/**
* Optional service account name. 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).
*
* Generated from protobuf field string service_account_name = 6;
* @return string
*/
public function getServiceAccountName()
{
return $this->service_account_name;
}
/**
* Optional service account name. 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).
*
* Generated from protobuf field string service_account_name = 6;
* @param string $var
* @return $this
*/
public function setServiceAccountName($var)
{
GPBUtil::checkString($var, True);
$this->service_account_name = $var;
return $this;
}
}