- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.17
- 2.2.6
- 2.1.23
- 2.0.27
public final class UpdateTransferConfigRequest extends GeneratedMessageV3 implements UpdateTransferConfigRequestOrBuilderA request to update a transfer configuration. To update the user id of the transfer configuration, authorization info needs to be provided.
Protobuf type google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > UpdateTransferConfigRequestImplements
UpdateTransferConfigRequestOrBuilderStatic Fields
AUTHORIZATION_CODE_FIELD_NUMBER
public static final int AUTHORIZATION_CODE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
SERVICE_ACCOUNT_NAME_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TRANSFER_CONFIG_FIELD_NUMBER
public static final int TRANSFER_CONFIG_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
UPDATE_MASK_FIELD_NUMBER
public static final int UPDATE_MASK_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
VERSION_INFO_FIELD_NUMBER
public static final int VERSION_INFO_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static UpdateTransferConfigRequest getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static UpdateTransferConfigRequest.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest.Builder |
|
newBuilder(UpdateTransferConfigRequest prototype)
public static UpdateTransferConfigRequest.Builder newBuilder(UpdateTransferConfigRequest prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
UpdateTransferConfigRequest |
| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest.Builder |
|
parseDelimitedFrom(InputStream input)
public static UpdateTransferConfigRequest parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static UpdateTransferConfigRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static UpdateTransferConfigRequest parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UpdateTransferConfigRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static UpdateTransferConfigRequest parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UpdateTransferConfigRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static UpdateTransferConfigRequest parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static UpdateTransferConfigRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static UpdateTransferConfigRequest parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static UpdateTransferConfigRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static UpdateTransferConfigRequest parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UpdateTransferConfigRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<UpdateTransferConfigRequest> parser()| Returns | |
|---|---|
| Type | Description |
Parser<UpdateTransferConfigRequest> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAuthorizationCode() (deprecated)
public String getAuthorizationCode()Deprecated. google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest.authorization_code is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=587
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:
<pre class="prettyprint" suppresswarning="true">
https://bigquery.cloud.google.com/datatransfer/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 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_nameis used to update the transfer config.
string authorization_code = 3 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
String |
The authorizationCode. |
getAuthorizationCodeBytes() (deprecated)
public ByteString getAuthorizationCodeBytes()Deprecated. google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest.authorization_code is deprecated. See google/cloud/bigquery/datatransfer/v1/datatransfer.proto;l=587
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:
<pre class="prettyprint" suppresswarning="true">
https://bigquery.cloud.google.com/datatransfer/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 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_nameis used to update the transfer config.
string authorization_code = 3 [deprecated = true];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for authorizationCode. |
getDefaultInstanceForType()
public UpdateTransferConfigRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest |
|
getParserForType()
public Parser<UpdateTransferConfigRequest> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<UpdateTransferConfigRequest> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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.
string service_account_name = 6;
| Returns | |
|---|---|
| Type | Description |
String |
The serviceAccountName. |
getServiceAccountNameBytes()
public ByteString getServiceAccountNameBytes()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.
string service_account_name = 6;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for serviceAccountName. |
getTransferConfig()
public TransferConfig getTransferConfig()Required. Data transfer configuration to create.
.google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
TransferConfig |
The transferConfig. |
getTransferConfigOrBuilder()
public TransferConfigOrBuilder getTransferConfigOrBuilder()Required. Data transfer configuration to create.
.google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
TransferConfigOrBuilder |
|
getUpdateMask()
public FieldMask getUpdateMask()Required. Required list of fields to be updated in this request.
.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
FieldMask |
The updateMask. |
getUpdateMaskOrBuilder()
public FieldMaskOrBuilder getUpdateMaskOrBuilder()Required. Required list of fields to be updated in this request.
.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
FieldMaskOrBuilder |
|
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:
<pre class="prettyprint" suppresswarning="true">
https://bigquery.cloud.google.com/datatransfer/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 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_nameis used to update the transfer config.
string version_info = 5;
| Returns | |
|---|---|
| Type | Description |
String |
The versionInfo. |
getVersionInfoBytes()
public ByteString getVersionInfoBytes() 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:
<pre class="prettyprint" suppresswarning="true">
https://bigquery.cloud.google.com/datatransfer/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 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_nameis used to update the transfer config.
string version_info = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for versionInfo. |
hasTransferConfig()
public boolean hasTransferConfig()Required. Data transfer configuration to create.
.google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the transferConfig field is set. |
hasUpdateMask()
public boolean hasUpdateMask()Required. Required list of fields to be updated in this request.
.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateMask field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public UpdateTransferConfigRequest.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected UpdateTransferConfigRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public UpdateTransferConfigRequest.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
UpdateTransferConfigRequest.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|