target.apidocs.com.google.api.services.bigquerydatatransfer.v1.BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch.html Maven / Gradle / Ivy
BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch (BigQuery Data Transfer API v1-rev20240914-2.0.0)
com.google.api.services.bigquerydatatransfer.v1
Class BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
-
- com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
-
- com.google.api.services.bigquerydatatransfer.v1.BigQueryDataTransferRequest<TransferConfig>
-
- com.google.api.services.bigquerydatatransfer.v1.BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch
-
- Enclosing class:
- BigQueryDataTransfer.Projects.Locations.TransferConfigs
public class BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch
extends BigQueryDataTransferRequest<TransferConfig>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected Patch(String name,
TransferConfig content)
Updates a data transfer configuration.
-
Method Summary
-
Methods inherited from class com.google.api.services.bigquerydatatransfer.v1.BigQueryDataTransferRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders
-
Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue
-
Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream
-
Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Constructor Detail
-
Patch
protected Patch(String name,
TransferConfig content)
Updates a data transfer configuration. All fields must be set, even if they are not updated.
Create a request for the method "transferConfigs.patch".
This request holds the parameters needed by the the bigquerydatatransfer server. After setting
any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
operation. BigQueryDataTransfer.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must
be called to initialize this instance immediately after invoking the constructor.
- Parameters:
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.content - the TransferConfig- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch set$Xgafv(String $Xgafv)
Description copied from class: BigQueryDataTransferRequest
V1 error format.
- Overrides:
set$Xgafv in class BigQueryDataTransferRequest<TransferConfig>
-
setAccessToken
public BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch setAccessToken(String accessToken)
Description copied from class: BigQueryDataTransferRequest
OAuth access token.
- Overrides:
setAccessToken in class BigQueryDataTransferRequest<TransferConfig>
-
setAlt
public BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch setAlt(String alt)
Description copied from class: BigQueryDataTransferRequest
Data format for response.
- Overrides:
setAlt in class BigQueryDataTransferRequest<TransferConfig>
-
setCallback
public BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch setCallback(String callback)
Description copied from class: BigQueryDataTransferRequest
JSONP
- Overrides:
setCallback in class BigQueryDataTransferRequest<TransferConfig>
-
setFields
public BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch setFields(String fields)
Description copied from class: BigQueryDataTransferRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class BigQueryDataTransferRequest<TransferConfig>
-
setKey
public BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch setKey(String key)
Description copied from class: BigQueryDataTransferRequest
API key. Your API key identifies your project and provides you with API access, quota, and
reports. Required unless you provide an OAuth 2.0 token.
- Overrides:
setKey in class BigQueryDataTransferRequest<TransferConfig>
-
setOauthToken
public BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch setOauthToken(String oauthToken)
Description copied from class: BigQueryDataTransferRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class BigQueryDataTransferRequest<TransferConfig>
-
setPrettyPrint
public BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch setPrettyPrint(Boolean prettyPrint)
Description copied from class: BigQueryDataTransferRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class BigQueryDataTransferRequest<TransferConfig>
-
setQuotaUser
public BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch setQuotaUser(String quotaUser)
Description copied from class: BigQueryDataTransferRequest
Available to use for quota purposes for server-side applications. Can be any arbitrary string
assigned to a user, but should not exceed 40 characters.
- Overrides:
setQuotaUser in class BigQueryDataTransferRequest<TransferConfig>
-
setUploadType
public BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch setUploadType(String uploadType)
Description copied from class: BigQueryDataTransferRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class BigQueryDataTransferRequest<TransferConfig>
-
setUploadProtocol
public BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch setUploadProtocol(String uploadProtocol)
Description copied from class: BigQueryDataTransferRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class BigQueryDataTransferRequest<TransferConfig>
-
getName
public String getName()
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.
-
setName
public BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch setName(String 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.
-
getAuthorizationCode
public String getAuthorizationCode()
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: http
s://bigquery.cloud.google.com/datatransfer/oauthz/auth?redirect_uri=urn:ietf:wg:oauth:2.0:oob&respo
nse_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.
-
setAuthorizationCode
public BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch setAuthorizationCode(String 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=autho
rization_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.
-
getServiceAccountName
public 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).
-
setServiceAccountName
public BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch setServiceAccountName(String 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](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
-
getUpdateMask
public String getUpdateMask()
Required. Required list of fields to be updated in this request.
-
setUpdateMask
public BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch setUpdateMask(String updateMask)
Required. Required list of fields to be updated in this request.
-
getVersionInfo
public String getVersionInfo()
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_u
ri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info&client_id=client_id&scope=data_source_scope
s * 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.
-
setVersionInfo
public BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch setVersionInfo(String 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&respon
se_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.
-
set
public BigQueryDataTransfer.Projects.Locations.TransferConfigs.Patch set(String parameterName,
Object value)
- Overrides:
set in class BigQueryDataTransferRequest<TransferConfig>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy