Class DataSourceParameter.Builder (2.10.0)

Stay organized with collections Save and categorize content based on your preferences.
public static final class DataSourceParameter.Builder extends GeneratedMessageV3.Builder<DataSourceParameter.Builder> implements DataSourceParameterOrBuilder

A parameter used to define custom fields in a data source definition.

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

Static Methods

getDescriptor()

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

Methods

addAllAllowedValues(Iterable<String> values)

public DataSourceParameter.Builder addAllAllowedValues(Iterable<String> values)

All possible values for the parameter.

repeated string allowed_values = 8;

Parameter
NameDescription
valuesIterable<String>

The allowedValues to add.

Returns
TypeDescription
DataSourceParameter.Builder

This builder for chaining.

addAllFields(Iterable<? extends DataSourceParameter> values)

public DataSourceParameter.Builder addAllFields(Iterable<? extends DataSourceParameter> values)

Deprecated. This field has no effect.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;

Parameter
NameDescription
valuesIterable<? extends com.google.cloud.bigquery.datatransfer.v1.DataSourceParameter>
Returns
TypeDescription
DataSourceParameter.Builder

addAllowedValues(String value)

public DataSourceParameter.Builder addAllowedValues(String value)

All possible values for the parameter.

repeated string allowed_values = 8;

Parameter
NameDescription
valueString

The allowedValues to add.

Returns
TypeDescription
DataSourceParameter.Builder

This builder for chaining.

addAllowedValuesBytes(ByteString value)

public DataSourceParameter.Builder addAllowedValuesBytes(ByteString value)

All possible values for the parameter.

repeated string allowed_values = 8;

Parameter
NameDescription
valueByteString

The bytes of the allowedValues to add.

Returns
TypeDescription
DataSourceParameter.Builder

This builder for chaining.

addFields(DataSourceParameter value)

public DataSourceParameter.Builder addFields(DataSourceParameter value)

Deprecated. This field has no effect.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;

Parameter
NameDescription
valueDataSourceParameter
Returns
TypeDescription
DataSourceParameter.Builder

addFields(DataSourceParameter.Builder builderForValue)

public DataSourceParameter.Builder addFields(DataSourceParameter.Builder builderForValue)

Deprecated. This field has no effect.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;

Parameter
NameDescription
builderForValueDataSourceParameter.Builder
Returns
TypeDescription
DataSourceParameter.Builder

addFields(int index, DataSourceParameter value)

public DataSourceParameter.Builder addFields(int index, DataSourceParameter value)

Deprecated. This field has no effect.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;

Parameters
NameDescription
indexint
valueDataSourceParameter
Returns
TypeDescription
DataSourceParameter.Builder

addFields(int index, DataSourceParameter.Builder builderForValue)

public DataSourceParameter.Builder addFields(int index, DataSourceParameter.Builder builderForValue)

Deprecated. This field has no effect.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;

Parameters
NameDescription
indexint
builderForValueDataSourceParameter.Builder
Returns
TypeDescription
DataSourceParameter.Builder

addFieldsBuilder()

public DataSourceParameter.Builder addFieldsBuilder()

Deprecated. This field has no effect.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;

Returns
TypeDescription
DataSourceParameter.Builder

addFieldsBuilder(int index)

public DataSourceParameter.Builder addFieldsBuilder(int index)

Deprecated. This field has no effect.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;

Parameter
NameDescription
indexint
Returns
TypeDescription
DataSourceParameter.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DataSourceParameter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
DataSourceParameter.Builder
Overrides

build()

public DataSourceParameter build()
Returns
TypeDescription
DataSourceParameter

buildPartial()

public DataSourceParameter buildPartial()
Returns
TypeDescription
DataSourceParameter

clear()

public DataSourceParameter.Builder clear()
Returns
TypeDescription
DataSourceParameter.Builder
Overrides

clearAllowedValues()

public DataSourceParameter.Builder clearAllowedValues()

All possible values for the parameter.

repeated string allowed_values = 8;

Returns
TypeDescription
DataSourceParameter.Builder

This builder for chaining.

clearDeprecated()

public DataSourceParameter.Builder clearDeprecated()

If true, it should not be used in new transfers, and it should not be visible to users.

bool deprecated = 20;

Returns
TypeDescription
DataSourceParameter.Builder

This builder for chaining.

clearDescription()

public DataSourceParameter.Builder clearDescription()

Parameter description.

string description = 3;

Returns
TypeDescription
DataSourceParameter.Builder

This builder for chaining.

clearDisplayName()

public DataSourceParameter.Builder clearDisplayName()

Parameter display name in the user interface.

string display_name = 2;

Returns
TypeDescription
DataSourceParameter.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public DataSourceParameter.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
DataSourceParameter.Builder
Overrides

clearFields()

public DataSourceParameter.Builder clearFields()

Deprecated. This field has no effect.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;

Returns
TypeDescription
DataSourceParameter.Builder

clearImmutable()

public DataSourceParameter.Builder clearImmutable()

Cannot be changed after initial creation.

bool immutable = 14;

Returns
TypeDescription
DataSourceParameter.Builder

This builder for chaining.

clearMaxValue()

public DataSourceParameter.Builder clearMaxValue()

For integer and double values specifies maximum allowed value.

.google.protobuf.DoubleValue max_value = 10;

Returns
TypeDescription
DataSourceParameter.Builder

clearMinValue()

public DataSourceParameter.Builder clearMinValue()

For integer and double values specifies minimum allowed value.

.google.protobuf.DoubleValue min_value = 9;

Returns
TypeDescription
DataSourceParameter.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public DataSourceParameter.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
DataSourceParameter.Builder
Overrides

clearParamId()

public DataSourceParameter.Builder clearParamId()

Parameter identifier.

string param_id = 1;

Returns
TypeDescription
DataSourceParameter.Builder

This builder for chaining.

clearRecurse()

public DataSourceParameter.Builder clearRecurse()

Deprecated. This field has no effect.

bool recurse = 15;

Returns
TypeDescription
DataSourceParameter.Builder

This builder for chaining.

clearRepeated()

public DataSourceParameter.Builder clearRepeated()

Deprecated. This field has no effect.

bool repeated = 6;

Returns
TypeDescription
DataSourceParameter.Builder

This builder for chaining.

clearRequired()

public DataSourceParameter.Builder clearRequired()

Is parameter required.

bool required = 5;

Returns
TypeDescription
DataSourceParameter.Builder

This builder for chaining.

clearType()

public DataSourceParameter.Builder clearType()

Parameter type.

.google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type type = 4;

Returns
TypeDescription
DataSourceParameter.Builder

This builder for chaining.

clearValidationDescription()

public DataSourceParameter.Builder clearValidationDescription()

Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.

string validation_description = 12;

Returns
TypeDescription
DataSourceParameter.Builder

This builder for chaining.

clearValidationHelpUrl()

public DataSourceParameter.Builder clearValidationHelpUrl()

URL to a help document to further explain the naming requirements.

string validation_help_url = 13;

Returns
TypeDescription
DataSourceParameter.Builder

This builder for chaining.

clearValidationRegex()

public DataSourceParameter.Builder clearValidationRegex()

Regular expression which can be used for parameter validation.

string validation_regex = 7;

Returns
TypeDescription
DataSourceParameter.Builder

This builder for chaining.

clone()

public DataSourceParameter.Builder clone()
Returns
TypeDescription
DataSourceParameter.Builder
Overrides

getAllowedValues(int index)

public String getAllowedValues(int index)

All possible values for the parameter.

repeated string allowed_values = 8;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The allowedValues at the given index.

getAllowedValuesBytes(int index)

public ByteString getAllowedValuesBytes(int index)

All possible values for the parameter.

repeated string allowed_values = 8;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the allowedValues at the given index.

getAllowedValuesCount()

public int getAllowedValuesCount()

All possible values for the parameter.

repeated string allowed_values = 8;

Returns
TypeDescription
int

The count of allowedValues.

getAllowedValuesList()

public ProtocolStringList getAllowedValuesList()

All possible values for the parameter.

repeated string allowed_values = 8;

Returns
TypeDescription
ProtocolStringList

A list containing the allowedValues.

getDefaultInstanceForType()

public DataSourceParameter getDefaultInstanceForType()
Returns
TypeDescription
DataSourceParameter

getDeprecated()

public boolean getDeprecated()

If true, it should not be used in new transfers, and it should not be visible to users.

bool deprecated = 20;

Returns
TypeDescription
boolean

The deprecated.

getDescription()

public String getDescription()

Parameter description.

string description = 3;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Parameter description.

string description = 3;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Parameter display name in the user interface.

string display_name = 2;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Parameter display name in the user interface.

string display_name = 2;

Returns
TypeDescription
ByteString

The bytes for displayName.

getFields(int index)

public DataSourceParameter getFields(int index)

Deprecated. This field has no effect.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;

Parameter
NameDescription
indexint
Returns
TypeDescription
DataSourceParameter

getFieldsBuilder(int index)

public DataSourceParameter.Builder getFieldsBuilder(int index)

Deprecated. This field has no effect.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;

Parameter
NameDescription
indexint
Returns
TypeDescription
DataSourceParameter.Builder

getFieldsBuilderList()

public List<DataSourceParameter.Builder> getFieldsBuilderList()

Deprecated. This field has no effect.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;

Returns
TypeDescription
List<Builder>

getFieldsCount()

public int getFieldsCount()

Deprecated. This field has no effect.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;

Returns
TypeDescription
int

getFieldsList()

public List<DataSourceParameter> getFieldsList()

Deprecated. This field has no effect.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;

Returns
TypeDescription
List<DataSourceParameter>

getFieldsOrBuilder(int index)

public DataSourceParameterOrBuilder getFieldsOrBuilder(int index)

Deprecated. This field has no effect.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;

Parameter
NameDescription
indexint
Returns
TypeDescription
DataSourceParameterOrBuilder

getFieldsOrBuilderList()

public List<? extends DataSourceParameterOrBuilder> getFieldsOrBuilderList()

Deprecated. This field has no effect.

repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;

Returns
TypeDescription
List<? extends com.google.cloud.bigquery.datatransfer.v1.DataSourceParameterOrBuilder>

getImmutable()

public boolean getImmutable()

Cannot be changed after initial creation.

bool immutable = 14;

Returns
TypeDescription
boolean

The immutable.

getMaxValue()

public DoubleValue getMaxValue()

For integer and double values specifies maximum allowed value.

.google.protobuf.DoubleValue max_value = 10;

Returns
TypeDescription
DoubleValue

The maxValue.

getMaxValueBuilder()

public DoubleValue.Builder getMaxValueBuilder()

For integer and double values specifies maximum allowed value.

.google.protobuf.DoubleValue max_value = 10;

Returns
TypeDescription
Builder

getMaxValueOrBuilder()

public DoubleValueOrBuilder getMaxValueOrBuilder()

For integer and double values specifies maximum allowed value.

.google.protobuf.DoubleValue max_value = 10;

Returns
TypeDescription
DoubleValueOrBuilder

getMinValue()

public DoubleValue getMinValue()

For integer and double values specifies minimum allowed value.

.google.protobuf.DoubleValue min_value = 9;

Returns
TypeDescription
DoubleValue

The minValue.

getMinValueBuilder()

public DoubleValue.Builder getMinValueBuilder()

For integer and double values specifies minimum allowed value.

.google.protobuf.DoubleValue min_value = 9;

Returns
TypeDescription
Builder

getMinValueOrBuilder()

public DoubleValueOrBuilder getMinValueOrBuilder()

For integer and double values specifies minimum allowed value.

.google.protobuf.DoubleValue min_value = 9;

Returns
TypeDescription
DoubleValueOrBuilder

getParamId()

public String getParamId()

Parameter identifier.

string param_id = 1;

Returns
TypeDescription
String

The paramId.

getParamIdBytes()

public ByteString getParamIdBytes()

Parameter identifier.

string param_id = 1;

Returns
TypeDescription
ByteString

The bytes for paramId.

getRecurse()

public boolean getRecurse()

Deprecated. This field has no effect.

bool recurse = 15;

Returns
TypeDescription
boolean

The recurse.

getRepeated()

public boolean getRepeated()

Deprecated. This field has no effect.

bool repeated = 6;

Returns
TypeDescription
boolean

The repeated.

getRequired()

public boolean getRequired()

Is parameter required.

bool required = 5;

Returns
TypeDescription
boolean

The required.

getType()

public DataSourceParameter.Type getType()

Parameter type.

.google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type type = 4;

Returns
TypeDescription
DataSourceParameter.Type

The type.

getTypeValue()

public int getTypeValue()

Parameter type.

.google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type type = 4;

Returns
TypeDescription
int

The enum numeric value on the wire for type.

getValidationDescription()

public String getValidationDescription()

Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.

string validation_description = 12;

Returns
TypeDescription
String

The validationDescription.

getValidationDescriptionBytes()

public ByteString getValidationDescriptionBytes()

Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.

string validation_description = 12;

Returns
TypeDescription
ByteString

The bytes for validationDescription.

getValidationHelpUrl()

public String getValidationHelpUrl()

URL to a help document to further explain the naming requirements.

string validation_help_url = 13;

Returns
TypeDescription
String

The validationHelpUrl.

getValidationHelpUrlBytes()

public ByteString getValidationHelpUrlBytes()

URL to a help document to further explain the naming requirements.

string validation_help_url = 13;

Returns
TypeDescription
ByteString

The bytes for validationHelpUrl.

getValidationRegex()

public String getValidationRegex()

Regular expression which can be used for parameter validation.

string validation_regex = 7;

Returns
TypeDescription
String

The validationRegex.

getValidationRegexBytes()

public ByteString getValidationRegexBytes()

Regular expression which can be used for parameter validation.

string validation_regex = 7;

Returns
TypeDescription
ByteString

The bytes for validationRegex.

hasMaxValue()

public boolean hasMaxValue()

For integer and double values specifies maximum allowed value.

.google.protobuf.DoubleValue max_value = 10;

Returns
TypeDescription
boolean

Whether the maxValue field is set.

hasMinValue()

public boolean hasMinValue()

For integer and double values specifies minimum allowed value.

.google.protobuf.DoubleValue min_value = 9;

Returns
TypeDescription