public final class CreateTransferConfigRequest extends GeneratedMessageV3 implements CreateTransferConfigRequestOrBuilder
A request to create a data transfer configuration. If new credentials are
needed for this transfer configuration, an authorization code must be
provided. If an authorization code is provided, the transfer configuration
will be associated with the user id corresponding to the authorization code.
Otherwise, the transfer configuration will be associated with the calling
user.
Protobuf type google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest
Static Fields
AUTHORIZATION_CODE_FIELD_NUMBER
public static final int AUTHORIZATION_CODE_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_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
VERSION_INFO_FIELD_NUMBER
public static final int VERSION_INFO_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static CreateTransferConfigRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static CreateTransferConfigRequest.Builder newBuilder()
Returns
newBuilder(CreateTransferConfigRequest prototype)
public static CreateTransferConfigRequest.Builder newBuilder(CreateTransferConfigRequest prototype)
Parameter
Returns
public static CreateTransferConfigRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static CreateTransferConfigRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static CreateTransferConfigRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static CreateTransferConfigRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static CreateTransferConfigRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static CreateTransferConfigRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static CreateTransferConfigRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static CreateTransferConfigRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static CreateTransferConfigRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static CreateTransferConfigRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static CreateTransferConfigRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static CreateTransferConfigRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<CreateTransferConfigRequest> 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.
This is required if new credentials are needed, as indicated by
CheckValidCreds.
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.
This is required if new credentials are needed, as indicated by
CheckValidCreds.
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 CreateTransferConfigRequest getDefaultInstanceForType()
Returns
getParent()
public String getParent()
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.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| String | The parent.
|
getParentBytes()
public ByteString getParentBytes()
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.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParserForType()
public Parser<CreateTransferConfigRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getServiceAccountName()
public String getServiceAccountName()
Optional service account name. If this field is set, transfer config will
be created with 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, transfer config will
be created with 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 = 2 [(.google.api.field_behavior) = REQUIRED];
getTransferConfigOrBuilder()
public TransferConfigOrBuilder getTransferConfigOrBuilder()
Required. Data transfer configuration to create.
.google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 2 [(.google.api.field_behavior) = REQUIRED];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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 = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| boolean | Whether the transferConfig field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public CreateTransferConfigRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected CreateTransferConfigRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public CreateTransferConfigRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
