TransferConfig.Builder (java API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<TransferConfig.Builder>
    - - com.google.cloud.bigquery.datatransfer.v1.TransferConfig.Builder

All Implemented Interfaces:: TransferConfigOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:: TransferConfig

public static final class TransferConfig.Builder
extends GeneratedMessageV3.Builder<TransferConfig.Builder>
implements TransferConfigOrBuilder

 Represents a data transfer configuration. A transfer configuration
 contains all metadata needed to perform a data transfer. For example,
 `destination_dataset_id` specifies where data should be stored.
 When a new transfer configuration is created, the specified
 `destination_dataset_id` is created when needed and shared with the
 appropriate data source service account.

Protobuf type google.cloud.bigquery.datatransfer.v1.TransferConfig

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TransferConfig.Builder`	`addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`TransferConfig`	`build()`
`TransferConfig`	`buildPartial()`
`TransferConfig.Builder`	`clear()`
`TransferConfig.Builder`	`clearDataRefreshWindowDays()` The number of days to look back to automatically refresh the data.
`TransferConfig.Builder`	`clearDatasetRegion()` Output only.
`TransferConfig.Builder`	`clearDataSourceId()` Data source id.
`TransferConfig.Builder`	`clearDestinationDatasetId()` The BigQuery target dataset id.
`TransferConfig.Builder`	`clearDisabled()` Is this config disabled.
`TransferConfig.Builder`	`clearDisplayName()` User specified display name for the data transfer.
`TransferConfig.Builder`	`clearField(Descriptors.FieldDescriptor field)`
`TransferConfig.Builder`	`clearName()` The resource name of the transfer config.
`TransferConfig.Builder`	`clearNextRunTime()` Output only.
`TransferConfig.Builder`	`clearOneof(Descriptors.OneofDescriptor oneof)`
`TransferConfig.Builder`	`clearParams()` Data transfer specific parameters.
`TransferConfig.Builder`	`clearSchedule()` Data transfer schedule.
`TransferConfig.Builder`	`clearState()` Output only.
`TransferConfig.Builder`	`clearUpdateTime()` Output only.
`TransferConfig.Builder`	`clearUserId()` Output only.
`TransferConfig.Builder`	`clone()`
`int`	`getDataRefreshWindowDays()` The number of days to look back to automatically refresh the data.
`java.lang.String`	`getDatasetRegion()` Output only.
`ByteString`	`getDatasetRegionBytes()` Output only.
`java.lang.String`	`getDataSourceId()` Data source id.
`ByteString`	`getDataSourceIdBytes()` Data source id.
`TransferConfig`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Descriptors.Descriptor`	`getDescriptorForType()`
`java.lang.String`	`getDestinationDatasetId()` The BigQuery target dataset id.
`ByteString`	`getDestinationDatasetIdBytes()` The BigQuery target dataset id.
`boolean`	`getDisabled()` Is this config disabled.
`java.lang.String`	`getDisplayName()` User specified display name for the data transfer.
`ByteString`	`getDisplayNameBytes()` User specified display name for the data transfer.
`java.lang.String`	`getName()` The resource name of the transfer config.
`ByteString`	`getNameBytes()` The resource name of the transfer config.
`Timestamp`	`getNextRunTime()` Output only.
`Timestamp.Builder`	`getNextRunTimeBuilder()` Output only.
`TimestampOrBuilder`	`getNextRunTimeOrBuilder()` Output only.
`Struct`	`getParams()` Data transfer specific parameters.
`Struct.Builder`	`getParamsBuilder()` Data transfer specific parameters.
`StructOrBuilder`	`getParamsOrBuilder()` Data transfer specific parameters.
`java.lang.String`	`getSchedule()` Data transfer schedule.
`ByteString`	`getScheduleBytes()` Data transfer schedule.
`TransferState`	`getState()` Output only.
`int`	`getStateValue()` Output only.
`Timestamp`	`getUpdateTime()` Output only.
`Timestamp.Builder`	`getUpdateTimeBuilder()` Output only.
`TimestampOrBuilder`	`getUpdateTimeOrBuilder()` Output only.
`long`	`getUserId()` Output only.
`boolean`	`hasNextRunTime()` Output only.
`boolean`	`hasParams()` Data transfer specific parameters.
`boolean`	`hasUpdateTime()` Output only.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`TransferConfig.Builder`	`mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`TransferConfig.Builder`	`mergeFrom(Message other)`
`TransferConfig.Builder`	`mergeFrom(TransferConfig other)`
`TransferConfig.Builder`	`mergeNextRunTime(Timestamp value)` Output only.
`TransferConfig.Builder`	`mergeParams(Struct value)` Data transfer specific parameters.
`TransferConfig.Builder`	`mergeUnknownFields(UnknownFieldSet unknownFields)`
`TransferConfig.Builder`	`mergeUpdateTime(Timestamp value)` Output only.
`TransferConfig.Builder`	`setDataRefreshWindowDays(int value)` The number of days to look back to automatically refresh the data.
`TransferConfig.Builder`	`setDatasetRegion(java.lang.String value)` Output only.
`TransferConfig.Builder`	`setDatasetRegionBytes(ByteString value)` Output only.
`TransferConfig.Builder`	`setDataSourceId(java.lang.String value)` Data source id.
`TransferConfig.Builder`	`setDataSourceIdBytes(ByteString value)` Data source id.
`TransferConfig.Builder`	`setDestinationDatasetId(java.lang.String value)` The BigQuery target dataset id.
`TransferConfig.Builder`	`setDestinationDatasetIdBytes(ByteString value)` The BigQuery target dataset id.
`TransferConfig.Builder`	`setDisabled(boolean value)` Is this config disabled.
`TransferConfig.Builder`	`setDisplayName(java.lang.String value)` User specified display name for the data transfer.
`TransferConfig.Builder`	`setDisplayNameBytes(ByteString value)` User specified display name for the data transfer.
`TransferConfig.Builder`	`setField(Descriptors.FieldDescriptor field, java.lang.Object value)`
`TransferConfig.Builder`	`setName(java.lang.String value)` The resource name of the transfer config.
`TransferConfig.Builder`	`setNameBytes(ByteString value)` The resource name of the transfer config.
`TransferConfig.Builder`	`setNextRunTime(Timestamp.Builder builderForValue)` Output only.
`TransferConfig.Builder`	`setNextRunTime(Timestamp value)` Output only.
`TransferConfig.Builder`	`setParams(Struct.Builder builderForValue)` Data transfer specific parameters.
`TransferConfig.Builder`	`setParams(Struct value)` Data transfer specific parameters.
`TransferConfig.Builder`	`setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`TransferConfig.Builder`	`setSchedule(java.lang.String value)` Data transfer schedule.
`TransferConfig.Builder`	`setScheduleBytes(ByteString value)` Data transfer schedule.
`TransferConfig.Builder`	`setState(TransferState value)` Output only.
`TransferConfig.Builder`	`setStateValue(int value)` Output only.
`TransferConfig.Builder`	`setUnknownFields(UnknownFieldSet unknownFields)`
`TransferConfig.Builder`	`setUpdateTime(Timestamp.Builder builderForValue)` Output only.
`TransferConfig.Builder`	`setUpdateTime(Timestamp value)` Output only.
`TransferConfig.Builder`	`setUserId(long value)` Output only.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<TransferConfig.Builder>

clear
```
public TransferConfig.Builder clear()
```
Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<TransferConfig.Builder>

getDescriptorForType
```
public Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<TransferConfig.Builder>

getDefaultInstanceForType
```
public TransferConfig getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build
```
public TransferConfig build()
```
Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial
```
public TransferConfig buildPartial()
```
Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone
```
public TransferConfig.Builder clone()
```
Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<TransferConfig.Builder>

setField

public TransferConfig.Builder setField(Descriptors.FieldDescriptor field,
                                       java.lang.Object value)

Specified by:: setField in interface Message.Builder
Overrides:: setField in class GeneratedMessageV3.Builder<TransferConfig.Builder>

clearField
```
public TransferConfig.Builder clearField(Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<TransferConfig.Builder>

clearOneof
```
public TransferConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<TransferConfig.Builder>

setRepeatedField

public TransferConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                               int index,
                                               java.lang.Object value)

Specified by:: setRepeatedField in interface Message.Builder
Overrides:: setRepeatedField in class GeneratedMessageV3.Builder<TransferConfig.Builder>

addRepeatedField

public TransferConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                               java.lang.Object value)

Specified by:: addRepeatedField in interface Message.Builder
Overrides:: addRepeatedField in class GeneratedMessageV3.Builder<TransferConfig.Builder>

mergeFrom
```
public TransferConfig.Builder mergeFrom(Message other)
```
Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<TransferConfig.Builder>

mergeFrom

public TransferConfig.Builder mergeFrom(TransferConfig other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<TransferConfig.Builder>

mergeFrom

public TransferConfig.Builder mergeFrom(CodedInputStream input,
                                        ExtensionRegistryLite extensionRegistry)
                                 throws java.io.IOException

Specified by:: mergeFrom in interface Message.Builder
Specified by:: mergeFrom in interface MessageLite.Builder
Overrides:: mergeFrom in class AbstractMessage.Builder<TransferConfig.Builder>
Throws:: java.io.IOException

getName

public java.lang.String getName()

 The resource name of the transfer config.
 Transfer config names have the form
 `projects/{project_id}/transferConfigs/{config_id}`.
 Where `config_id` is usually a uuid, even though it is not
 guaranteed or required. The name is ignored when creating a transfer
 config.

string name = 1;

Specified by:: getName in interface TransferConfigOrBuilder

getNameBytes

public ByteString getNameBytes()

 The resource name of the transfer config.
 Transfer config names have the form
 `projects/{project_id}/transferConfigs/{config_id}`.
 Where `config_id` is usually a uuid, even though it is not
 guaranteed or required. The name is ignored when creating a transfer
 config.

string name = 1;

Specified by:: getNameBytes in interface TransferConfigOrBuilder

setName

public TransferConfig.Builder setName(java.lang.String value)

 The resource name of the transfer config.
 Transfer config names have the form
 `projects/{project_id}/transferConfigs/{config_id}`.
 Where `config_id` is usually a uuid, even though it is not
 guaranteed or required. The name is ignored when creating a transfer
 config.

string name = 1;

clearName

public TransferConfig.Builder clearName()

 The resource name of the transfer config.
 Transfer config names have the form
 `projects/{project_id}/transferConfigs/{config_id}`.
 Where `config_id` is usually a uuid, even though it is not
 guaranteed or required. The name is ignored when creating a transfer
 config.

string name = 1;

setNameBytes

public TransferConfig.Builder setNameBytes(ByteString value)

 The resource name of the transfer config.
 Transfer config names have the form
 `projects/{project_id}/transferConfigs/{config_id}`.
 Where `config_id` is usually a uuid, even though it is not
 guaranteed or required. The name is ignored when creating a transfer
 config.

string name = 1;

getDestinationDatasetId
```
public java.lang.String getDestinationDatasetId()
```
```
 The BigQuery target dataset id.
 
```
string destination_dataset_id = 2;
Specified by:

getDestinationDatasetId in interface TransferConfigOrBuilder

getDestinationDatasetIdBytes
```
public ByteString getDestinationDatasetIdBytes()
```
```
 The BigQuery target dataset id.
 
```
string destination_dataset_id = 2;
Specified by:

getDestinationDatasetIdBytes in interface TransferConfigOrBuilder

setDestinationDatasetId

public TransferConfig.Builder setDestinationDatasetId(java.lang.String value)

 The BigQuery target dataset id.

string destination_dataset_id = 2;

clearDestinationDatasetId

public TransferConfig.Builder clearDestinationDatasetId()

 The BigQuery target dataset id.

string destination_dataset_id = 2;

setDestinationDatasetIdBytes

public TransferConfig.Builder setDestinationDatasetIdBytes(ByteString value)

 The BigQuery target dataset id.

string destination_dataset_id = 2;

getDisplayName
```
public java.lang.String getDisplayName()
```
```
 User specified display name for the data transfer.
 
```
string display_name = 3;
Specified by:

getDisplayName in interface TransferConfigOrBuilder

getDisplayNameBytes
```
public ByteString getDisplayNameBytes()
```
```
 User specified display name for the data transfer.
 
```
string display_name = 3;
Specified by:

getDisplayNameBytes in interface TransferConfigOrBuilder

setDisplayName

public TransferConfig.Builder setDisplayName(java.lang.String value)

 User specified display name for the data transfer.

string display_name = 3;

clearDisplayName

public TransferConfig.Builder clearDisplayName()

 User specified display name for the data transfer.

string display_name = 3;

setDisplayNameBytes

public TransferConfig.Builder setDisplayNameBytes(ByteString value)

 User specified display name for the data transfer.

string display_name = 3;

getDataSourceId

public java.lang.String getDataSourceId()

 Data source id. Cannot be changed once data transfer is created.

string data_source_id = 5;

Specified by:: getDataSourceId in interface TransferConfigOrBuilder

getDataSourceIdBytes

public ByteString getDataSourceIdBytes()

 Data source id. Cannot be changed once data transfer is created.

string data_source_id = 5;

Specified by:: getDataSourceIdBytes in interface TransferConfigOrBuilder

setDataSourceId

public TransferConfig.Builder setDataSourceId(java.lang.String value)

 Data source id. Cannot be changed once data transfer is created.

string data_source_id = 5;

clearDataSourceId

public TransferConfig.Builder clearDataSourceId()

 Data source id. Cannot be changed once data transfer is created.

string data_source_id = 5;

setDataSourceIdBytes

public TransferConfig.Builder setDataSourceIdBytes(ByteString value)

 Data source id. Cannot be changed once data transfer is created.

string data_source_id = 5;

hasParams
```
public boolean hasParams()
```
```
 Data transfer specific parameters.
 
```
.google.protobuf.Struct params = 9;
Specified by:

hasParams in interface TransferConfigOrBuilder

getParams
```
public Struct getParams()
```
```
 Data transfer specific parameters.
 
```
.google.protobuf.Struct params = 9;
Specified by:

getParams in interface TransferConfigOrBuilder

setParams

public TransferConfig.Builder setParams(Struct value)

 Data transfer specific parameters.

.google.protobuf.Struct params = 9;

setParams

public TransferConfig.Builder setParams(Struct.Builder builderForValue)

 Data transfer specific parameters.

.google.protobuf.Struct params = 9;

mergeParams

public TransferConfig.Builder mergeParams(Struct value)

 Data transfer specific parameters.

.google.protobuf.Struct params = 9;

clearParams

public TransferConfig.Builder clearParams()

 Data transfer specific parameters.

.google.protobuf.Struct params = 9;

getParamsBuilder

public Struct.Builder getParamsBuilder()

 Data transfer specific parameters.

.google.protobuf.Struct params = 9;

getParamsOrBuilder
```
public StructOrBuilder getParamsOrBuilder()
```
```
 Data transfer specific parameters.
 
```
.google.protobuf.Struct params = 9;
Specified by:

getParamsOrBuilder in interface TransferConfigOrBuilder

getSchedule

public java.lang.String getSchedule()

 Data transfer schedule.
 If the data source does not support a custom schedule, this should be
 empty. If it is empty, the default value for the data source will be
 used.
 The specified times are in UTC.
 Examples of valid format:
 `1st,3rd monday of month 15:30`,
 `every wed,fri of jan,jun 13:15`, and
 `first sunday of quarter 00:00`.
 See more explanation about the format here:
 https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
 NOTE: the granularity should be at least 8 hours, or less frequent.

string schedule = 7;

Specified by:: getSchedule in interface TransferConfigOrBuilder

getScheduleBytes

public ByteString getScheduleBytes()

 Data transfer schedule.
 If the data source does not support a custom schedule, this should be
 empty. If it is empty, the default value for the data source will be
 used.
 The specified times are in UTC.
 Examples of valid format:
 `1st,3rd monday of month 15:30`,
 `every wed,fri of jan,jun 13:15`, and
 `first sunday of quarter 00:00`.
 See more explanation about the format here:
 https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
 NOTE: the granularity should be at least 8 hours, or less frequent.

string schedule = 7;

Specified by:: getScheduleBytes in interface TransferConfigOrBuilder

setSchedule

public TransferConfig.Builder setSchedule(java.lang.String value)

 Data transfer schedule.
 If the data source does not support a custom schedule, this should be
 empty. If it is empty, the default value for the data source will be
 used.
 The specified times are in UTC.
 Examples of valid format:
 `1st,3rd monday of month 15:30`,
 `every wed,fri of jan,jun 13:15`, and
 `first sunday of quarter 00:00`.
 See more explanation about the format here:
 https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
 NOTE: the granularity should be at least 8 hours, or less frequent.

string schedule = 7;

clearSchedule

public TransferConfig.Builder clearSchedule()

 Data transfer schedule.
 If the data source does not support a custom schedule, this should be
 empty. If it is empty, the default value for the data source will be
 used.
 The specified times are in UTC.
 Examples of valid format:
 `1st,3rd monday of month 15:30`,
 `every wed,fri of jan,jun 13:15`, and
 `first sunday of quarter 00:00`.
 See more explanation about the format here:
 https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
 NOTE: the granularity should be at least 8 hours, or less frequent.

string schedule = 7;

setScheduleBytes

public TransferConfig.Builder setScheduleBytes(ByteString value)

 Data transfer schedule.
 If the data source does not support a custom schedule, this should be
 empty. If it is empty, the default value for the data source will be
 used.
 The specified times are in UTC.
 Examples of valid format:
 `1st,3rd monday of month 15:30`,
 `every wed,fri of jan,jun 13:15`, and
 `first sunday of quarter 00:00`.
 See more explanation about the format here:
 https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format
 NOTE: the granularity should be at least 8 hours, or less frequent.

string schedule = 7;

getDataRefreshWindowDays

public int getDataRefreshWindowDays()

 The number of days to look back to automatically refresh the data.
 For example, if `data_refresh_window_days = 10`, then every day
 BigQuery reingests data for [today-10, today-1], rather than ingesting data
 for just [today-1].
 Only valid if the data source supports the feature. Set the value to  0
 to use the default value.

int32 data_refresh_window_days = 12;

Specified by:: getDataRefreshWindowDays in interface TransferConfigOrBuilder

setDataRefreshWindowDays

public TransferConfig.Builder setDataRefreshWindowDays(int value)

 The number of days to look back to automatically refresh the data.
 For example, if `data_refresh_window_days = 10`, then every day
 BigQuery reingests data for [today-10, today-1], rather than ingesting data
 for just [today-1].
 Only valid if the data source supports the feature. Set the value to  0
 to use the default value.

int32 data_refresh_window_days = 12;

clearDataRefreshWindowDays

public TransferConfig.Builder clearDataRefreshWindowDays()

 The number of days to look back to automatically refresh the data.
 For example, if `data_refresh_window_days = 10`, then every day
 BigQuery reingests data for [today-10, today-1], rather than ingesting data
 for just [today-1].
 Only valid if the data source supports the feature. Set the value to  0
 to use the default value.

int32 data_refresh_window_days = 12;

getDisabled

public boolean getDisabled()

 Is this config disabled. When set to true, no runs are scheduled
 for a given transfer.

bool disabled = 13;

Specified by:: getDisabled in interface TransferConfigOrBuilder

setDisabled

public TransferConfig.Builder setDisabled(boolean value)

 Is this config disabled. When set to true, no runs are scheduled
 for a given transfer.

bool disabled = 13;

clearDisabled

public TransferConfig.Builder clearDisabled()

 Is this config disabled. When set to true, no runs are scheduled
 for a given transfer.

bool disabled = 13;

hasUpdateTime
```
public boolean hasUpdateTime()
```
```
 Output only. Data transfer modification time. Ignored by server on input.
 
```
.google.protobuf.Timestamp update_time = 4;
Specified by:

hasUpdateTime in interface TransferConfigOrBuilder