Class DataSourceParameter

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.

Inheritance

System.Object

DataSourceParameter

Implements

IDirectResponseSchema

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.BigQueryDataTransfer.v1.Data

Assembly: Google.Apis.BigQueryDataTransfer.v1.dll

Syntax

public class DataSourceParameter : IDirectResponseSchema

Properties

AllowedValues

All possible values for the parameter.

Declaration

[JsonProperty("allowedValues")]
public virtual IList<string> AllowedValues { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

Deprecated

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

Declaration

[JsonProperty("deprecated")]
public virtual bool? Deprecated { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Description

Parameter description.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
System.String

DisplayName

Parameter display name in the user interface.

Declaration

[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }

Property Value

Type	Description
System.String

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
System.String

Fields

Deprecated. This field has no effect.

Declaration

[JsonProperty("fields")]
public virtual IList<DataSourceParameter> Fields { get; set; }

Property Value

Type	Description
System.Collections.Generic.IList<DataSourceParameter>

Immutable

Cannot be changed after initial creation.

Declaration

[JsonProperty("immutable")]
public virtual bool? Immutable { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

MaxValue

For integer and double values specifies maxminum allowed value.

Declaration

[JsonProperty("maxValue")]
public virtual double? MaxValue { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

MinValue

For integer and double values specifies minimum allowed value.

Declaration

[JsonProperty("minValue")]
public virtual double? MinValue { get; set; }

Property Value

Type	Description
System.Nullable<System.Double>

ParamId

Parameter identifier.

Declaration

[JsonProperty("paramId")]
public virtual string ParamId { get; set; }

Property Value

Type	Description
System.String

Recurse

Deprecated. This field has no effect.

Declaration

[JsonProperty("recurse")]
public virtual bool? Recurse { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Repeated

Deprecated. This field has no effect.

Declaration

[JsonProperty("repeated")]
public virtual bool? Repeated { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Required

Is parameter required.

Declaration

[JsonProperty("required")]
public virtual bool? Required { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Type

Parameter type.

Declaration

[JsonProperty("type")]
public virtual string Type { get; set; }

Property Value

Type	Description
System.String

ValidationDescription

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

Declaration

[JsonProperty("validationDescription")]
public virtual string ValidationDescription { get; set; }

Property Value

Type	Description
System.String

ValidationHelpUrl

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

Declaration

[JsonProperty("validationHelpUrl")]
public virtual string ValidationHelpUrl { get; set; }

Property Value

Type	Description
System.String

ValidationRegex

Regular expression which can be used for parameter validation.

Declaration

[JsonProperty("validationRegex")]
public virtual string ValidationRegex { get; set; }

Property Value

Type	Description
System.String

Implements

IDirectResponseSchema