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
Fields
ALLOWED_VALUES_FIELD_NUMBER
public static final int ALLOWED_VALUES_FIELD_NUMBER
Field Value
DEPRECATED_FIELD_NUMBER
public static final int DEPRECATED_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
FIELDS_FIELD_NUMBER
public static final int FIELDS_FIELD_NUMBER
Field Value
IMMUTABLE_FIELD_NUMBER
public static final int IMMUTABLE_FIELD_NUMBER
Field Value
MAX_VALUE_FIELD_NUMBER
public static final int MAX_VALUE_FIELD_NUMBER
Field Value
MIN_VALUE_FIELD_NUMBER
public static final int MIN_VALUE_FIELD_NUMBER
Field Value
PARAM_ID_FIELD_NUMBER
public static final int PARAM_ID_FIELD_NUMBER
Field Value
RECURSE_FIELD_NUMBER
public static final int RECURSE_FIELD_NUMBER
Field Value
REPEATED_FIELD_NUMBER
public static final int REPEATED_FIELD_NUMBER
Field Value
REQUIRED_FIELD_NUMBER
public static final int REQUIRED_FIELD_NUMBER
Field Value
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
VALIDATION_DESCRIPTION_FIELD_NUMBER
public static final int VALIDATION_DESCRIPTION_FIELD_NUMBER
Field Value
VALIDATION_HELP_URL_FIELD_NUMBER
public static final int VALIDATION_HELP_URL_FIELD_NUMBER
Field Value
VALIDATION_REGEX_FIELD_NUMBER
public static final int VALIDATION_REGEX_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAllowedValues(int index)
public String getAllowedValues(int index)
All possible values for the parameter.
repeated string allowed_values = 8;
| Name | Description |
| index | int
The index of the element to return.
|
Returns
| Type | Description |
| 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;
| Name | Description |
| index | int
The index of the value to return.
|
Returns
| Type | Description |
| 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;
| Type | Description |
| int | The count of allowedValues.
|
getAllowedValuesList()
public ProtocolStringList getAllowedValuesList()
All possible values for the parameter.
repeated string allowed_values = 8;
getDefaultInstance()
public static DataSourceParameter getDefaultInstance()
Returns
getDefaultInstanceForType()
public DataSourceParameter getDefaultInstanceForType()
Returns
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;
| Type | Description |
| boolean | The deprecated.
|
getDescription()
public String getDescription()
Parameter description.
string description = 3;
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Parameter description.
string description = 3;
| Type | Description |
| ByteString | The bytes for description.
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getDisplayName()
public String getDisplayName()
Parameter display name in the user interface.
string display_name = 2;
| Type | Description |
| String | The displayName.
|
getDisplayNameBytes()
public ByteString getDisplayNameBytes()
Parameter display name in the user interface.
string display_name = 2;
| Type | Description |
| 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;
getFieldsCount()
public int getFieldsCount()
Deprecated. This field has no effect.
repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;
getFieldsList()
public List<DataSourceParameter> getFieldsList()
Deprecated. This field has no effect.
repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;
getFieldsOrBuilder(int index)
public DataSourceParameterOrBuilder getFieldsOrBuilder(int index)
Deprecated. This field has no effect.
repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;
getFieldsOrBuilderList()
public List<? extends DataSourceParameterOrBuilder> getFieldsOrBuilderList()
Deprecated. This field has no effect.
repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;
| Type | Description |
| List<? extends com.google.cloud.bigquery.datatransfer.v1.DataSourceParameterOrBuilder> | |
getImmutable()
public boolean getImmutable()
Cannot be changed after initial creation.
bool immutable = 14;
| Type | Description |
| boolean | The immutable.
|
getMaxValue()
public DoubleValue getMaxValue()
For integer and double values specifies maxminum allowed value.
.google.protobuf.DoubleValue max_value = 10;
getMaxValueOrBuilder()
public DoubleValueOrBuilder getMaxValueOrBuilder()
For integer and double values specifies maxminum allowed value.
.google.protobuf.DoubleValue max_value = 10;
getMinValue()
public DoubleValue getMinValue()
For integer and double values specifies minimum allowed value.
.google.protobuf.DoubleValue min_value = 9;
getMinValueOrBuilder()
public DoubleValueOrBuilder getMinValueOrBuilder()
For integer and double values specifies minimum allowed value.
.google.protobuf.DoubleValue min_value = 9;
getParamId()
public String getParamId()
Parameter identifier.
string param_id = 1;
| Type | Description |
| String | The paramId.
|
getParamIdBytes()
public ByteString getParamIdBytes()
Parameter identifier.
string param_id = 1;
getParserForType()
public Parser<DataSourceParameter> getParserForType()
Returns
Overrides
getRecurse()
public boolean getRecurse()
Deprecated. This field has no effect.
bool recurse = 15;
getRepeated()
public boolean getRepeated()
Deprecated. This field has no effect.
bool repeated = 6;
| Type | Description |
| boolean | The repeated.
|
getRequired()
public boolean getRequired()
Is parameter required.
bool required = 5;
| Type | Description |
| boolean | The required.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getType()
public DataSourceParameter.Type getType()
Parameter type.
.google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type type = 4;
getTypeValue()
public int getTypeValue()
Parameter type.
.google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type type = 4;
| Type | Description |
| int | The enum numeric value on the wire for type.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| String | The validationHelpUrl.
|
getValidationHelpUrlBytes()
public ByteString getValidationHelpUrlBytes()
URL to a help document to further explain the naming requirements.
string validation_help_url = 13;
| Type | Description |
| ByteString | The bytes for validationHelpUrl.
|
getValidationRegex()
public String getValidationRegex()
Regular expression which can be used for parameter validation.
string validation_regex = 7;
| Type | Description |
| String | The validationRegex.
|
getValidationRegexBytes()
public ByteString getValidationRegexBytes()
Regular expression which can be used for parameter validation.
string validation_regex = 7;
| Type | Description |
| ByteString | The bytes for validationRegex.
|
hasMaxValue()
public boolean hasMaxValue()
For integer and double values specifies maxminum allowed value.
.google.protobuf.DoubleValue max_value = 10;
| Type | Description |
| 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;
| Type | Description |
| boolean | Whether the minValue field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static DataSourceParameter.Builder newBuilder()
Returns
newBuilder(DataSourceParameter prototype)
public static DataSourceParameter.Builder newBuilder(DataSourceParameter prototype)
Parameter
Returns
newBuilderForType()
public DataSourceParameter.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DataSourceParameter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static DataSourceParameter parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static DataSourceParameter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static DataSourceParameter parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DataSourceParameter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static DataSourceParameter parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataSourceParameter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DataSourceParameter parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static DataSourceParameter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DataSourceParameter parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static DataSourceParameter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static DataSourceParameter parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DataSourceParameter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<DataSourceParameter> parser()
Returns
toBuilder()
public DataSourceParameter.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
