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