Class DataSourceParameter (3.3.0)

public sealed class DataSourceParameter : IMessage<DataSourceParameter>, IEquatable<DataSourceParameter>, IDeepCloneable<DataSourceParameter>, IBufferMessage, IMessage

A parameter used to define custom fields in a data source definition.

Inheritance

Object > DataSourceParameter

Implements

IMessage<DataSourceParameter>, IEquatable<DataSourceParameter>, IDeepCloneable<DataSourceParameter>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.BigQuery.DataTransfer.V1

Assembly

Google.Cloud.BigQuery.DataTransfer.V1.dll

Constructors

DataSourceParameter()

public DataSourceParameter()

DataSourceParameter(DataSourceParameter)

public DataSourceParameter(DataSourceParameter other)

Parameter
Name	Description
`other`	`DataSourceParameter`

Properties

AllowedValues

public RepeatedField<string> AllowedValues { get; }

All possible values for the parameter.

Property Value
Type	Description
`RepeatedField<String>`

Deprecated

public bool Deprecated { get; set; }

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

Property Value
Type	Description
`Boolean`

Description

public string Description { get; set; }

Parameter description.

Property Value
Type	Description
`String`

DisplayName

public string DisplayName { get; set; }

Parameter display name in the user interface.

Property Value
Type	Description
`String`

Fields

public RepeatedField<DataSourceParameter> Fields { get; }

Deprecated. This field has no effect.

Property Value
Type	Description
`RepeatedField<DataSourceParameter>`

Immutable

public bool Immutable { get; set; }

Cannot be changed after initial creation.

Property Value
Type	Description
`Boolean`

MaxValue

public double? MaxValue { get; set; }

For integer and double values specifies maxminum allowed value.

Property Value
Type	Description
`Nullable<Double>`

MinValue

public double? MinValue { get; set; }

For integer and double values specifies minimum allowed value.

Property Value
Type	Description
`Nullable<Double>`

ParamId

public string ParamId { get; set; }

Parameter identifier.

Property Value
Type	Description
`String`

Recurse

public bool Recurse { get; set; }

Deprecated. This field has no effect.

Property Value
Type	Description
`Boolean`

Repeated

public bool Repeated { get; set; }

Deprecated. This field has no effect.

Property Value
Type	Description
`Boolean`

Required

public bool Required { get; set; }

Is parameter required.

Property Value
Type	Description
`Boolean`

Type

public DataSourceParameter.Types.Type Type { get; set; }

Parameter type.

Property Value
Type	Description
`DataSourceParameter.Types.Type`

ValidationDescription

public string ValidationDescription { get; set; }

Description of the requirements for this field, in case the user input does not fulfill the regex pattern or min/max values.

Property Value
Type	Description
`String`

ValidationHelpUrl

public string ValidationHelpUrl { get; set; }

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

Property Value
Type	Description
`String`

ValidationRegex

public string ValidationRegex { get; set; }

Regular expression which can be used for parameter validation.

Property Value
Type	Description
`String`