Package com.google.cloud.bigquery.datatransfer.v1

Class DataSourceParameter

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.bigquery.datatransfer.v1.DataSourceParameter
All Implemented Interfaces:
DataSourceParameterOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DataSourceParameter extends com.google.protobuf.GeneratedMessage implements DataSourceParameterOrBuilder
 A parameter used to define custom fields in a data source definition.
Protobuf type google.cloud.bigquery.datatransfer.v1.DataSourceParameter
See Also:

  • Field Details

    • PARAM_ID_FIELD_NUMBER

      public static final int PARAM_ID_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • TYPE_FIELD_NUMBER

      public static final int TYPE_FIELD_NUMBER
      See Also:

    • REQUIRED_FIELD_NUMBER

      public static final int REQUIRED_FIELD_NUMBER
      See Also:

    • REPEATED_FIELD_NUMBER

      public static final int REPEATED_FIELD_NUMBER
      See Also:

    • VALIDATION_REGEX_FIELD_NUMBER

      public static final int VALIDATION_REGEX_FIELD_NUMBER
      See Also:

    • ALLOWED_VALUES_FIELD_NUMBER

      public static final int ALLOWED_VALUES_FIELD_NUMBER
      See Also:

    • MIN_VALUE_FIELD_NUMBER

      public static final int MIN_VALUE_FIELD_NUMBER
      See Also:

    • MAX_VALUE_FIELD_NUMBER

      public static final int MAX_VALUE_FIELD_NUMBER
      See Also:

    • FIELDS_FIELD_NUMBER

      public static final int FIELDS_FIELD_NUMBER
      See Also:

    • VALIDATION_DESCRIPTION_FIELD_NUMBER

      public static final int VALIDATION_DESCRIPTION_FIELD_NUMBER
      See Also:

    • VALIDATION_HELP_URL_FIELD_NUMBER

      public static final int VALIDATION_HELP_URL_FIELD_NUMBER
      See Also:

    • IMMUTABLE_FIELD_NUMBER

      public static final int IMMUTABLE_FIELD_NUMBER
      See Also:

    • RECURSE_FIELD_NUMBER

      public static final int RECURSE_FIELD_NUMBER
      See Also:

    • DEPRECATED_FIELD_NUMBER

      public static final int DEPRECATED_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getParamId

      public String getParamId()
       Parameter identifier.
      string param_id = 1;
      Specified by:
      getParamId in interface DataSourceParameterOrBuilder
      Returns:
      The paramId.

    • getParamIdBytes

      public com.google.protobuf.ByteString getParamIdBytes()
       Parameter identifier.
      string param_id = 1;
      Specified by:
      getParamIdBytes in interface DataSourceParameterOrBuilder
      Returns:
      The bytes for paramId.

    • getDisplayName

      public String getDisplayName()
       Parameter display name in the user interface.
      string display_name = 2;
      Specified by:
      getDisplayName in interface DataSourceParameterOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Parameter display name in the user interface.
      string display_name = 2;
      Specified by:
      getDisplayNameBytes in interface DataSourceParameterOrBuilder
      Returns:
      The bytes for displayName.

    • getDescription

      public String getDescription()
       Parameter description.
      string description = 3;
      Specified by:
      getDescription in interface DataSourceParameterOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       Parameter description.
      string description = 3;
      Specified by:
      getDescriptionBytes in interface DataSourceParameterOrBuilder
      Returns:
      The bytes for description.

    • getTypeValue

      public int getTypeValue()
       Parameter type.
      .google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type type = 4;
      Specified by:
      getTypeValue in interface DataSourceParameterOrBuilder
      Returns:
      The enum numeric value on the wire for type.

    • getType

      public DataSourceParameter.Type getType()
       Parameter type.
      .google.cloud.bigquery.datatransfer.v1.DataSourceParameter.Type type = 4;
      Specified by:
      getType in interface DataSourceParameterOrBuilder
      Returns:
      The type.

    • getRequired

      public boolean getRequired()
       Is parameter required.
      bool required = 5;
      Specified by:
      getRequired in interface DataSourceParameterOrBuilder
      Returns:
      The required.

    • getRepeated

      public boolean getRepeated()
       Deprecated. This field has no effect.
      bool repeated = 6;
      Specified by:
      getRepeated in interface DataSourceParameterOrBuilder
      Returns:
      The repeated.

    • getValidationRegex

      public String getValidationRegex()
       Regular expression which can be used for parameter validation.
      string validation_regex = 7;
      Specified by:
      getValidationRegex in interface DataSourceParameterOrBuilder
      Returns:
      The validationRegex.

    • getValidationRegexBytes

      public com.google.protobuf.ByteString getValidationRegexBytes()
       Regular expression which can be used for parameter validation.
      string validation_regex = 7;
      Specified by:
      getValidationRegexBytes in interface DataSourceParameterOrBuilder
      Returns:
      The bytes for validationRegex.

    • getAllowedValuesList

      public com.google.protobuf.ProtocolStringList getAllowedValuesList()
       All possible values for the parameter.
      repeated string allowed_values = 8;
      Specified by:
      getAllowedValuesList in interface DataSourceParameterOrBuilder
      Returns:
      A list containing the allowedValues.

    • getAllowedValuesCount

      public int getAllowedValuesCount()
       All possible values for the parameter.
      repeated string allowed_values = 8;
      Specified by:
      getAllowedValuesCount in interface DataSourceParameterOrBuilder
      Returns:
      The count of allowedValues.

    • getAllowedValues

      public String getAllowedValues(int index)
       All possible values for the parameter.
      repeated string allowed_values = 8;
      Specified by:
      getAllowedValues in interface DataSourceParameterOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The allowedValues at the given index.

    • getAllowedValuesBytes

      public com.google.protobuf.ByteString getAllowedValuesBytes(int index)
       All possible values for the parameter.
      repeated string allowed_values = 8;
      Specified by:
      getAllowedValuesBytes in interface DataSourceParameterOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the allowedValues at the given index.

    • 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
      Returns:
      Whether the minValue field is set.

    • getMinValue

      public com.google.protobuf.DoubleValue getMinValue()
       For integer and double values specifies minimum allowed value.
      .google.protobuf.DoubleValue min_value = 9;
      Specified by:
      getMinValue in interface DataSourceParameterOrBuilder
      Returns:
      The minValue.

    • getMinValueOrBuilder

      public com.google.protobuf.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 maximum allowed value.
      .google.protobuf.DoubleValue max_value = 10;
      Specified by:
      hasMaxValue in interface DataSourceParameterOrBuilder
      Returns:
      Whether the maxValue field is set.

    • getMaxValue

      public com.google.protobuf.DoubleValue getMaxValue()
       For integer and double values specifies maximum allowed value.
      .google.protobuf.DoubleValue max_value = 10;
      Specified by:
      getMaxValue in interface DataSourceParameterOrBuilder
      Returns:
      The maxValue.

    • getMaxValueOrBuilder

      public com.google.protobuf.DoubleValueOrBuilder getMaxValueOrBuilder()
       For integer and double values specifies maximum allowed value.
      .google.protobuf.DoubleValue max_value = 10;
      Specified by:
      getMaxValueOrBuilder in interface DataSourceParameterOrBuilder

    • getFieldsList

      public List<DataSourceParameter> getFieldsList()
       Deprecated. This field has no effect.
      repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;
      Specified by:
      getFieldsList in interface DataSourceParameterOrBuilder

    • getFieldsOrBuilderList

      public List<? extends DataSourceParameterOrBuilder> getFieldsOrBuilderList()
       Deprecated. This field has no effect.
      repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;
      Specified by:
      getFieldsOrBuilderList in interface DataSourceParameterOrBuilder

    • getFieldsCount

      public int getFieldsCount()
       Deprecated. This field has no effect.
      repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;
      Specified by:
      getFieldsCount in interface DataSourceParameterOrBuilder

    • getFields

      public DataSourceParameter getFields(int index)
       Deprecated. This field has no effect.
      repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;
      Specified by:
      getFields in interface DataSourceParameterOrBuilder

    • getFieldsOrBuilder

      public DataSourceParameterOrBuilder getFieldsOrBuilder(int index)
       Deprecated. This field has no effect.
      repeated .google.cloud.bigquery.datatransfer.v1.DataSourceParameter fields = 11;
      Specified by:
      getFieldsOrBuilder in interface DataSourceParameterOrBuilder

    • 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;
      Specified by:
      getValidationDescription in interface DataSourceParameterOrBuilder
      Returns:
      The validationDescription.

    • getValidationDescriptionBytes

      public 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;
      Specified by:
      getValidationDescriptionBytes in interface DataSourceParameterOrBuilder
      Returns:
      The bytes for validationDescription.

    • getValidationHelpUrl

      public String getValidationHelpUrl()
       URL to a help document to further explain the naming requirements.
      string validation_help_url = 13;
      Specified by:
      getValidationHelpUrl in interface DataSourceParameterOrBuilder
      Returns:
      The validationHelpUrl.

    • getValidationHelpUrlBytes

      public com.google.protobuf.ByteString getValidationHelpUrlBytes()
       URL to a help document to further explain the naming requirements.
      string validation_help_url = 13;
      Specified by:
      getValidationHelpUrlBytes in interface DataSourceParameterOrBuilder
      Returns:
      The bytes for validationHelpUrl.

    • getImmutable

      public boolean getImmutable()
       Cannot be changed after initial creation.
      bool immutable = 14;
      Specified by:
      getImmutable in interface DataSourceParameterOrBuilder
      Returns:
      The immutable.

    • getRecurse

      public boolean getRecurse()
       Deprecated. This field has no effect.
      bool recurse = 15;
      Specified by:
      getRecurse in interface DataSourceParameterOrBuilder
      Returns:
      The recurse.

    • 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;
      Specified by:
      getDeprecated in interface DataSourceParameterOrBuilder
      Returns:
      The deprecated.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static DataSourceParameter parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataSourceParameter parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataSourceParameter parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataSourceParameter parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataSourceParameter parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataSourceParameter parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DataSourceParameter parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataSourceParameter parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataSourceParameter parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataSourceParameter parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataSourceParameter parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataSourceParameter parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public DataSourceParameter.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.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 com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected DataSourceParameter.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static DataSourceParameter getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DataSourceParameter> parser()

    • getParserForType

      public com.google.protobuf.Parser<DataSourceParameter> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public DataSourceParameter getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder