com.google.cloud.bigquery.datatransfer.v1

Class UpdateTransferConfigRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest

All Implemented Interfaces:

UpdateTransferConfigRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class UpdateTransferConfigRequest
extends com.google.protobuf.GeneratedMessageV3
implements UpdateTransferConfigRequestOrBuilder

 A 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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UpdateTransferConfigRequest.Builder A request to update a transfer configuration.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTHORIZATION_CODE_FIELD_NUMBER
static int	SERVICE_ACCOUNT_NAME_FIELD_NUMBER
static int	TRANSFER_CONFIG_FIELD_NUMBER
static int	UPDATE_MASK_FIELD_NUMBER
static int	VERSION_INFO_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAuthorizationCode() Optional OAuth2 authorization code to use with this transfer configuration.
com.google.protobuf.ByteString	getAuthorizationCodeBytes() Optional OAuth2 authorization code to use with this transfer configuration.
static UpdateTransferConfigRequest	getDefaultInstance()
UpdateTransferConfigRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<UpdateTransferConfigRequest>	getParserForType()
int	getSerializedSize()
String	getServiceAccountName() Optional service account email.
com.google.protobuf.ByteString	getServiceAccountNameBytes() Optional service account email.
TransferConfig	getTransferConfig() Required.
TransferConfigOrBuilder	getTransferConfigOrBuilder() Required.
com.google.protobuf.FieldMask	getUpdateMask() Required.
com.google.protobuf.FieldMaskOrBuilder	getUpdateMaskOrBuilder() Required.
String	getVersionInfo() Optional version info.
com.google.protobuf.ByteString	getVersionInfoBytes() Optional version info.
int	hashCode()
boolean	hasTransferConfig() Required.
boolean	hasUpdateMask() Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static UpdateTransferConfigRequest.Builder	newBuilder()
static UpdateTransferConfigRequest.Builder	newBuilder(UpdateTransferConfigRequest prototype)
UpdateTransferConfigRequest.Builder	newBuilderForType()
protected UpdateTransferConfigRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static UpdateTransferConfigRequest	parseDelimitedFrom(InputStream input)
static UpdateTransferConfigRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UpdateTransferConfigRequest	parseFrom(byte[] data)
static UpdateTransferConfigRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UpdateTransferConfigRequest	parseFrom(ByteBuffer data)
static UpdateTransferConfigRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UpdateTransferConfigRequest	parseFrom(com.google.protobuf.ByteString data)
static UpdateTransferConfigRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UpdateTransferConfigRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static UpdateTransferConfigRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static UpdateTransferConfigRequest	parseFrom(InputStream input)
static UpdateTransferConfigRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<UpdateTransferConfigRequest>	parser()
UpdateTransferConfigRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TRANSFER_CONFIG_FIELD_NUMBER

public static final int TRANSFER_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

AUTHORIZATION_CODE_FIELD_NUMBER

public static final int AUTHORIZATION_CODE_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER

See Also:

Constant Field Values

VERSION_INFO_FIELD_NUMBER

public static final int VERSION_INFO_FIELD_NUMBER

See Also:

Constant Field Values

SERVICE_ACCOUNT_NAME_FIELD_NUMBER

public static final int SERVICE_ACCOUNT_NAME_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasTransferConfig

public boolean hasTransferConfig()

 Required. Data transfer configuration to create.
 

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

Specified by:

hasTransferConfig in interface UpdateTransferConfigRequestOrBuilder

Returns:

Whether the transferConfig field is set.

getTransferConfig

public TransferConfig getTransferConfig()

 Required. Data transfer configuration to create.
 

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

Specified by:

getTransferConfig in interface UpdateTransferConfigRequestOrBuilder

Returns:

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

Specified by:

getTransferConfigOrBuilder in interface UpdateTransferConfigRequestOrBuilder

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
 update the transfer config.
 

string authorization_code = 3;

Specified by:

getAuthorizationCode in interface UpdateTransferConfigRequestOrBuilder

Returns:

The authorizationCode.

getAuthorizationCodeBytes

public com.google.protobuf.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
 update the transfer config.
 

string authorization_code = 3;

Specified by:

getAuthorizationCodeBytes in interface UpdateTransferConfigRequestOrBuilder

Returns:

The bytes for authorizationCode.

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

Specified by:

hasUpdateMask in interface UpdateTransferConfigRequestOrBuilder

Returns:

Whether the updateMask field is set.

getUpdateMask

public com.google.protobuf.FieldMask getUpdateMask()

 Required. Required list of fields to be updated in this request.
 

.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getUpdateMask in interface UpdateTransferConfigRequestOrBuilder

Returns:

The updateMask.

getUpdateMaskOrBuilder

public com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder()

 Required. Required list of fields to be updated in this request.
 

.google.protobuf.FieldMask update_mask = 4 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getUpdateMaskOrBuilder in interface UpdateTransferConfigRequestOrBuilder

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
 update the transfer config.
 

string version_info = 5;

Specified by:

getVersionInfo in interface UpdateTransferConfigRequestOrBuilder

Returns:

The versionInfo.

getVersionInfoBytes

public com.google.protobuf.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
 update the transfer config.
 

string version_info = 5;

Specified by:

getVersionInfoBytes in interface UpdateTransferConfigRequestOrBuilder

Returns:

The bytes for versionInfo.

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).
 

string service_account_name = 6;

Specified by:

getServiceAccountName in interface UpdateTransferConfigRequestOrBuilder

Returns:

The serviceAccountName.

getServiceAccountNameBytes

public com.google.protobuf.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](https://cloud.google.com/bigquery-transfer/docs/use-service-accounts).
 

string service_account_name = 6;

Specified by:

getServiceAccountNameBytes in interface UpdateTransferConfigRequestOrBuilder

Returns:

The bytes for serviceAccountName.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static UpdateTransferConfigRequest parseFrom(ByteBuffer data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateTransferConfigRequest parseFrom(ByteBuffer data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateTransferConfigRequest parseFrom(com.google.protobuf.ByteString data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateTransferConfigRequest parseFrom(com.google.protobuf.ByteString data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateTransferConfigRequest parseFrom(byte[] data)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateTransferConfigRequest parseFrom(byte[] data,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static UpdateTransferConfigRequest parseFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static UpdateTransferConfigRequest parseFrom(InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static UpdateTransferConfigRequest parseDelimitedFrom(InputStream input)
                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static UpdateTransferConfigRequest parseDelimitedFrom(InputStream input,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws IOException

Throws:

IOException

parseFrom

public static UpdateTransferConfigRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                             throws IOException

Throws:

IOException

parseFrom

public static UpdateTransferConfigRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

newBuilderForType

public UpdateTransferConfigRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static UpdateTransferConfigRequest.Builder newBuilder()

newBuilder

public static UpdateTransferConfigRequest.Builder newBuilder(UpdateTransferConfigRequest prototype)

toBuilder

public UpdateTransferConfigRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected UpdateTransferConfigRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static UpdateTransferConfigRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<UpdateTransferConfigRequest> parser()

getParserForType

public com.google.protobuf.Parser<UpdateTransferConfigRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public UpdateTransferConfigRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder