Class ProjectsResource.TransferConfigsResource.PatchRequest
Updates a data transfer configuration. All fields must be set, even if they are not updated.
Inheritance
Inherited Members
Namespace: Google.Apis.BigQueryDataTransfer.v1
Assembly: Google.Apis.BigQueryDataTransfer.v1.dll
Syntax
public class ProjectsResource.TransferConfigsResource.PatchRequest : BigQueryDataTransferBaseServiceRequest<TransferConfig>, IClientServiceRequest<TransferConfig>, IClientServiceRequest
Constructors
PatchRequest(IClientService, TransferConfig, string)
Constructs a new Patch request.
Declaration
public PatchRequest(IClientService service, TransferConfig body, string name)
Parameters
Type | Name | Description |
---|---|---|
IClientService | service | |
TransferConfig | body | |
string | name |
Properties
AuthorizationCode
Deprecated: Authorization code was required when transferConfig.dataSourceId
is 'youtube_channel'
but it is no longer used in any data sources. Use version_info
instead. 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://bigquery.cloud.google.com/datatransfer/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 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 update the transfer config.
Declaration
[RequestParameter("authorizationCode", RequestParameterType.Query)]
public virtual string AuthorizationCode { get; set; }
Property Value
Type | Description |
---|---|
string |
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Name
Identifier. The resource name of the transfer config. Transfer config names have the form either
projects/{project_id}/locations/{region}/transferConfigs/{config_id}
or
projects/{project_id}/transferConfigs/{config_id}
, where config_id
is usually a UUID, even
though it is not guaranteed or required. The name is ignored when creating a transfer config.
Declaration
[RequestParameter("name", RequestParameterType.Path)]
public virtual string Name { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
ServiceAccountName
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.
Declaration
[RequestParameter("serviceAccountName", RequestParameterType.Query)]
public virtual string ServiceAccountName { get; set; }
Property Value
Type | Description |
---|---|
string |
UpdateMask
Required. Required list of fields to be updated in this request.
Declaration
[RequestParameter("updateMask", RequestParameterType.Query)]
public virtual object UpdateMask { get; set; }
Property Value
Type | Description |
---|---|
object |
VersionInfo
Optional version info. This parameter replaces authorization_code
which is no longer used in any
data sources. This is required only if transferConfig.dataSourceId
is 'youtube_channel' or new
credentials are needed, as indicated by CheckValidCreds
. In order to obtain version info, make a
request to the following URL:
https://bigquery.cloud.google.com/datatransfer/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 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 update the transfer config.
Declaration
[RequestParameter("versionInfo", RequestParameterType.Query)]
public virtual string VersionInfo { get; set; }
Property Value
Type | Description |
---|---|
string |
Methods
GetBody()
Returns the body of the request.
Declaration
protected override object GetBody()
Returns
Type | Description |
---|---|
object |
Overrides
InitParameters()
Initializes Patch parameter list.
Declaration
protected override void InitParameters()