com.google.cloud.bigquery.datatransfer.v1

Class DataSourceParameter

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.bigquery.datatransfer.v1.DataSourceParameter

All Implemented Interfaces:

DataSourceParameterOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

public final class DataSourceParameter
extends GeneratedMessageV3
implements DataSourceParameterOrBuilder

 Represents a data source parameter with validation rules, so that
 parameters can be rendered in the UI. These parameters are given to us by
 supported data sources, and include all needed information for rendering
 and validation.
 Thus, whoever uses this api can decide to generate either generic ui,
 or custom data source specific forms.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataSourceParameter.Builder Represents a data source parameter with validation rules, so that parameters can be rendered in the UI.
static class	DataSourceParameter.Type Parameter type.

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

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALLOWED_VALUES_FIELD_NUMBER
static int	DESCRIPTION_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	FIELDS_FIELD_NUMBER
static int	IMMUTABLE_FIELD_NUMBER
static int	MAX_VALUE_FIELD_NUMBER
static int	MIN_VALUE_FIELD_NUMBER
static int	PARAM_ID_FIELD_NUMBER
static int	RECURSE_FIELD_NUMBER
static int	REPEATED_FIELD_NUMBER
static int	REQUIRED_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER
static int	VALIDATION_DESCRIPTION_FIELD_NUMBER
static int	VALIDATION_HELP_URL_FIELD_NUMBER
static int	VALIDATION_REGEX_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(java.lang.Object obj)
java.lang.String	getAllowedValues(int index) All possible values for the parameter.
ByteString	getAllowedValuesBytes(int index) All possible values for the parameter.
int	getAllowedValuesCount() All possible values for the parameter.
ProtocolStringList	getAllowedValuesList() All possible values for the parameter.
static DataSourceParameter	getDefaultInstance()
DataSourceParameter	getDefaultInstanceForType()
java.lang.String	getDescription() Parameter description.
ByteString	getDescriptionBytes() Parameter description.
static Descriptors.Descriptor	getDescriptor()
java.lang.String	getDisplayName() Parameter display name in the user interface.
ByteString	getDisplayNameBytes() Parameter display name in the user interface.
DataSourceParameter	getFields(int index) When parameter is a record, describes child fields.
int	getFieldsCount() When parameter is a record, describes child fields.
java.util.List<DataSourceParameter>	getFieldsList() When parameter is a record, describes child fields.
DataSourceParameterOrBuilder	getFieldsOrBuilder(int index) When parameter is a record, describes child fields.
java.util.List<? extends DataSourceParameterOrBuilder>	getFieldsOrBuilderList() When parameter is a record, describes child fields.
boolean	getImmutable() Cannot be changed after initial creation.
DoubleValue	getMaxValue() For integer and double values specifies maxminum allowed value.
DoubleValueOrBuilder	getMaxValueOrBuilder() For integer and double values specifies maxminum allowed value.
DoubleValue	getMinValue() For integer and double values specifies minimum allowed value.
DoubleValueOrBuilder	getMinValueOrBuilder() For integer and double values specifies minimum allowed value.
java.lang.String	getParamId() Parameter identifier.
ByteString	getParamIdBytes() Parameter identifier.
Parser<DataSourceParameter>	getParserForType()
boolean	getRecurse() If set to true, schema should be taken from the parent with the same parameter_id.
boolean	getRepeated() Can parameter have multiple values.
boolean	getRequired() Is parameter required.
int	getSerializedSize()
DataSourceParameter.Type	getType() Parameter type.
int	getTypeValue() Parameter type.
UnknownFieldSet	getUnknownFields()
java.lang.String	getValidationDescription() Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
ByteString	getValidationDescriptionBytes() Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.
java.lang.String	getValidationHelpUrl() URL to a help document to further explain the naming requirements.
ByteString	getValidationHelpUrlBytes() URL to a help document to further explain the naming requirements.
java.lang.String	getValidationRegex() Regular expression which can be used for parameter validation.
ByteString	getValidationRegexBytes() Regular expression which can be used for parameter validation.
int	hashCode()
boolean	hasMaxValue() For integer and double values specifies maxminum allowed value.
boolean	hasMinValue() For integer and double values specifies minimum allowed value.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DataSourceParameter.Builder	newBuilder()
static DataSourceParameter.Builder	newBuilder(DataSourceParameter prototype)
DataSourceParameter.Builder	newBuilderForType()
protected DataSourceParameter.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static DataSourceParameter	parseDelimitedFrom(java.io.InputStream input)
static DataSourceParameter	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static DataSourceParameter	parseFrom(byte[] data)
static DataSourceParameter	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static DataSourceParameter	parseFrom(java.nio.ByteBuffer data)
static DataSourceParameter	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static DataSourceParameter	parseFrom(ByteString data)
static DataSourceParameter	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static DataSourceParameter	parseFrom(CodedInputStream input)
static DataSourceParameter	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static DataSourceParameter	parseFrom(java.io.InputStream input)
static DataSourceParameter	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<DataSourceParameter>	parser()
DataSourceParameter.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PARAM_ID_FIELD_NUMBER

public static final int PARAM_ID_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

REQUIRED_FIELD_NUMBER

public static final int REQUIRED_FIELD_NUMBER

See Also:

Constant Field Values

REPEATED_FIELD_NUMBER

public static final int REPEATED_FIELD_NUMBER

See Also:

Constant Field Values

VALIDATION_REGEX_FIELD_NUMBER

public static final int VALIDATION_REGEX_FIELD_NUMBER

See Also:

Constant Field Values

ALLOWED_VALUES_FIELD_NUMBER

public static final int ALLOWED_VALUES_FIELD_NUMBER

See Also:

Constant Field Values

MIN_VALUE_FIELD_NUMBER

public static final int MIN_VALUE_FIELD_NUMBER

See Also:

Constant Field Values

MAX_VALUE_FIELD_NUMBER

public static final int MAX_VALUE_FIELD_NUMBER

See Also:

Constant Field Values

FIELDS_FIELD_NUMBER

public static final int FIELDS_FIELD_NUMBER

See Also:

Constant Field Values

VALIDATION_DESCRIPTION_FIELD_NUMBER

public static final int VALIDATION_DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

VALIDATION_HELP_URL_FIELD_NUMBER

public static final int VALIDATION_HELP_URL_FIELD_NUMBER

See Also:

Constant Field Values

IMMUTABLE_FIELD_NUMBER

public static final int IMMUTABLE_FIELD_NUMBER

See Also:

Constant Field Values

RECURSE_FIELD_NUMBER

public static final int RECURSE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getParamId

public java.lang.String getParamId()

 Parameter identifier.
 

string param_id = 1;

Specified by:

getParamId in interface DataSourceParameterOrBuilder

getParamIdBytes

public ByteString getParamIdBytes()

 Parameter identifier.
 

string param_id = 1;

Specified by:

getParamIdBytes in interface DataSourceParameterOrBuilder

getDisplayName

public java.lang.String getDisplayName()

 Parameter display name in the user interface.
 

string display_name = 2;

Specified by:

getDisplayName in interface DataSourceParameterOrBuilder

getDisplayNameBytes

public ByteString getDisplayNameBytes()

 Parameter display name in the user interface.
 

string display_name = 2;

Specified by:

getDisplayNameBytes in interface DataSourceParameterOrBuilder

getDescription

public java.lang.String getDescription()

 Parameter description.
 

string description = 3;

Specified by:

getDescription in interface DataSourceParameterOrBuilder

getDescriptionBytes

public ByteString getDescriptionBytes()

 Parameter description.
 

string description = 3;

Specified by:

getDescriptionBytes in interface DataSourceParameterOrBuilder

getTypeValue

public int getTypeValue()

 Parameter type.
 

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

Specified by:

getTypeValue in interface DataSourceParameterOrBuilder

getType

public DataSourceParameter.Type getType()

 Parameter type.
 

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

Specified by:

getType in interface DataSourceParameterOrBuilder

getRequired

public boolean getRequired()

 Is parameter required.
 

bool required = 5;

Specified by:

getRequired in interface DataSourceParameterOrBuilder

getRepeated

public boolean getRepeated()

 Can parameter have multiple values.
 

bool repeated = 6;

Specified by:

getRepeated in interface DataSourceParameterOrBuilder

getValidationRegex

public java.lang.String getValidationRegex()

 Regular expression which can be used for parameter validation.
 

string validation_regex = 7;

Specified by:

getValidationRegex in interface DataSourceParameterOrBuilder

getValidationRegexBytes

public ByteString getValidationRegexBytes()

 Regular expression which can be used for parameter validation.
 

string validation_regex = 7;

Specified by:

getValidationRegexBytes in interface DataSourceParameterOrBuilder

getAllowedValuesList

public ProtocolStringList getAllowedValuesList()

 All possible values for the parameter.
 

repeated string allowed_values = 8;

Specified by:

getAllowedValuesList in interface DataSourceParameterOrBuilder

getAllowedValuesCount

public int getAllowedValuesCount()

 All possible values for the parameter.
 

repeated string allowed_values = 8;

Specified by:

getAllowedValuesCount in interface DataSourceParameterOrBuilder

getAllowedValues

public java.lang.String getAllowedValues(int index)

 All possible values for the parameter.
 

repeated string allowed_values = 8;

Specified by:

getAllowedValues in interface DataSourceParameterOrBuilder

getAllowedValuesBytes

public ByteString getAllowedValuesBytes(int index)

 All possible values for the parameter.
 

repeated string allowed_values = 8;

Specified by:

getAllowedValuesBytes in interface DataSourceParameterOrBuilder

hasMinValue

public boolean hasMinValue()

 For integer and double values specifies minimum allowed value.
 

.google.protobuf.DoubleValue min_value = 9;

Specified by:

hasMinValue in interface DataSourceParameterOrBuilder

getMinValue

public DoubleValue getMinValue()

 For integer and double values specifies minimum allowed value.
 

.google.protobuf.DoubleValue min_value = 9;

Specified by:

getMinValue in interface DataSourceParameterOrBuilder

getMinValueOrBuilder

public DoubleValueOrBuilder getMinValueOrBuilder()

 For integer and double values specifies minimum allowed value.
 

.google.protobuf.DoubleValue min_value = 9;

Specified by:

getMinValueOrBuilder in interface DataSourceParameterOrBuilder

hasMaxValue

public boolean hasMaxValue()

 For integer and double values specifies maxminum allowed value.
 

.google.protobuf.DoubleValue max_value = 10;

Specified by:

hasMaxValue in interface DataSourceParameterOrBuilder

getMaxValue

public DoubleValue getMaxValue()

 For integer and double values specifies maxminum allowed value.
 

.google.protobuf.DoubleValue max_value = 10;

Specified by:

getMaxValue in interface DataSourceParameterOrBuilder

getMaxValueOrBuilder

public DoubleValueOrBuilder getMaxValueOrBuilder()

 For integer and double values specifies maxminum allowed value.
 

.google.protobuf.DoubleValue max_value = 10;

Specified by:

getMaxValueOrBuilder in interface DataSourceParameterOrBuilder

getFieldsList

public java.util.List<DataSourceParameter> getFieldsList()

 When parameter is a record, describes child fields.
 

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

Specified by:

getFieldsList in interface DataSourceParameterOrBuilder

getFieldsOrBuilderList

public java.util.List<? extends DataSourceParameterOrBuilder> getFieldsOrBuilderList()

 When parameter is a record, describes child fields.
 

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

Specified by:

getFieldsOrBuilderList in interface DataSourceParameterOrBuilder

getFieldsCount

public int getFieldsCount()

 When parameter is a record, describes child fields.
 

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

Specified by:

getFieldsCount in interface DataSourceParameterOrBuilder

getFields

public DataSourceParameter getFields(int index)

 When parameter is a record, describes child fields.
 

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

Specified by:

getFields in interface DataSourceParameterOrBuilder

getFieldsOrBuilder

public DataSourceParameterOrBuilder getFieldsOrBuilder(int index)

 When parameter is a record, describes child fields.
 

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

Specified by:

getFieldsOrBuilder in interface DataSourceParameterOrBuilder

getValidationDescription

public java.lang.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;

Specified by:

getValidationDescription in interface DataSourceParameterOrBuilder

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;

Specified by:

getValidationDescriptionBytes in interface DataSourceParameterOrBuilder

getValidationHelpUrl

public java.lang.String getValidationHelpUrl()

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

string validation_help_url = 13;

Specified by:

getValidationHelpUrl in interface DataSourceParameterOrBuilder

getValidationHelpUrlBytes

public ByteString getValidationHelpUrlBytes()

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

string validation_help_url = 13;

Specified by:

getValidationHelpUrlBytes in interface DataSourceParameterOrBuilder

getImmutable

public boolean getImmutable()

 Cannot be changed after initial creation.
 

bool immutable = 14;

Specified by:

getImmutable in interface DataSourceParameterOrBuilder

getRecurse

public boolean getRecurse()

 If set to true, schema should be taken from the parent with the same
 parameter_id. Only applicable when parameter type is RECORD.
 

bool recurse = 15;

Specified by:

getRecurse in interface DataSourceParameterOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static DataSourceParameter parseFrom(java.nio.ByteBuffer data)
                                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DataSourceParameter parseFrom(java.nio.ByteBuffer data,
                                            ExtensionRegistryLite extensionRegistry)
                                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DataSourceParameter parseFrom(ByteString data)
                                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DataSourceParameter parseFrom(ByteString data,
                                            ExtensionRegistryLite extensionRegistry)
                                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DataSourceParameter parseFrom(byte[] data)
                                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DataSourceParameter parseFrom(byte[] data,
                                            ExtensionRegistryLite extensionRegistry)
                                     throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static DataSourceParameter parseFrom(java.io.InputStream input)
                                     throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static DataSourceParameter parseFrom(java.io.InputStream input,
                                            ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static DataSourceParameter parseDelimitedFrom(java.io.InputStream input)
                                              throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static DataSourceParameter parseDelimitedFrom(java.io.InputStream input,
                                                     ExtensionRegistryLite extensionRegistry)
                                              throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static DataSourceParameter parseFrom(CodedInputStream input)
                                     throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static DataSourceParameter parseFrom(CodedInputStream input,
                                            ExtensionRegistryLite extensionRegistry)
                                     throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public DataSourceParameter.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static DataSourceParameter.Builder newBuilder()

newBuilder

public static DataSourceParameter.Builder newBuilder(DataSourceParameter prototype)

toBuilder

public DataSourceParameter.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected DataSourceParameter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static DataSourceParameter getDefaultInstance()

parser

public static Parser<DataSourceParameter> parser()

getParserForType

public Parser<DataSourceParameter> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public DataSourceParameter getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder