Class CreateTransferConfigRequest (2.17.0)

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, authorization info must be provided. If authorization info is provided, the transfer configuration will be associated with the user id corresponding to the authorization info. 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
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

SERVICE_ACCOUNT_NAME_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSFER_CONFIG_FIELD_NUMBER

public static final int TRANSFER_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

VERSION_INFO_FIELD_NUMBER

public static final int VERSION_INFO_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static CreateTransferConfigRequest getDefaultInstance()
Returns
TypeDescription
CreateTransferConfigRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static CreateTransferConfigRequest.Builder newBuilder()
Returns
TypeDescription
CreateTransferConfigRequest.Builder

newBuilder(CreateTransferConfigRequest prototype)

public static CreateTransferConfigRequest.Builder newBuilder(CreateTransferConfigRequest prototype)
Parameter
NameDescription
prototypeCreateTransferConfigRequest
Returns
TypeDescription
CreateTransferConfigRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateTransferConfigRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateTransferConfigRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateTransferConfigRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateTransferConfigRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CreateTransferConfigRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CreateTransferConfigRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateTransferConfigRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateTransferConfigRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateTransferConfigRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CreateTransferConfigRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateTransferConfigRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateTransferConfigRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateTransferConfigRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CreateTransferConfigRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateTransferConfigRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateTransferConfigRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CreateTransferConfigRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CreateTransferConfigRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateTransferConfigRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateTransferConfigRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CreateTransferConfigRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CreateTransferConfigRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateTransferConfigRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CreateTransferConfigRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CreateTransferConfigRequest> parser()
Returns
TypeDescription
Parser<CreateTransferConfigRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAuthorizationCode()

public String getAuthorizationCode()

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://www.gstatic.com/bigquerydatatransfer/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 a 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_name is used to create the transfer config.

string authorization_code = 3;

Returns
TypeDescription
String

The authorizationCode.

getAuthorizationCodeBytes()

public ByteString getAuthorizationCodeBytes()

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://www.gstatic.com/bigquerydatatransfer/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 a 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_name is used to create the transfer config.

string authorization_code = 3;

Returns
TypeDescription
ByteString

The bytes for authorizationCode.

getDefaultInstanceForType()

public CreateTransferConfigRequest getDefaultInstanceForType()
Returns
TypeDescription
CreateTransferConfigRequest

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) = { ... }

Returns
TypeDescription
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) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateTransferConfigRequest> getParserForType()
Returns
TypeDescription
Parser<CreateTransferConfigRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
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
TypeDescription
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];

Returns
TypeDescription
TransferConfig

The transferConfig.

getTransferConfigOrBuilder()

public TransferConfigOrBuilder getTransferConfigOrBuilder()

Required. Data transfer configuration to create.

.google.cloud.bigquery.datatransfer.v1.TransferConfig transfer_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
TransferConfigOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getVersionInfo()

public String getVersionInfo()

Optional version info. This is required only if transferConfig.dataSourceId is not 'youtube_channel' and 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://www.gstatic.com/bigquerydatatransfer/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 a 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_name is used to create the transfer config.

string version_info = 5;

Returns
TypeDescription
String

The versionInfo.

getVersionInfoBytes()

public ByteString getVersionInfoBytes()

Optional version info. This is required only if transferConfig.dataSourceId is not 'youtube_channel' and 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://www.gstatic.com/bigquerydatatransfer/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 a 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_name is used to create the transfer config.

string version_info = 5;

Returns
TypeDescription
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];

Returns
TypeDescription
boolean

Whether the transferConfig field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public CreateTransferConfigRequest.Builder newBuilderForType()
Returns
TypeDescription
CreateTransferConfigRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateTransferConfigRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CreateTransferConfigRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public CreateTransferConfigRequest.Builder toBuilder()
Returns
TypeDescription
CreateTransferConfigRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException