public final class UpdateTransferConfigRequest extends GeneratedMessageV3 implements UpdateTransferConfigRequestOrBuilder
A request to update a transfer configuration. To update the user id of the
transfer configuration, an authorization code needs to be provided.
Protobuf type google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest
Static Fields
AUTHORIZATION_CODE_FIELD_NUMBER
public static final int AUTHORIZATION_CODE_FIELD_NUMBER
Field Value
SERVICE_ACCOUNT_NAME_FIELD_NUMBER
public static final int SERVICE_ACCOUNT_NAME_FIELD_NUMBER
Field Value
TRANSFER_CONFIG_FIELD_NUMBER
public static final int TRANSFER_CONFIG_FIELD_NUMBER
Field Value
UPDATE_MASK_FIELD_NUMBER
public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
VERSION_INFO_FIELD_NUMBER
public static final int VERSION_INFO_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static UpdateTransferConfigRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static UpdateTransferConfigRequest.Builder newBuilder()
Returns
newBuilder(UpdateTransferConfigRequest prototype)
public static UpdateTransferConfigRequest.Builder newBuilder(UpdateTransferConfigRequest prototype)
Parameter
Returns
public static UpdateTransferConfigRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static UpdateTransferConfigRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static UpdateTransferConfigRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UpdateTransferConfigRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static UpdateTransferConfigRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UpdateTransferConfigRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static UpdateTransferConfigRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static UpdateTransferConfigRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static UpdateTransferConfigRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static UpdateTransferConfigRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static UpdateTransferConfigRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UpdateTransferConfigRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<UpdateTransferConfigRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAuthorizationCode()
public String getAuthorizationCode()
Optional OAuth2 authorization code to use with this transfer configuration.
If it is provided, the transfer configuration will be associated with the
authorizing user.
In order to obtain authorization_code, please make a
request to
https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>;
- client_id should be OAuth client_id of BigQuery DTS API for the given
data source returned by ListDataSources method.
- data_source_scopes are the scopes returned by ListDataSources method.
- redirect_uri is an optional parameter. If not specified, then
authorization code is posted to the opener of authorization flow window.
Otherwise it will be sent to the redirect uri. A special value of
urn:ietf:wg:oauth:2.0:oob means that authorization code should be
returned in the title bar of the browser, with the page text prompting
the user to copy the code and paste it in the application.
string authorization_code = 3;
| Type | Description |
| String | The authorizationCode.
|
getAuthorizationCodeBytes()
public ByteString getAuthorizationCodeBytes()
Optional OAuth2 authorization code to use with this transfer configuration.
If it is provided, the transfer configuration will be associated with the
authorizing user.
In order to obtain authorization_code, please make a
request to
https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>;
- client_id should be OAuth client_id of BigQuery DTS API for the given
data source returned by ListDataSources method.
- data_source_scopes are the scopes returned by ListDataSources method.
- redirect_uri is an optional parameter. If not specified, then
authorization code is posted to the opener of authorization flow window.
Otherwise it will be sent to the redirect uri. A special value of
urn:ietf:wg:oauth:2.0:oob means that authorization code should be
returned in the title bar of the browser, with the page text prompting
the user to copy the code and paste it in the application.
string authorization_code = 3;
| Type | Description |
| ByteString | The bytes for authorizationCode.
|
getDefaultInstanceForType()
public UpdateTransferConfigRequest getDefaultInstanceForType()
Returns
getParserForType()
public Parser<UpdateTransferConfigRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getServiceAccountName()
public String getServiceAccountName()
Optional service account name. If this field is set and
"service_account_name" is set in update_mask, transfer config will be
updated to use this service account credentials. It requires that
requesting user calling this API has permissions to act as this service
account.
string service_account_name = 6;
| Type | Description |
| String | The serviceAccountName.
|
getServiceAccountNameBytes()
public ByteString getServiceAccountNameBytes()
Optional service account name. If this field is set and
"service_account_name" is set in update_mask, transfer config will be
updated to use this service account credentials. It requires that
requesting user calling this API has permissions to act as this service
account.
string service_account_name = 6;
| 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];
getTransferConfigOrBuilder()
public TransferConfigOrBuilder getTransferConfigOrBuilder()
Required. Data transfer configuration to create.
.google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 1 [(.google.api.field_behavior) = REQUIRED];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
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];
getVersionInfo()
public String getVersionInfo()
Optional version info. If users want to find a very recent access token,
that is, immediately after approving access, users have to set the
version_info claim in the token request. To obtain the version_info, users
must use the "none+gsession" response type. which be return a
version_info back in the authorization response which be be put in a JWT
claim in the token request.
string version_info = 5;
| Type | Description |
| String | The versionInfo.
|
getVersionInfoBytes()
public ByteString getVersionInfoBytes()
Optional version info. If users want to find a very recent access token,
that is, immediately after approving access, users have to set the
version_info claim in the token request. To obtain the version_info, users
must use the "none+gsession" response type. which be return a
version_info back in the authorization response which be be put in a JWT
claim in the token request.
string version_info = 5;
| 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];
| 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];
| Type | Description |
| boolean | Whether the updateMask field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public UpdateTransferConfigRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected UpdateTransferConfigRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public UpdateTransferConfigRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
