com.google.cloud.bigquery.datatransfer.v1

Interface DataSourceParameterOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

DataSourceParameter, DataSourceParameter.Builder

public interface DataSourceParameterOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAllowedValues(int index) All possible values for the parameter.
com.google.protobuf.ByteString	getAllowedValuesBytes(int index) All possible values for the parameter.
int	getAllowedValuesCount() All possible values for the parameter.
List<String>	getAllowedValuesList() All possible values for the parameter.
boolean	getDeprecated() If true, it should not be used in new transfers, and it should not be visible to users.
String	getDescription() Parameter description.
com.google.protobuf.ByteString	getDescriptionBytes() Parameter description.
String	getDisplayName() Parameter display name in the user interface.
com.google.protobuf.ByteString	getDisplayNameBytes() Parameter display name in the user interface.
DataSourceParameter	getFields(int index) Deprecated.
int	getFieldsCount() Deprecated.
List<DataSourceParameter>	getFieldsList() Deprecated.
DataSourceParameterOrBuilder	getFieldsOrBuilder(int index) Deprecated.
List<? extends DataSourceParameterOrBuilder>	getFieldsOrBuilderList() Deprecated.
boolean	getImmutable() Cannot be changed after initial creation.
com.google.protobuf.DoubleValue	getMaxValue() For integer and double values specifies maximum allowed value.
com.google.protobuf.DoubleValueOrBuilder	getMaxValueOrBuilder() For integer and double values specifies maximum allowed value.
com.google.protobuf.DoubleValue	getMinValue() For integer and double values specifies minimum allowed value.
com.google.protobuf.DoubleValueOrBuilder	getMinValueOrBuilder() For integer and double values specifies minimum allowed value.
String	getParamId() Parameter identifier.
com.google.protobuf.ByteString	getParamIdBytes() Parameter identifier.
boolean	getRecurse() Deprecated.
boolean	getRepeated() Deprecated.
boolean	getRequired() Is parameter required.
DataSourceParameter.Type	getType() Parameter type.
int	getTypeValue() Parameter type.
String	getValidationDescription() Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
com.google.protobuf.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	getValidationHelpUrl() URL to a help document to further explain the naming requirements.
com.google.protobuf.ByteString	getValidationHelpUrlBytes() URL to a help document to further explain the naming requirements.
String	getValidationRegex() Regular expression which can be used for parameter validation.
com.google.protobuf.ByteString	getValidationRegexBytes() Regular expression which can be used for parameter validation.
boolean	hasMaxValue() For integer and double values specifies maximum allowed value.
boolean	hasMinValue() For integer and double values specifies minimum allowed value.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParamId

String getParamId()

 Parameter identifier.
 

string param_id = 1;

Returns:

The paramId.

getParamIdBytes

com.google.protobuf.ByteString getParamIdBytes()

 Parameter identifier.
 

string param_id = 1;

Returns:

The bytes for paramId.

getDisplayName

String getDisplayName()

 Parameter display name in the user interface.
 

string display_name = 2;

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 Parameter display name in the user interface.
 

string display_name = 2;

Returns:

The bytes for displayName.

getDescription

String getDescription()

 Parameter description.
 

string description = 3;

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 Parameter description.
 

string description = 3;

Returns:

The bytes for description.

getTypeValue

int getTypeValue()

 Parameter type.
 

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

Returns:

The enum numeric value on the wire for type.

getType

DataSourceParameter.Type getType()

 Parameter type.
 

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

Returns:

The type.

getRequired

boolean getRequired()

 Is parameter required.
 

bool required = 5;

Returns:

The required.

getRepeated

boolean getRepeated()

 Deprecated. This field has no effect.
 

bool repeated = 6;

Returns:

The repeated.

getValidationRegex

String getValidationRegex()

 Regular expression which can be used for parameter validation.
 

string validation_regex = 7;

Returns:

The validationRegex.

getValidationRegexBytes

com.google.protobuf.ByteString getValidationRegexBytes()

 Regular expression which can be used for parameter validation.
 

string validation_regex = 7;

Returns:

The bytes for validationRegex.

getAllowedValuesList

List<String> getAllowedValuesList()

 All possible values for the parameter.
 

repeated string allowed_values = 8;

Returns:

A list containing the allowedValues.

getAllowedValuesCount

int getAllowedValuesCount()

 All possible values for the parameter.
 

repeated string allowed_values = 8;

Returns:

The count of allowedValues.

getAllowedValues

String getAllowedValues(int index)

 All possible values for the parameter.
 

repeated string allowed_values = 8;

Parameters:

index - The index of the element to return.

Returns:

The allowedValues at the given index.

getAllowedValuesBytes

com.google.protobuf.ByteString getAllowedValuesBytes(int index)

 All possible values for the parameter.
 

repeated string allowed_values = 8;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the allowedValues at the given index.

hasMinValue

boolean hasMinValue()

 For integer and double values specifies minimum allowed value.
 

.google.protobuf.DoubleValue min_value = 9;

Returns:

Whether the minValue field is set.

getMinValue

com.google.protobuf.DoubleValue getMinValue()

 For integer and double values specifies minimum allowed value.
 

.google.protobuf.DoubleValue min_value = 9;

Returns:

The minValue.

getMinValueOrBuilder

com.google.protobuf.DoubleValueOrBuilder getMinValueOrBuilder()

 For integer and double values specifies minimum allowed value.
 

.google.protobuf.DoubleValue min_value = 9;

hasMaxValue

boolean hasMaxValue()

 For integer and double values specifies maximum allowed value.
 

.google.protobuf.DoubleValue max_value = 10;

Returns:

Whether the maxValue field is set.

getMaxValue

com.google.protobuf.DoubleValue getMaxValue()

 For integer and double values specifies maximum allowed value.
 

.google.protobuf.DoubleValue max_value = 10;

Returns:

The maxValue.

getMaxValueOrBuilder

com.google.protobuf.DoubleValueOrBuilder getMaxValueOrBuilder()

 For integer and double values specifies maximum allowed value.
 

.google.protobuf.DoubleValue max_value = 10;

getFieldsList

List<DataSourceParameter> getFieldsList()

 Deprecated. This field has no effect.
 

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

getFields

DataSourceParameter getFields(int index)

 Deprecated. This field has no effect.
 

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

getFieldsCount

int getFieldsCount()

 Deprecated. This field has no effect.
 

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

getFieldsOrBuilderList

List<? extends DataSourceParameterOrBuilder> getFieldsOrBuilderList()

 Deprecated. This field has no effect.
 

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

getFieldsOrBuilder

DataSourceParameterOrBuilder getFieldsOrBuilder(int index)

 Deprecated. This field has no effect.
 

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

getValidationDescription

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:

The validationDescription.

getValidationDescriptionBytes

com.google.protobuf.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:

The bytes for validationDescription.

getValidationHelpUrl

String getValidationHelpUrl()

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

string validation_help_url = 13;

Returns:

The validationHelpUrl.

getValidationHelpUrlBytes

com.google.protobuf.ByteString getValidationHelpUrlBytes()

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

string validation_help_url = 13;

Returns:

The bytes for validationHelpUrl.

getImmutable

boolean getImmutable()

 Cannot be changed after initial creation.
 

bool immutable = 14;

Returns:

The immutable.

getRecurse

boolean getRecurse()

 Deprecated. This field has no effect.
 

bool recurse = 15;

Returns:

The recurse.

getDeprecated

boolean getDeprecated()

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

bool deprecated = 20;

Returns:

The deprecated.