description: Horizontal repeated views.

description: Vertical repeated views.

key: Repeat


enum: argmax argmin average count distinct max mean median min missing q1 q3 ci0 ci1 stdev stdevp sum valid values variance variancep

type: string

key: AggregateOp


type: number

type: object

key: Padding


key: VgRangeBinding


description:
The width of a visualization.

__Default value:__ This will be determined by the following rules:

- If a view's [`autosize`](size.html#autosize) type is `"fit"` or its x-channel has a [continuous scale](scale.html#continuous), the width will be the value of [`config.view.width`](spec.html#config).
- For x-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the width is [determined by the range step, paddings, and the cardinality of the field mapped to x-channel](scale.html#band).   Otherwise, if the `rangeStep` is `null`, the width will be the value of [`config.view.width`](spec.html#config).
- If no field is mapped to `x` channel, the `width` will be the value of [`config.scale.textXRangeStep`](size.html#default-width-and-height) for `text` mark and the value of `rangeStep` for other marks.

__Note:__ For plots with [`row` and `column` channels](encoding.html#facet), this represents the width of a single view.

__See also:__ The documentation for [width and height](size.html) contains more examples.

description:
The height of a visualization.

__Default value:__
- If a view's [`autosize`](size.html#autosize) type is `"fit"` or its y-channel has a [continuous scale](scale.html#continuous), the height will be the value of [`config.view.height`](spec.html#config).
- For y-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the height is [determined by the range step, paddings, and the cardinality of the field mapped to y-channel](scale.html#band). Otherwise, if the `rangeStep` is `null`, the height will be the value of [`config.view.height`](spec.html#config).
- If no field is mapped to `y` channel, the `height` will be the value of `rangeStep`.

__Note__: For plots with [`row` and `column` channels](encoding.html#facet), this represents the height of a single view.

__See also:__ The documentation for [width and height](size.html) contains more examples.

key: LayoutSizeMixins


description: The stroke width of the interval mark.

description: The stroke opacity of the interval mark (a value between 0 and 1).

description: The offset (in pixels) with which to begin drawing the stroke dash array.

description:
The stroke color of the interval mark.

__Default value:__ `#ffffff`

description:
The fill opacity of the interval mark (a value between 0 and 1).

__Default value:__ `0.125`

type: array

description:
An array of alternating stroke and space lengths,
for creating dashed or dotted lines.

description:
The fill color of the interval mark.

__Default value:__ `#333333`

key: BrushConfig


description:
Base object for Vega's Axis and Axis Config.
All of these properties are both properties of Vega's Axis and Axis Config.

description: The padding, in pixels, between title and axis.

type: boolean

description:
A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis.

__Default value:__ `true`

description: Boolean value that determines whether the axis should include ticks.

type: boolean number

description:
Indicates if labels should be hidden if they exceed the axis range. If `false `(the default) no bounds overlap analysis is performed. If `true`, labels will be hidden if they exceed the axis range by more than 1 pixel. If this property is a number, it specifies the pixel tolerance: the maximum amount by which a label bounding box may exceed the axis range.

__Default value:__ `false`.

description: The padding, in pixels, between axis and text labels.

description:
Indicates if the first and last axis labels should be aligned flush with the scale range. Flush alignment for a horizontal axis will left-align the first label and right-align the last label. For vertical axes, bottom and top text baselines are applied instead. If this property is a number, it also indicates the number of pixels by which to offset the first and last labels; for example, a value of 2 will flush-align the first and last labels and also push them 2 pixels outward from the center of the axis. The additional adjustment can sometimes help the labels better visually group with corresponding axis ticks.

__Default value:__ `true` for axis of a continuous x-scale. Otherwise, `false`.

description:
A boolean flag indicating if labels should be included as part of the axis.

__Default value:__  `true`.

description:
The rotation angle of the axis labels.

__Default value:__ `-90` for nominal and ordinal fields; `0` otherwise.

description: Max length for axis title if the title is automatically generated from the field's description.

description:
A boolean flag indicating if grid lines should be included as part of the axis

__Default value:__ `true` for [continuous scales](scale.html#continuous) that are not binned; otherwise, `false`.

description:
The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

__Default value:__ `30` for y-axis; `undefined` for x-axis.

description:
The strategy to use for resolving overlap of axis labels. If `false` (the default), no overlap reduction is attempted. If set to `true` or `"parity"`, a strategy of removing every other label is used (this works well for standard linear axes). If set to `"greedy"`, a linear scan of the labels is performed, removing any labels that overlaps with the last visible label (this often works better for log-scaled axes).

__Default value:__ `true` for non-nominal fields with non-log scales; `"greedy"` for log scales; otherwise `false`.

description: The size in pixels of axis ticks.

description:
The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

__Default value:__ `undefined`.

key: VgAxisBase


description:
A title for the field. If `null`, the title will be removed.

__Default value:__  derived from the field's name and transformation function (`aggregate`, `bin` and `timeUnit`).  If the field has an aggregate function, the function is displayed as a part of the title (e.g., `"Sum of Profit"`). If the field is binned or has a time unit applied, the applied function will be denoted in parentheses (e.g., `"Profit (binned)"`, `"Transaction Date (year-month)"`).  Otherwise, the title is simply the field name.

__Note__: You can customize the default field title format by providing the [`fieldTitle` property in the [config](config.html) or [`fieldTitle` function via the `compile` function's options](compile.html#field-title).

description:
The formatting pattern for labels. This is D3's [number format pattern](https://github.com/d3/d3-format#locale_format) for quantitative fields and D3's [time format pattern](https://github.com/d3/d3-time-format#locale_format) for time field.

See the [format documentation](format.html) for more information.

__Default value:__  derived from [numberFormat](config.html#format) config for quantitative fields and from [timeFormat](config.html#format) config for temporal fields.

key: Guide


description: If true, values that exceed the data domain are clamped to either the minimum or maximum range value

description:
Default outer padding for `x` and `y` point-ordinal scales.

__Default value:__ `0.5`

description:
The default min value for mapping quantitative fields to tick's size/fontSize scale with zero=false

__Default value:__ `8`

description:
Default inner padding for `x` and `y` band-ordinal scales.

__Default value:__ `0.1`

description:
Default max opacity for mapping a field to opacity.

__Default value:__ `0.8`

description:
Default padding for continuous scales.

__Default:__ `5` for continuous x-scale of a vertical bar and continuous y-scale of a horizontal bar.; `0` otherwise.

description:
Use the source data range before aggregation as scale domain instead of aggregated data for aggregate axis.

This is equivalent to setting `domain` to `"unaggregate"` for aggregated _quantitative_ fields by default.

This property only works with aggregate functions that produce values within the raw data domain (`"mean"`, `"average"`, `"median"`, `"q1"`, `"q3"`, `"min"`, `"max"`). For other aggregations that produce values outside of the raw data domain (e.g. `"count"`, `"sum"`), this property is ignored.

__Default value:__ `false`

description:
Default range step for band and point scales of (1) the `y` channel
and (2) the `x` channel when the mark is not `text`.

__Default value:__ `21`

description:
Default outer padding for `x` and `y` band-ordinal scales.
If not specified, by default, band scale's paddingOuter is paddingInner/2.

description:
Default minimum value for point size scale with zero=false.

__Default value:__ `9`

description: Default max value for point size scale.

description:
The default min value for mapping quantitative fields to bar and tick's size/bandSize scale with zero=false.

__Default value:__ `2`

description:
Default range step for `x` band and point scales of text marks.

__Default value:__ `90`

description:
The default max value for mapping quantitative fields to text's size/fontSize.

__Default value:__ `40`

description:
Default max strokeWidth for strokeWidth  (or rule/line's size) scale.

__Default value:__ `4`

description:
Default minimum strokeWidth for strokeWidth (or rule/line's size) scale with zero=false.

__Default value:__ `1`

description:
Default minimum opacity for mapping a field to opacity.

__Default value:__ `0.3`

description:
If true, rounds numeric output values to integers.
This can be helpful for snapping to the pixel grid.
(Only available for `x`, `y`, and `size` scales.)

description:
The default max value for mapping quantitative fields to bar's size/bandSize.

If undefined (default), we will use the scale's `rangeStep` - 1.

key: ScaleConfig


required: input options

key: VgSelectBinding


required: calculate as

description: The field for storing the computed formula value.

description: A string containing a Vega Expression. Use the variable `datum` to refer to the current data object.

key: CalculateTransform


enum: quantitative ordinal temporal nominal

description:
Constants and utilities for data type
 Data type based on level of measurement

key: Type


description:
Whether month names and weekday names should be abbreviated.

__Default value:__  `false`

key: VlOnlyGuideConfig


enum: yearquarter yearquartermonth yearmonth yearmonthdate yearmonthdatehours yearmonthdatehoursminutes yearmonthdatehoursminutesseconds quartermonth monthdate hoursminutes hoursminutesseconds minutesseconds secondsmilliseconds

key: LocalMultiTimeUnit


description:
If set to auto (the default), perform automatic type inference to determine the desired data types.
Alternatively, a parsing directive object can be provided for explicit data types. Each property of the object corresponds to a field name, and the value to the desired data type (one of `"number"`, `"boolean"` or `"date"`).
For example, `"parse": {"modified_on": "date"}` parses the `modified_on` field in each input record a Date value.

For `"date"`, we parse data based using Javascript's [`Date.parse()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse).
For Specific date formats can be provided (e.g., `{foo: 'date:"%m%d%Y"'}`), using the [d3-time-format syntax](https://github.com/d3/d3-time-format#locale_format). UTC date format parsing is supported similarly (e.g., `{foo: 'utc:"%m%d%Y"'}`). See more about [UTC time](timeunit.html#utc)

description:
The name of the TopoJSON object set to convert to mesh.
Similar to the `feature` option, `mesh` extracts a named TopoJSON object set.
  Unlike the `feature` option, the corresponding geo data is returned as a single, unified mesh instance, not as individual GeoJSON features.
Extracting a mesh is useful for more efficiently drawing borders or other geographic elements that you do not need to associate with specific regions such as individual countries, states or counties.

description:
Type of input data: `"json"`, `"csv"`, `"tsv"`.
The default format type is determined by the extension of the file URL.
If no extension is detected, `"json"` will be used by default.

description:
The name of the TopoJSON object set to convert to a GeoJSON feature collection.
For example, in a map of the world, there may be an object set named `"countries"`.
Using the feature property, we can extract this set and generate a GeoJSON feature object for each country.

key: TopoDataFormat


description: Binning properties or boolean flag for determining whether to bin data or not.

description:
Scale factors indicating allowable subdivisions. The default value is [5, 2], which indicates that for base 10 numbers (the default base), the method may consider dividing bin sizes by 5 and/or 2. For example, for an initial step size of 10, the method can check if bin sizes of 2 (= 10/5), 5 (= 10/2), or 1 (= 10/(5*2)) might also satisfy the given constraints.

__Default value:__ `[5, 2]`

description: A minimum allowable step size (particularly useful for integer values).

description:
An exact step size to use between bins.

__Note:__ If provided, options such as maxbins will be ignored.

description:
The number base to use for automatic bin determination (default is base 10).

__Default value:__ `10`

description: An array of allowable step sizes to choose from.

description: A two-element (`[min, max]`) array indicating the range of desired bin values.

description:
Maximum number of bins.

__Default value:__ `6` for `row`, `column` and `shape` channels; `10` for other channels

description: If true (the default), attempts to make the bin boundaries use human-friendly boundaries, such as multiples of ten.

key: BinParams


enum: off warning error

description:
npm-package-json-lint rule

"off" - turns the rule off
"warning" - turns the rule on as a warning, which doesn't affect the exit code
"error" - turns the rule on as an error, which when triggered generates an exit code of 2

key: rule


description: Configuration, specific to BigQuery adapter, of the KMS key name used for data encryption.


description: Configuration, specific to BigQuery adapter, used to setup authorized views.

title: Authorized views


description: Configuration specific to BigQuery adapter used to set an expiration delay (in hours) to a table.


description: The color of the node on the DAG in the documentation. It must be an Hex code or a valid CSS color name.

description: Configurations for the appearance of nodes in the dbt documentation.

title: Docs config


examples: SignIn SignOut

title: Goto (string)

key: GotoPage


description: Data key in the emit object

title: Data key

key: DataKeyObject


description: Mutates the value at the root referenced path after receiving its result

title: Root eval reference

key: RootEvalReference


description: A reference whose scope is at the global level

title: Root reference

key: RootReference


description: An identifier which is used to bind a component and an action together. Actions can define a viewTag that invokes certain behavior towards a component. The component must also contain the same viewTag key/value. If multiple components have the same viewTag, then the action will effect multiple components

title: View tag

key: ViewTag


examples: button canvas chart chatList ecosDoc divider footer header image label list listItem map page plugin pluginHead pluginBodyTop pluginBodyTail popUp register scrollView textField textView video view

title: Component type

key: ComponentType


title: Goto (object)

key: GotoObject


title: Noodl unit (ex: "0.1", "0.25", etc)

description: A measurement adaptive to the size of the viewport

key: NoodlUnit


description: Empty value (empty string)

title: Empty

key: Empty


examples: left center centerX right

title: Enum for the string textAlign type

key: TextAlignEnum


description: An object that contains data. It is most commonly used in actions such as updateObject as a way to update its data values

title: Data object

key: DataObject


title: Action type

description: An identifier/name for an action

examples: openCamera openPhotoLibrary openDocumentManager pageJump popUpDismiss refresh register removeSignature saveObject saveSignature updateObject popUp builtIn evalObject

key: ActionType


title: Data key

description: The path to a data object or value. It might provide a different behavior depending on where it is placed. For example, a dataKey set on a textField component will bind its value to the path in the dataKey, enabling it to mutate the value while updating textField's value

key: DataKeyString


description: Mutates the value at the referenced path after receiving its result

title: Local eval reference

key: LocalEvalReference


description: Removes border including the radius

title: Border style preset #1


description: Removes border from all sides (including radius) except the bottom. This will create an underline effect

title: Border style preset #2


description: Applies a solid border to all sides

title: Border style preset #3


description: Sets the border to be a dashed border

title: Border style preset #4


description: Removes border from all sides

title: Border style preset #5


description: Sets the border to be a solid border. This will also remove border radius from all sides

title: Border style preset #1


description: A reference whose scope is within the page object, making them invisible to the objects outside of its scope

title: Local reference

key: LocalReference


title: Content type

description: Determines the content type of the component. For example, a textField component may be a date textField if it has contentType: date, or a password textField with contentType: password, etc

examples: countryCode email date file formattedDate formattedDuration hidden listObject messageHidden number password passwordHidden phone phoneNumber tel text timer videoSubStream

key: ContentType


title: Text align object

key: TextAlignObject


title: Color

key: Color


description: A reference that returns its result after the value at the referenced path is received

title: Await reference

key: AwaitReference


description: Options for a select component. These are the items that appear in the drop down menu when interacting with a select component

title: Select options

key: SelectOptions


description: A boolean value is either one of "true", true, "false", or false

title: Boolean

key: Boolean


title: Goto url

key: GotoPageComponentUrl


examples: admin business

title: Page module

key: PageModule


title: Page number

description: A page number may help distinguish between pages with similar names

key: PageNumber


title: Root config version object

key: ConfigVersionObjectByDevice


description: The MIME type of the HTTP message.

key: mimeType


default: csv

enum: csv ssv tsv pipes multi

key: collectionFormatWithMulti


enum: csv ssv tsv pipes

key: collectionFormat


enum: http https ws wss

description: The transfer protocol of the API.

key: schemesList


description: Any property starting with x- is valid.

key: vendorExtension


description: An enumeration.

title: SPDXLicenseEnum

key: SPDXLicenseEnum


title: CollectionVersionConstraintModel

key: CollectionVersionConstraintModel


description: Key/value pairs that provide additional information about the object.

description: A set of distinct strings that provide additional information.

key: propertyBag


required: Type Properties

enum: Delete Retain Snapshot

required: PolicyDocument Queues


required: FailureValues Identifier SuccessValues


required: HealthyThreshold IntervalMillis Protocol TimeoutMillis UnhealthyThreshold


required: AppImageConfigName ImageName


required: HostedZoneId KeyManagementServiceArn Name Status


required: GroupName UserPoolId Username


required: ApiKey ApplicationId


required: ChildAssetId LogicalId


required: Name Policy Type


required: TargetAddress TargetType


required: EndDate StartDate Value


required: BucketArn Format


required: ContactFlowArn UserArn


required: Name SubnetIds VpcId


required: ImageUri ProblemType


required: SecurityGroupIds Subnets


required: AuthorizationEndpoint ClientId Issuer TokenEndpoint UserInfoEndpoint


required: Amount Granularity


required: DNSName HostedZoneId


required: SecurityGroupIdList SubnetIdList


required: StateMachineVersionArn Type


required: Attribute Name RoleArn ThingName


required: DataSetIdentifier DataSetParameterName


required: HealthyThreshold Interval Target Timeout UnhealthyThreshold


required: Type Properties


required: ContactId IsEssential


required: Bucket Key


required: East North South West


required: NotificationArns PortfolioId ProductId


required: ColumnSpan ElementId ElementType RowSpan


required: QueryStatement StatementName WorkGroup


required: InstanceId Origin


required: ChannelId ChannelRoleArn NotifyOnCaseSeverity TeamId


required: Account ClusterIdentifier


required: ClientId ClientSecret RefreshToken


required: EksClusterArn KubernetesNamespace


required: Bucket PolicyDocument


required: PortfolioId ProductId


required: ResourceArn UseServiceLinkedRole


required: Address SubscriptionType


required: InstancePort LoadBalancerPort Protocol


required: Type Properties


required: DhcpOptionsId VpcId


required: PortfolioId PrincipalARN PrincipalType


required: Cluster Service TaskSetId


required: GroupOwner GroupPermission


required: BackupVaultEvents SNSTopicArn


required: AuthenticationType StackName UserName


required: MaxCapacity MinCapacity


required: Actions Principal


required: ObjectLambdaAccessPoint PolicyDocument


required: ColumnName DataSetIdentifier


required: AppKey JoinEui NwkKey


required: OffsetSeconds TimeExpression


key: CustomResource


required: DocumentationVersion RestApiId


required: Key SchemaVersionId Value


required: GatewayId RouteTableId


required: ApiKey ApplicationId SecretKey


required: DatabaseName TableName


required: Type Properties


required: DataSetArn DataSetPlaceholder


required: AuthenticationType UserName


required: CallerReference EncodedKey Name


required: ByteLength Offset Pid PidResponseLength Scaling ServiceMode StartByte


required: RoleARN SecurityGroupIds SubnetIds


required: DestinationName RoleArn TargetArn


required: ColumnName TagKey


required: MaxValue MinValue


required: ContainerPath Size


required: SecurityGroups Subnets


required: EntityIdKey MetricName ValueKey


required: Database Host Port


required: InstanceCount InstanceType


required: ScopeDescription ScopeName


required: Key Name Required Secret


required: ContentExpression Type


required: Type Properties

required: CertificateArn DomainName


required: RoleArn StreamName


required: SyncRole SyncSource WorkspaceId


required: SizeInGB VolumeType


required: OperatorPropertyKey Property


required: BucketName RoleArn


required: SecurityGroupIds Subnets


required: ContactId IsEssential


required: ComputeEnvironment Order


required: ExecutionRole WorkflowId


required: Revision WorkerConfigurationArn


required: LogLevel RoleArnForLogging


required: Identifier Type


required: Type Value


required: Catalog Database TableName


required: QueueUrl RoleArn


required: Type Properties


required: Component Id Level Type


required: CopyStrategy SnapshotARN


required: Database QueryString


required: Authentication ClientSubnets SecurityGroups TargetClusterArn VpcId


required: Database Host Port


required: EndpointPort ListenerPort


required: ConfigurationName IamRoleArn SlackChannelId SlackWorkspaceId


required: Attributes Name


required: ColumnSpan ElementId ElementType RowSpan


required: Action FailureType MinNumberOfExecutedThings ThresholdPercentage


required: Override Protection


required: Comparison Key Value


required: FileSystemId SecurityGroups SubnetId


required: GroupName Users


required: HealthyThreshold IntervalMillis Protocol TimeoutMillis UnhealthyThreshold


required: AlertTargetArn RoleArn


required: Type Properties

required: Policy ResourceArn


required: Architecture GreengrassGroupId


required: RouteTableIds VpnGatewayId


required: NetworkAclId SubnetId


required: ApplicationId ConfigurationProfileId Content ContentType


required: Name RegexPatternStrings


required: PolicyName UserName


required: Role S3Location WorkspaceId


required: ConcurrentExecutions LaunchPath


required: Destination Metric Source Statistic


required: ColumnNames Function


required: ResponseType RestApiId


required: ObjectIdentifier Value


required: ClusterArn Policy


required: FallbackBehavior HeaderName Position


required: CodeHookInterfaceVersion LambdaArn


required: Type Properties


required: PolicyDocument Topics


required: Destination DestinationPort Direction Protocol Source SourcePort


required: ResolverRuleId VPCId


required: BatchSize LambdaName Name


required: SizeInGB VolumeType


required: DataSetIdentifier DataSetParameterName


required: ApiKeyName ApiKeyValue


required: KeyId KeyType UsagePlanId


required: MaxCapacity MinCapacity


required: ResourceArn WebACLArn


required: ReadCapacityUnits WriteCapacityUnits


required: RoleArn StateMachineName


required: ColumnName DataSetIdentifier


required: PolicyDocument PolicyName


required: ClientId UserPoolId


required: Amount Granularity


required: DayOfMonth HandOffTime


required: Header Override Value


required: FallbackBehavior HeaderName Position


required: Type Properties

required: ResourceArn ResourcePolicy


required: CreationTime LastModifiedTime MonitoringExecutionStatus MonitoringScheduleName ScheduledTime


required: Category Condition OptionRefId


required: DetectorId Email MemberId


required: Protocol TopicArn


required: FunctionName Name


required: Pattern PatternName Rank


required: AliasName TargetKeyId


required: Arn PermissionPolicy


required: Endpoint Id Index RoleArn Type


required: CdnIdentifierSecret SecretsRoleArn


required: DataSourceType DataTypeName


required: CodeHookInterfaceVersion LambdaArn


required: EndpointName LocalPath


required: Attribute Name RoleArn ThingName


required: Key Value


required: DesiredChange EntityIdKey MetricName ValueKey


required: Type Properties


required: AgreeToInstallHANADBClient HANAPort HANASID HANASecretName


required: Id Password Url Username


required: Name ServerProperties


required: PolicyDocument PolicyName


required: Primary PrivateIpAddress


required: PolicyDocument Queue


required: DataType FullyQualifiedName


required: ParameterName ParameterValue


required: MetricName MetricNamespace MetricUnit MetricValue RoleArn


required: Attribute Math Name


required: Classification GrokPattern


required: ModuleName ModulePackage


required: SecurityGroupIds Subnets


required: Endpoint Id Index RoleArn Type


required: ClientVpnEndpointId SubnetId


required: AttributeName AttributeType


required: Type Properties

required: Action Principal ProfileName StatementId


required: MatchOperator NullOption


required: InstanceIds Region Subtype


required: ApiId DomainName


required: IdentityPoolId IdentityProviderName


required: Scope SheetId


required: Database Host Port


required: ApplicationId ClientId ClientSecret


required: DetectorId MasterId


required: TagKey TagValues


required: SecurityGroupArns SubnetArn


required: CertificateChain PrivateKey


required: DomainName OriginAccessIdentity


required: Policy ResourceIdentifier


required: ColumnName Minimum Type


required: HardLimit Name SoftLimit


required: HeaderName HeaderValue


required: AppImageConfigName ImageName


required: Type Properties

required: ClusterIdentifier EndpointName SubnetGroupName VpcSecurityGroupIds


required: Action LayerVersionArn Principal


required: RouteTableId SubnetId


required: BucketName Key RoleArn


required: Path SourceGroup Type


required: EntityId MetadataContent


required: PortfolioId ProductId Rules


required: DataSetArn DataSetPlaceholder


required: MeasureValueType SourceColumn


required: SnsRoleName SnsTopicArn


required: ComputeType VolumeSizeInGB


required: DataSourceFieldName IndexFieldName


required: DeliveryStreamArn IamRoleArn


required: Inverted Threshold Type


required: ColumnName NewColumnName


required: AuthorizationEndpoint ClientId Issuer TokenEndpoint UserInfoEndpoint


required: HardLimit Name SoftLimit


required: InputName RoleArn


required: ClientProperties DestinationArn Topic


required: MatchOperator NullOption


required: Type Properties


required: Attributes Name


required: Application Resource ResourceType


required: DlClass RfRegion


required: Columns Name


required: DestinationCidrBlock VpnConnectionId


required: ProviderName ProviderType UserPoolId


required: LogLevel TargetName TargetType


required: SecurityGroupIds SubnetIds


required: InstanceArn PermissionSetArn PrincipalId PrincipalType TargetId TargetType


required: Name SubnetIds


required: Actions Principal


required: ClusterName ServiceName


required: MulticastIp Name NetworkName Port Protocol


required: ServiceName VpcId


required: Name Policy Type


required: ObjectIdentifier Value


required: AllowAudioInput AllowDTMFInput


required: DataSourceFieldName IndexFieldName


required: DiskName Path


required: Type Properties

required: ApiCachingBehavior ApiId Ttl Type


required: MrapName Policy


required: Claim MatchType RoleARN Value


required: IdentityName IdentityType SessionPolicyArn StudioId


required: MaxConcurrency MemorySizeInMB


required: ParameterName ParameterValue


required: Password Username


required: ApplicationId EnvironmentId


required: ClientVpnEndpointId TargetNetworkCidr


required: BucketARN FileKey ReferenceRoleARN


required: AlarmName ComparisonOperator EvaluationPeriods MetricName MonitoredResourceName Threshold


required: DNSName HostedZoneId


required: ApiId DomainName Stage


required: PolicyDocument TopicArn


required: ComponentName ResourceList


required: SecurityGroupIds Subnets


required: DataId Negated Type


required: Type Properties

required: InstanceAttributes ServiceId


required: SecretId TargetId TargetType


required: ContentSecurityPolicy Override


required: PolicyDocument PolicyName


required: ConfigUri ImageUri


required: Principal ThingName


required: SecurityGroupIds SubnetIds


required: Name RuleVersion Rules


required: ParameterKey ParameterValue


required: AccountId PortfolioId


required: PackageId PackageVersion PatchVersion


required: FunctionVersion FunctionWeight


required: ReadCapacityUnits WriteCapacityUnits


required: CdnIdentifierSecret SecretsRoleArn


required: Action FunctionName Principal


required: CatalogId TagKey TagValues


required: Type Properties

required: InstanceId VolumeId


required: EndpointName LocalPath


required: AllowCleartext AllowDuplicates AllowJoinsOnColumnsWithDifferentNames PreserveNulls


required: Policy ResourceArn


required: PolicyDocument PolicyName


required: EventLevels EventName LogGroupName


required: ParentId PathPart RestApiId


required: TimeoutAction TimeoutDurationMinutes


required: AppImageConfigName ImageName


required: Action FirewallDomainListId Priority


required: AccountId DisplayName MemberAbilities


required: Namespace OptionName


required: ArtifactId GroupId Version


required: AdminPassword AdminUsername


required: Bucket PolicyDocument


required: DataType FullyQualifiedName


required: CatalogId TagKey TagValues


required: Type Properties


required: DesiredEC2Instances MaxSize MinSize


required: Feature TreatmentName Variation


required: Action FailureType MinNumberOfExecutedThings ThresholdPercentage


required: ConsumerName StreamARN


required: MatchOperator NullOption


required: AppSKey FNwkSIntKey NwkSEncKey SNwkSIntKey


required: Id StorageCapacityQuotaGiB Type


required: AggregationFunction MetricName


required: RoleArn TargetArn


required: DbPassword DbUser RdsDbInstanceArn


required: Ec2ImageId Name StudioId


required: StateMachineVersionArn Weight


required: Bucket Key RoleArn


required: Scope SheetId


required: ColumnId ColumnName Expression


required: DataSourceFieldName IndexFieldName


required: Type Properties


required: ChannelAddress ChannelName ChannelType ContactId


required: Name Schema


required: Actions Principal


required: Name Type Value


required: CloudWatchLogGroupArn LogPrefix


required: ChannelName Policy


required: ResourceArn WebACLId


required: Attributes Name


required: DestinationArn Events Name


required: Amount Granularity


required: Key PropagateAtLaunch Value


required: Message Sender SmtpReplyCode


required: CertificateArn Id ThingArn


required: EventSource MessageType


required: Height Left Top Width


required: DataSourceFieldName IndexFieldName


required: Parameters Statistic


required: Type Properties

required: DeviceId Enabled


required: DeliveryStreamName RoleArn


required: SecurityGroupIds Subnets


required: PathComponent RepositoryUrl


required: Category Owner Provider Version


required: CloudWatchLogGroupArn LogPrefix


required: LinearInterval LinearPercentage


required: Subject TemplateName


required: AlarmNames Enable Rollback


required: Classification RowTag


required: Name Platform Version


required: PolicyDocument PolicyName


required: ChannelName RoleArn


required: CollectionId LocationName


required: ResourceTypes SinkIdentifier


required: BaseImage ImageName


required: Type Properties

required: AuthType ServerType Token


required: RefId Text


required: DatabaseName RoleArn TablePrefix


required: ResourcePolicy SecretId


required: ParameterName ParameterValue


required: CertificateArn Id ThingArn


required: ConsumerArn TrackerName


required: HashKeyField HashKeyValue RoleArn TableName


required: Policy RegistryName


required: ApplicationName TemplateName


required: FlowArn Name RoleArn SecurityGroupIds SubnetId


required: SizeInGB VolumeType


required: ColumnName NewColumnType


required: PolicyDocument PolicyName PolicyType


required: FixedRate HTTPMethod Host Priority ReservoirSize ResourceARN ServiceName ServiceType URLPath


required: ObjectIdentifier Value


required: Type Properties


required: QueryCapacityUnits StorageCapacityUnits


required: GraphArn MemberEmailAddress MemberId


required: Name Unit


required: ContentExpression Type


required: Name RestApiId Type


required: Actions Principal


required: Override ReferrerPolicy


required: ApiId Name Schema


required: ElasticLoadBalancerName LayerId


required: DimensionValueType Name


required: ChannelId RetryIntervalInMinutes


required: DataSetIdentifier Expression Name


required: SecurityGroupIds Subnets


required: AvailabilityZone InstanceType


required: Host Port SqlEndpointPath


required: CatalogId DatabaseName


required: GeneratedRulesType TargetTypes Targets


required: Type Properties

required: ApiId RouteKey


required: MatchOperator NullOption


required: AutodefinedReverseFlag ResourceId


required: Identifier Location MountPoint Type


required: DatabaseName Name TableCatalogId TableName


required: ObjectGroup ObjectGroupName


required: EndpointName LocalPath


required: ApplicationId FromAddress Identity


required: KdcAdminPassword Realm


required: ChildAssetModelId LogicalId Name


required: ChannelId RetryIntervalInMinutes


required: BucketName EncryptionOption


required: Database Host Port


required: ConfigurationName IamRoleArn TeamId TeamsChannelId TeamsTenantId


required: Catalog Host Port


required: Attributes PolicyName PolicyType


required: Type Properties

required: Name Regex


required: BucketName BucketRegion SyncFormat


required: SecurityGroupIds Subnets


required: CanaryInterval CanaryPercentage


required: Bucket Key RoleArn


required: DataSourceFieldName IndexFieldName


required: DayOfWeek TimeOfDay TimeZone


required: DataSetArn DataSetPlaceholder


required: InstanceId Key


required: PolicyId TargetIds


required: Namespace OptionName


required: LogGroupName RoleArn


required: DeviceId GlobalNetworkId LinkId


required: Feature GroupName Variation


required: MatchOperator NullOption


required: GroupId IpProtocol


required: Type Properties

required: ContentLocation SceneId WorkspaceId


required: PolicyText Runtime


required: AssertedControls WaitPeriodMs


required: Condition TargetColumn


required: StorageClass TransitionInDays


required: DatabaseHost DatabaseName DatabasePort SecretArn TableName


required: ParameterName ParameterValue


required: CatalogId DatabaseName


required: ChannelName Name


required: Name QueryString


required: Name TimeToLiveInSeconds TurnsToLive


required: Id Source Subject Target


required: IpAddress Name NetworkName Port Protocol Ttl


required: Hosts RoleBase RoleSearchMatching ServiceAccountPassword ServiceAccountUsername UserBase UserSearchMatching


required: Database Host Port


required: Database Sqls


required: AllowedMethods AllowedOrigins


required: GroupOwner GroupPermission


required: BackupOptions ResourceType


required: ColumnSpan ElementId ElementType RowSpan


required: Type Properties


required: Policy ResourceArn


required: EndpointName LocalPath


required: MaximumCount MinimumCount


required: FallbackBehavior HeaderName


required: Name RequestMessageId


required: RoleArn SecretArn


required: EventType SnapshotOwner


required: NameAssigner PartyName


required: IpAddress NetworkName Port Protocol Ttl


required: DisplayName IdentityStoreId


required: LifecycleHookName LifecycleTransition


required: BucketARN FileKey


required: GlobalNetworkId TransitGatewayArn


required: Compression Format RefreshClosedReports ReportName ReportVersioning S3Bucket S3Prefix S3Region TimeUnit


required: OwnerGid OwnerUid Permissions


required: AccountId DefaultLogLevel RoleArn


required: AttributeName AttributeType


required: FailureValues Name SuccessValues


required: Type Properties


required: Password Username


required: ContactFlowArn QueueArn


required: AccessControlMaxAgeSec Override


required: DataId Negated Type


required: Primary PrivateIpAddress


required: FailureStrings SuccessStrings


required: FileSystemId MountPoint


required: NameAssigner PartyName


required: FailureCodes SuccessCodes


required: Name OriginAccessControlOriginType SigningBehavior SigningProtocol


required: Factor IsBigEndian IsSigned Length MessageId Offset StartBit


required: CustomPluginArn Revision


required: Source Target


required: PolicyDocument PolicyName


required: MulticastIp NetworkName Port Protocol


required: EndDate StartDate Value


required: InstanceCount InstanceType


required: DeletionCharacter EndCharacter EndTimeoutMs MaxLength


required: SecurityGroupIds SubnetIds


required: East North South West


required: Type Properties

required: ResourceId TagOptionId


required: AccessKeyId Datakey SecretAccessKey UserId


required: ApplicationArn FleetName


required: KinesisStreamARN RoleARN


required: DatabaseName TableName


required: Attributes Name


required: BucketName Stage Warehouse


required: Credential CredentialProvider


required: Bucket Enabled Prefix


required: CatalogId ColumnNames DatabaseName Name


required: Database Host Port


required: DataId Negated Type


required: TimeoutAction TimeoutDurationMinutes


required: DeliveryStreamARN IAMRoleARN


required: Actions Principal


required: EndTimeoutMs MaxLengthMs


required: Database Host Warehouse


required: Type Properties


required: CertificateArn Id ThingArn


required: JoinColumns ListColumns


required: Id Source Subject Target


required: AccountList AdminRole Description ExecutionRole PortfolioId ProductId RegionList StackInstanceControl


required: AccountName AccountPassword


required: VirtualNode Weight


required: AcceptedFileTypes AccessLevel


required: DataSetIdentifier Expression Name


required: SecurityGroupIds Subnets


required: FromPort IpRange Protocol ToPort


required: Path SourceGroup Type


required: InboundCalls OutboundCalls


required: InstanceArn Name


required: PortfolioId ProductId


required: FleetName StackName


required: AttributeName AttributeValue


type: string boolean

key: Parameter


required: FallbackBehavior HeaderName


required: Scope SheetId


required: Type Properties


required: PolicyName Principal


required: Credentials Host Port


required: FileSystemId MountPoint


required: Bucket Key


required: Application AttributeGroup


required: CertificateArn Id ThingArn


required: Body TemplateName


required: ExecutionRoleArn TimestreamTableArn


required: PackagingConfigurationId Url


required: ControlIdentifier TargetIdentifier


required: CidrList LocationName


required: CalculatorName DataSource


required: ArtifactPath Branch ConnectionArn Repository


required: CollectionId LocationName


required: Algorithm RoleArn


required: GroupName PolicyName


required: AlarmName RoleArn StateReason StateValue


required: RoleArn ServiceName SigningRegion


required: Type Properties

required: CertificateArn RoleArn


required: PolicyName RoleName


required: DataSetIdentifier Expression Name


required: MaxCapacity MinCapacity


required: DatabaseName TableName


required: Database Host Port


required: East North South West


required: Certificate CertificateAuthorityArn


required: MatchOperator NullOption


required: FeatureName FeatureType


required: SecurityGroupIds SubnetIds


description: A point represents one place in a source file. The value of the point field implements the Point interface.

required: column line

markdownDescription: A point represents one place in a source file. The value of the point field implements the [Point](https://github.com/syntax-tree/unist#point) interface.

type: integer

description: The column field (1-indexed integer) represents a column in a source file.

description: The line field (1-indexed integer) represents a line in a source file.

description: The offset field (0-indexed integer) represents a character in a source file.

key: Point


description: Contains settings to clone the repository into a container

description: Disables SSL verification during git clone, allowing the use of self-signed certificates

const: full

description: Depth of Git clone (supported only for Git repositories)

description: Enables cloning of the repository before a step in a pipeline

description: Enables the download of LFS files in the clone (supported only for Git repositories)


description: Multiplier of the resources allocated to a pipeline step

key: size


description: Overrides image's default user, specified user UID must be an existing user in the image with a valid home directory


description: Name of the Docker image which may or may not include registry URL, tag, and digest value


description: Any label assigned to a self-hosted repository or workspace Pipeline runner


description: Path to the directory to be cached, can be absolute or relative to the clone directory


description: Condition on the changesets involved in a pipeline

description: Glob pattern to match the file path

description: Condition which holds only if any of the modified files match any of the defined patterns

key: condition


description: Pipe to execute

description: Pipe identifier

description: Variable value

description: Array variable item value

description: Environment variables passed to the pipe

key: pipe


description: Maximum amount of minutes a step can execute


description: Glob pattern for the path to the artifacts

description: Files produced by a step to share with a following step


key: branch-object


description: Redirect to a relative or absolute path, or an external URI. Default status code is 302, override with 301.

enum: GET HEAD POST PUT DELETE PATCH CONNECT OPTIONS TRACE

description: Request method(s) to match

description: A path to rewrite the request route to

description: Request route pattern to match. May contain valid wildcards. See documentation: https://aka.ms/swa/config-schema

description: Override any matching global headers

examples: anonymous authenticated

description: Roles that are allowed to access this route. If not empty, only role(s) listed are authorized to access the route. Roles are only used for authorization; they are not used to evaluate whether the route matches the request.

description: Status code override

key: route


description: The name of the claim from which we should read user details

description: <false> if the google provider is not enabled, <true> otherwise

description: The name of the application setting containing the Client ID

description: The name of the application setting containing the Client Secret

description: <false> if the apple provider is not enabled, <true> otherwise

description: <false> if the azureActiveDirectory provider is not enabled, <true> otherwise

required: openIdIssuer clientSecretSettingName

description: The name of the application setting containing the Application (client) ID for the Azure AD app registration

description: The name of the application setting containing the client secret for the Azure AD app registration

description: The endpoint for the OpenID configuration of the AAD tenant

description: <false> if the twitter provider is not enabled, <true> otherwise

description: The name of the application setting containing the Consumer Key

description: The name of the application setting containing the Consumer Secret

description: <false> if the gitHub provider is not enabled, <true> otherwise

description: <false> if the facebook provider is not enabled, <true> otherwise

description: The name of the application setting containing the App Secret

description: The name of the application setting containing the App ID

required: registration login

description: <false> if the custom OpenID Connect provider is not enabled, <true> otherwise

description: The path to the jwks uri

description: The path to the token endpoint

description: The path to the well known configuration endpoint

description: The path to the authorization endpoint

description: The path to the issuer endpoint

description: Route to API function for assigning roles. For example, "/api/GetRoles". See https://aka.ms/swa-roles-function

key: auth


description: Mapping of environment variables for use in config.

key: env


description: Arbitrary annotations keyed by tool/vendor name - not processed by the core Meltano library or CLI

key: annotations


description: Serverless app configuration.

description: (optional) Create domain for the serverless domain manager during the deployment.

description: environment

description: environments

description: (optional) expresses startup and shutdown dependencies between apps

description: (optional) Serverless-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.

description: (optional) Node version that will be used by nvm can be specified here that. Default is v14.

description: (optional) Serverless-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).

description: (optional) Path to serverless file can be specified here. Normally it's serverless.yml in the app directory.

description: (optional) Path to the serverless app directory can be specified here. Normally it's derived from app directory and app name.

description: (optional) SLS node_modules cache mount path can be specified here. It's used to store cache during CI/CD process.

description: (optional) set icon

key: serverless


description: Alias configuration.

description: (optional) set icon

key: alias


description: App configuration.

deprecationMessage: app block is deprecated

description: (optional) skip deploy app.

description: environment

description: environments

description: (optional) Task definition revision can be specified here. By default latest revision is used to perform a deployment. Normally this parameter can be used via cli during specific deployment needs.

description: app type

description: (optional) Docker image can be specified here. By default it's derived from the app name.

description: (optional) Enables unsafe mode that increases deploy time on a cost of shorter healthcheck.

description: (optional) ECS cluster can be specified here. By default it's derived from env & namespace

description: (optional) ECS deployment timeout can be specified here.

description: (optional) Docker registry can be set here. By default it uses ECR repo with the name of the service.

description: (optional) Path to ecs app folder can be specified here. By default it's derived from apps path and app name.

key: app


description: Ecs app configuration.

description: (optional) skip deploy app.

description: (optional) ECS-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.

description: (optional) ECS-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).

description: (optional) set icon

key: ecs


description: Terraform configuration

description: (optional) Terraform state bucket name can be specified here. Normally it's generated and defaults to <NAMESPACE>-tf-state

description: (optional) Terraform state name that will be used in the .tfstate file. Normally it's 'terraform' or state name.

description: (optional) Root domain name can be set here. This is the main domain that will be passed to the terraform. Generally if your app lives at 'api.dev.nutcorp.net' the root domain is `nutcorp.net`

description: (optional) Terraform-specific AWS Region of this environment should be specified here. Normally global AWS_REGION is used.

description: (optional) Terraform-specific AWS profile (optional) can be specified here (but normally it should be inherited from a global AWS_PROFILE).

description: (optional) Terraform version can be set here. 1.1.3 by default.

description: (optional) Terraform state bucket region can be specified here. Normally AWS_REGION is used here. Can be overridden via env vars or flags.

key: terraform


description: A uri that specifies the connection to the remote machine. e.g. tcp://hostname:2358

key: remote


description: Name of a docker image to load in a docker env. dockerImage or dockerFile must be specified, but not both.

description: Path to a Dockerfile, relative to the solution directory, to build an image and load in a docker env. dockerImage or dockerFile must be specified, but not both.

key: docker


description: Name of the local WSL distribution in which to run the test environment.

key: wsl


description: A uri that specifies the connection to the remote machine. e.g. ssh://user@hostname:22

key: ssh


enum: green blue red yellow orange purple pink grey gray cyan black

key: colorPreset


enum: abap actionscript ada apacheconf apl applescript arduino arff asciidoc asm6502 aspnet autohotkey autoit bash basic batch bison brainfuck bro c c-header clike clojure coffeescript comments cpp cpp-header crystal csharp csp css-extras css d dart diff django docker eiffel elixir elm erb erlang flow fortran fsharp gedcom gherkin git glsl go graphql groovy haml handlebars haskell haxe hpkp hsts http ichigojam icon inform7 ini io j java javascript jolie json jsx julia keymap kotlin latex less liquid lisp livescript lolcode lua makefile markdown markup matlab mel mizar monkey n4js nasm nginx nim nix nsis objectivec ocaml opencl oz parigp pascal perl php plsql powershell processing prolog properties protobuf pug puppet pure python q qore r reason renpy rest rip roboconf ruby rust sas sass scala scheme scss smalltalk smarty soy sql stylus swift tap tcl textile tsx tt2 twig typescript vbnet velocity verilog vhdl vim visual-basic wasm url wiki xeora xojo xquery yaml

key: format


description: ARN of the role to assume.

title: Rolearn

description: External ID to use when assuming the role.

title: Externalid

title: AwsAssumeRoleConfig

key: AwsAssumeRoleConfig


description: Number between 0 to 6 for day of week (both inclusive). 0 is Monday and 6 is Sunday. If not specified, defaults to Nothing and this field does not take affect.

title: Profile Day Of Week

description: Whether to do profiling at lower freq or not. This does not do any scheduling just adds additional checks to when not to run profiling.

title: Lower Freq Profile Enabled

description: Number between 1 to 31 for date of month (both inclusive). If not specified, defaults to Nothing and this field does not take affect.

title: Profile Date Of Month

title: OperationConfig

key: OperationConfig


description: Experimental: Max parallelism for REST API calls

description: Extra headers which will be added to the request.

description: Per-HTTP request timeout.

description: Path to server's CA certificate for verification of HTTPS communications

description: Bearer token used for authentication.

description: URL of DataHub GMS endpoint.

descritption: Path to client's CA certificate for HTTPS communications

description: Retry HTTP request also on these status codes

description: Disable SSL verification for HTTPS communications.


description: username

title: Username

format: password

description: password

title: Password

description: database (catalog)

title: Database

description: MySQL host URL.

title: Host Port

description: URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.

title: Sqlalchemy Uri

description: [Deprecated] Alias to apply to database when ingesting.

title: Database Alias

default: mysql+pymysql

title: Scheme

description: Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.

title: Options

title: MySQLConnectionConfig

key: MySQLConnectionConfig


description: A holder for platform -> platform mappings to generate correct dataset urns

title: Platform Override Map

description: A holder for database -> database mappings to generate correct dataset urns

title: Database Override Map

title: TableauLineageOverrides

key: TableauLineageOverrides


enum: DAY HOUR

description: An enumeration.

title: BucketDuration

key: BucketDuration


description: A reference to a Git repository, including a deploy key that can be used to clone it.

title: GitInfo

description: Template for generating a URL to a file in the repo e.g. '{repo_url}/blob/{branch}/{file_path}'. We can infer this for GitHub and GitLab repos, and it is otherwise required.It supports the following variables: {repo_url}, {branch}, {file_path}

title: Url Template

format: file-path

description: A private key file that contains an ssh key that has been configured as a deploy key for this repository. Use a file where possible, else see deploy_key for a config field that accepts a raw string.

title: Deploy Key File

description: The url to call `git clone` on. We infer this for github and gitlab repos, but it is required for other hosts.

title: Repo Ssh Locator

description: Name of your Git repo e.g. https://github.com/datahub-project/datahub or https://gitlab.com/gitlab-org/gitlab. If organization/repo is provided, we assume it is a GitHub repo.

title: Repo

default: main

description: Branch on which your files live by default. Typically main or master. This can also be a commit hash.

title: Branch

description: A private key that contains an ssh key that has been configured as a deploy key for this repository. See deploy_key_file if you want to use a file that contains this key.

title: Deploy Key

key: GitInfo


required: timeout headers

title: Headers

title: Timeout

title: TransportOptionsConfig

key: TransportOptionsConfig


required: name url swagger_file

title: Username

title: Swagger File

title: Name

title: Url

title: Ignore Endpoints

title: Forced Examples

title: Token

title: Get Token

title: Password

title: OpenApiConfig


description: An enumeration.

title: NifiAuthType

key: NifiAuthType


description: Whether to ignore case sensitivity during pattern matching.

title: Ignorecase

description: List of regex patterns to exclude from ingestion.

title: Deny

description: List of regex patterns to include in ingestion

title: Allow

description: A class to store allow deny regexes

title: AllowDenyPattern

key: AllowDenyPattern


title: Source Platform

title: Connector Name

title: Source Dataset

title: GenericConnectorConfig

key: GenericConnectorConfig


enum: YES NO ONLY

description: A holder for directives for emission for specific types of entities

title: EmitDirective

key: EmitDirective


description: Secret

title: Hmac Access Secret

description: Access ID

title: Hmac Access Id

title: HMACKey

key: HMACKey


description: An enumeration.

title: LineageMode

key: LineageMode


description: Extra schema registry config serialized as JSON. These options will be passed into Kafka's SchemaRegistryClient. https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html?#schemaregistryclient

title: Schema Registry Config

title: Bootstrap

title: Schema Registry Url

description: The request timeout used when interacting with the Kafka APIs.

title: Client Timeout Seconds

description: Extra consumer config serialized as JSON. These options will be passed into Kafka's DeserializingConsumer. See https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#deserializingconsumer and https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md .

title: Consumer Config

description: Configuration class for holding connectivity information for Kafka consumers

title: KafkaConsumerConnectionConfig

key: KafkaConsumerConnectionConfig


title: DemoDataConfig


required: provider path_key value

title: Path Key

title: Value

title: Provider

title: ProvidedConfig

key: ProvidedConfig


description: Passed to https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#confluent_kafka.SerializingProducer

description: Passed to https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#confluent_kafka.schema_registry.SchemaRegistryClient

description: Kafka bootstrap URL.

description: URL of schema registry being used.

default: MetadataChangeProposal

description: Overridden Kafka topic name for the MetadataChangeProposal

default: MetadataChangeEvent

description: Overridden Kafka topic name for the MetadataChangeEvent


description: Private key in a form of '-----BEGIN PRIVATE KEY-----\nprivate-key\n-----END PRIVATE KEY-----\n'

title: Private Key

description: Private key id

title: Private Key Id

description: Token uri

title: Token Uri

description: Auth provider x509 certificate url

title: Auth Provider X509 Cert Url

description: Authentication uri

title: Auth Uri

description: Client email

title: Client Email

description: Client Id

title: Client Id

description: Project id to set the credentials

title: Project Id

description: Authentication type

title: Type

description: If not set it will be default to https://www.googleapis.com/robot/v1/metadata/x509/client_email

title: Client X509 Cert Url

title: BigQueryCredential

key: BigQueryCredential


description: The configuration required for initializing the state provider. Default: The datahub_api config if set at pipeline level. Otherwise, the default DatahubClientConfig. See the defaults (https://github.com/datahub-project/datahub/blob/master/metadata-ingestion/src/datahub/ingestion/graph/client.py#L19).

title: Config

description: The type of the state provider to use. For DataHub use `datahub`

title: Type

title: DynamicTypedStateProviderConfig

key: DynamicTypedStateProviderConfig


enum: microsoft okta

description: An enumeration.

title: OAuthIdentityProvider

key: OAuthIdentityProvider


description: Reference to a hosted Git repository. Used to generate "view source" links.

title: GitReference

description: Name of your Git repo e.g. https://github.com/datahub-project/datahub or https://gitlab.com/gitlab-org/gitlab. If organization/repo is provided, we assume it is a GitHub repo.

title: Repo

description: Template for generating a URL to a file in the repo e.g. '{repo_url}/blob/{branch}/{file_path}'. We can infer this for GitHub and GitLab repos, and it is otherwise required.It supports the following variables: {repo_url}, {branch}, {file_path}

title: Url Template

description: Branch on which your files live by default. Typically main or master. This can also be a commit hash.

title: Branch

key: GitReference


description: An enumeration.

title: SalesforceAuthType

key: SalesforceAuthType


description: Whether we want to query datahub-gms for upstream data. False means it will hard replace upstream data for a given entity. True means it will query the backend for existing upstreams and include it in the ingestion run

title: Preserve Upstream

description: File path or URL to lineage file to ingest.

title: File

title: LineageFileSourceConfig


required: match replace

description: Pattern to match on uri-s as part of reference resolution. See replace field

title: Match

description: Pattern to replace with as part of reference resolution. See match field

title: Replace

title: URIReplacePattern

key: URIReplacePattern


description: For files without extension it will assume the specified file type. If it is not set the files without extensions will be skipped.

title: Default Extension

description: Enable or disable processing compressed files. Currently .gz and .bz files are supported.

title: Enable Compression

description: Display name of the dataset.Combination of named variables from include path and strings

title: Table Name

description: Not listing all the files but only taking a handful amount of sample file to infer the schema. File count and file size calculation will be disabled. This can affect performance significantly if enabled

title: Sample Files

description: list of paths in glob pattern which will be excluded while scanning for the datasets

title: Exclude

default: csv tsv json parquet avro

description: Files with extenstions specified here (subset of default value) only will be scanned to create dataset. Other files will be omitted.

title: File Types

description: Path to table. Name variable `{table}` is used to mark the folder with dataset. In absence of `{table}`, file level dataset will be created. Check below examples for more details.

title: Include

title: PathSpec

key: PathSpec


enum: STREAM BATCH AUTO

description: An enumeration.

title: FileReadMode

key: FileReadMode


title: Pattern

title: LookerNamingPattern

key: LookerNamingPattern


description: The type of the ingestion state provider registered with datahub.

title: Enabled

description: Soft-deletes the entities present in the last successful run but missing in the current run with stateful_ingestion enabled.

title: Remove Stale Metadata

description: Base specialized config for Stateful Ingestion with stale metadata removal capability.

title: StatefulStaleMetadataRemovalConfig

key: StatefulStaleMetadataRemovalConfig


title: Enabled

description: Basic Stateful Ingestion Specific Configuration for any source.

title: StatefulIngestionConfig

key: StatefulIngestionConfig


description: DataHub platform instance name. To generate correct urn for upstream dataset, this should match with platform instance name used in ingestion recipe of other datahub sources.

title: Platform Instance

default: PROD

description: The environment that all assets produced by DataHub platform ingestion source belong to

title: Env

title: PlatformDetail

key: PlatformDetail


enum: hive presto presto-on-hive trino

description: An enumeration.

title: PrestoOnHiveConfigMode

key: PrestoOnHiveConfigMode


description:
Common Azure credentials config.

https://docs.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-directory-file-acl-python

title: AdlsSourceConfig

description: Azure tenant (Directory) ID required when a `client_secret` is used as a credential.

title: Tenant Id

description: Azure storage account Shared Access Signature (SAS) token that can be used as a credential. **An account key, a SAS token or a client secret is required for authentication.**

title: Sas Token

description: Azure storage account access key that can be used as a credential. **An account key, a SAS token or a client secret is required for authentication.**

title: Account Key

description: Base folder in hierarchical namespaces to start from.

title: Base Path

description: Azure client (Application) ID required when a `client_secret` is used as a credential.

title: Client Id

description: Azure storage account container name.

title: Container Name

description: Azure client secret that can be used as a credential. **An account key, a SAS token or a client secret is required for authentication.**

title: Client Secret

description: Name of the Azure storage account.  See [Microsoft official documentation on how to create a storage account.](https://docs.microsoft.com/en-us/azure/storage/blobs/create-data-lake-storage-account)

title: Account Name

key: AdlsSourceConfig


description: The configuration required for initializing the classifier. If not specified, uses defaults for classifer type.

title: Config

description: The type of the classifier to use. For DataHub,  use `datahub`

title: Type

title: DynamicTypedClassifierConfig

key: DynamicTypedClassifierConfig


description: Path to file to write to.


description:
List of regex patterns to remove from the name of the URN. All of the indices before removal of URNs are considered as the same dataset. These are applied in order for each URN.
        The main case where you would want to have multiple of these if the name where you are trying to remove suffix from have different formats.
        e.g. ending with -YYYY-MM-DD as well as ending -epochtime would require you to have 2 regex patterns to remove the suffixes across all URNs.

title: Urns Suffix Regex

title: CollapseUrns

key: CollapseUrns


description: An enumeration.

title: TagOption

key: TagOption


description: Use PowerBI User email to ingest as corpuser, default is powerbi user identifier

title: Use Powerbi Email

description: Remove PowerBI User email suffix for example, @acryl.io

title: Remove Email Suffix

description: Take PBI dataset configuredBy as dataset owner if exist

title: Dataset Configured By As Owner

description: Need to have certain authority to qualify as owner for example ['ReadWriteReshareExplore','Owner','Admin']

title: Owner Criteria

description: Whether ingest PowerBI user as Datahub Corpuser

title: Create Corp User

title: OwnershipMapping

key: OwnershipMapping


description: Multiplier for exponential backoff when waiting to retry

title: Retry Backoff Multiplier

description: Maximum interval to wait when retrying

title: Max Retry Interval

description: Maximum number of attempts to retry before failing

title: Max Attempts

title: ModeAPIConfig

key: ModeAPIConfig


description: Metabase username.

title: Username

default: public

description: Default schema name to use when schema is not provided in an SQL query

title: Default Schema

description: Metabase host URL.

title: Connect Uri

description: Database name map to use when constructing dataset URN.

title: Database Alias Map

description: Custom mappings between metabase database id and DataHub platform instance

title: Database Id To Instance Map

description: The environment that all assets produced by this connector belong to

title: Env

description: Custom mappings between metabase database engines and DataHub platforms

title: Engine Platform Map

description: Metabase password.

title: Password

description: A holder for platform -> platform_instance mappings to generate correct dataset urns

title: Platform Instance Map

description:
Any non-Dataset source that produces lineage to Datasets should inherit this class.
e.g. Orchestrators, Pipelines, BI Tools etc.

title: MetabaseConfig


description: Generate guid urns instead of a plaintext path urn with the node/term's hierarchy.

title: Enable Auto Id

format: path

description: File path or URL to business glossary file to ingest.

title: File

title: BusinessGlossarySourceConfig


description: Environment to use when constructing URNs

title: Environment

description: Path to Feast repository

title: Path

description: Path to the `feature_store.yaml` file used to configure the feature store

title: Fs Yaml File

title: FeastRepositorySourceConfig


title: Platform

title: Platform Instance

title: Default Schema

title: Default Db

description: The environment that the platform is located in. Leaving this empty will inherit defaults from the top level Looker configuration

title: Platform Env

title: LookerConnectionDefinition

key: LookerConnectionDefinition


default: PATCH

description: Whether the new tags, terms and owners to be added will override the existing ones added only by this source or not. Value for this config can be "PATCH" or "OVERRIDE"

title: Write Semantics

description: Delimiter to use when parsing CSV

title: Delimiter

description: Delimiter to use when parsing array fields (tags, terms and owners)

title: Array Delimiter

description: File path or URL of CSV file to ingest.

title: Filename

title: CSVEnricherConfig


description: A regex pattern used to match, cannot be empty. If you need a pattern that matches every string use ".*"

default: true

description: Whether to ignore case.

default: false

description: Whether to invert the match.

key: PatternDto-nullable


description: Expert settings for the Apache httpd.

description: Expert settings for the Security Gate.

key: ExpertSettingsDto-nullable


description: Enable this default header action

description: Name of the default header action

title: dto action

key: DefaultActionDto


description: Whether to ignore case.

title: pattern

key: PatternWithoutInvertDto


description: The name of the header to add.

description: The value of the header to add.

key: SimpleHeaderActionDto-nullable


description: The actual pattern.

key: SimplePatternDto-nullable


required: directory file command

required: directory file arguments

description: The working directory of the compilation. All paths specified in the command or file fields must be either absolute or relative to this directory.

description: The name of the output created by this compilation step. This field is optional. It can be used to distinguish different processing modes of the same input file.

description: The compile command executed. After JSON unescaping, this must be a valid command to rerun the exact compilation step for the translation unit in the environment the build system uses. Parameters use shell quoting and shell escaping of quotes, with '"' and '\' being the only special characters. Shell expansion is not supported.

description: The compile command executed as list of strings.

description: The main translation unit source processed by this compilation step. This is used by tools as the key into the compilation database. There can be multiple command objects for the same file, for example if the same source file is compiled with different configurations.

key: commandObject


required: name path

description: Path to the plugin folder

description: Version of the plugin, if not set, will match any version the engine requests.

description: Name of the plugin

title: PluginOptions

key: pluginOptions


enum: string integer boolean array

title: SimpleConfigType

key: simpleConfigType


description: 用户行为类型

description: 情绪得分

description: 说明

description: 展示颜色

description: 行为名称

description: 想法

description: 痛点

key: UserAction


key: Partial<Record<SectionType,number>>


description: List of branch name masks (doubleglob) to ignore

description: List of branch name masks (doubleglob) to match

description: List of tag masks (doubleglob) to ignore

description: List of tag masks (doubleglob) to match

key: BranchesOrTags


description: Test flags to use in addition to defined in /etc/bazel.bazelrc

description: List of bazel targets to test

description: List of bazel targets to build

description: Build flags to use in addition to defined in /etc/bazel.bazelrc

key: BazelStep


description: List of path masks (doubleglob) to match. If not specified, all paths are matched

description: List of path masks (doubleglob) to match. If not specified, all paths are ignored

key: BranchesAndPaths


format: regex

type: string object

key: sourceSchema


$id: scopeTemplate

type: string array

key: scopeTemplate


description: Relationship pivot table definition for this relationship

description: AggregateName of Pivot table, example: IamRolesAccounts

description: Filename of pivot table model file, example: roles-accounts

description: Module path where table model file will be saved, example: iam/role

key: pivotTable


required: path resolverType httpMethod

description: Path to access api

enum: query mutation

description: Type of resolver, query or mutation

enum: get post put delete patch

description: Verb of api rest

key: apiDefinition


description: Web Component that wil be rendered for this property

description: The type of web component

key: webComponent


key: command


default: script-src 'self'; object-src 'self'

description: This introduces some fairly strict policies that will make extensions more secure by default, and provides you with the ability to create and enforce rules governing the types of content that can be loaded and executed by your extensions and applications.


enum: <all_urls> activeTab alarms bookmarks browsingData contextMenus contextualIdentities cookies downloads downloads.open geolocation history identity idle management nativeMessaging notifications proxy sessions storage tabs topSites webNavigation webRequest webRequestBlocking

key: permissions


title: Command

description: Command information

examples:
npm run test
echo "This is a custom command"

title: Bash command to run

enum: root workspace

examples: root workspace

title: Folder where to run the command

Description: Hides sensitive variables from ENV variables when calling the command

title: Secured Environment Variables

Description: If command fails, continue MegaLinter process or not

title: Continue if failed


enum: ACTION ANSIBLE ARM BASH BICEP C CLOJURE CLOUDFORMATION COFFEE COPYPASTE CPP CSHARP CSS DART DOCKERFILE EDITORCONFIG ENV GHERKIN GO GRAPHQL GROOVY HTML JAVA JAVASCRIPT JSON JSX KOTLIN KUBERNETES LATEX LUA MAKEFILE MARKDOWN OPENAPI PERL PHP POWERSHELL PROTOBUF PUPPET PYTHON R RAKU REPOSITORY RST RUBY RUST SALESFORCE SCALA SNAKEMAKE SPELL SQL SWIFT TEKTON TERRAFORM TSX TYPESCRIPT VBDOTNET XML YAML CREDENTIALS GIT


description: The max value.

title: Max

description: The minimum value.

title: Minimum

key: numberRange


enum: error warn ignore

description: Determines the error level

key: base


description: Locale that should be downloaded. Locale ID or locale name are valid options


description: ID of the project


description: Enforces a specific encoding on the file contents. Valid options are "UTF-8", "UTF-16" and "ISO-8859-1"

key: encoding


default: yml

description: File format name. See the format guide in the documentation for all supported file formats.


description: A single rule defined in the SSH agent config for which keys to include in the SSH agent. Each field may be the UUID or another identifier, which varies per field.

description: Can be either an item UUID or name

description: Can be either an account UUID or signin address or account name

description: Can be either a vault UUID or name

key: AgentConfigRule


description:
Start of Area A
Cannot be used if enableIndentation is false

description:
Indent Length
Cannot be used if enableIndentation is false

key: dataDivIndent


enum: none upper lower mixed

key: cobolCapitalizationOptions


description:
Indent length of INVALID KEY block
Cannot be used if enableIndentation is false
Cannot be used if indentForAllBlocks is used

description:
Indent length of AT END OF PAGE block
Cannot be used if enableIndentation is false
Cannot be used if indentForAllBlocks is used

description:
Indent length of ON EXCEPTION block
Cannot be used if enableIndentation is false
Cannot be used if indentForAllBlocks is used

description:
Indent length of NOT AT END block
Cannot be used if enableIndentation is false
Cannot be used if indentForAllBlocks is used

description:
Indent length of EXEC block
Cannot be used if enableIndentation is false
Cannot be used if indentForAllBlocks is used

description:
Indent END-EXEC phrase
Cannot be used if enableIndentation is false
END-EXEC phrase will be indented with Exec Block

description:
Indent length of IF block
Cannot be used if enableIndentation is false
Cannot be used if indentForAllBlocks is used

description:
Indent length of NOT ON EXCEPTION block
Cannot be used if enableIndentation is false
Cannot be used if indentForAllBlocks is used

description:
Indent length of ON OVERFLOW block
Cannot be used if enableIndentation is false
Cannot be used if indentForAllBlocks is used

description:
Indent length of NOT AT END OF PAGE block
Cannot be used if enableIndentation is false
Cannot be used if indentForAllBlocks is used

description:
Indent length of INVALID KEY
Cannot be used if enableIndentation is false
Cannot be used if indentForAllBlocks is used

description:
Indent length of NOT ON SIZE ERROR block
Cannot be used if enableIndentation is false
Cannot be used if indentForAllBlocks is used

description:
Indent length of PERFORM block
Cannot be used if enableIndentation is false
Cannot be used if indentForAllBlocks is used

description:
Indent length of AT END block
Cannot be used if enableIndentation is false
Cannot be used if indentForAllBlocks is used

description:
Indent length of ON SIZE ERROR block
Cannot be used if enableIndentation is false
Cannot be used if indentForAllBlocks is used

description:
Indent length of WHEN block
Cannot be used if enableIndentation is false
Cannot be used if indentForAllBlocks is used

description:
Indent length of NOT ON OVERFLOW block
Cannot be used if enableIndentation is false
Cannot be used if indentForAllBlocks is used

key: blockIndent


enum: upper lower

key: copybookCapitalizationOptions


required: crate name

description: Index of a crate in the `crates` array.

title: Crate index

description: Name as should appear in the (implicit) `extern crate name` declaration.

title: Name

title: Dependencies

key: dep


enum: error success

type: array string

default: auto

type: string number

enum: include exclude pass

default: success

enum: failure success

key: default


enum: parent pr auto

key: notification


type: boolean array

key: flag


enum: header footer diff file files flag flags reach sunburst uncovered

key: layout


description: Allows you to define conditions for the `post:` action execution. The `post:` action will only run if the conditions in `post-if` are met. If not set, then `post-if` defaults to `always()`.

key: post-if


description: A string identifier to associate with the output. The value of `<output_id>` is a map of the output's metadata. The `<output_id>` must be a unique identifier within the outputs object. The `<output_id>` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.

description: A string description of the output parameter.

description:
Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input.
If you don't declare an output in your action metadata file, you can still set outputs and use them in a workflow.

key: outputs


description: Allows you to define conditions for the `pre:` action execution. The `pre:` action will only run if the conditions in `pre-if` are met. If not set, then `pre-if` defaults to `always()`. Note that the `step` context is unavailable, as no steps have run yet.

key: pre-if


$comment: escape `{` and `}` in pattern to be unicode compatible (#1360)

key: stringContainingExpressionSyntax


key: expressionSyntax


required: description value

description: The value that the output parameter will be mapped to. You can set this to a string or an expression with context. For example, you can use the steps context to set the value of an output to the output value of a step.

key: outputs-composite


enum: Point MultiPoint LineString MultiLineString Polygon MultiPolygon GeometryCollection

description: A geometry is a GeoJSON object where the type member's value is one of the following strings: `Point`, `MultiPoint`, `LineString`, `MultiLineString`, `Polygon`, `MultiPolygon`, or `GeometryCollection`.

title: Geometry

key: geometry


title: Coordinates

key: coordinates


description:
A position is the fundamental geometry construct. The `coordinates` member of a geometry object is composed of one position (in the case of a Point geometry), an array of positions (LineString or MultiPoint geometries), an array of arrays of positions (Polygons, MultiLineStrings), or a multidimensional array of positions (MultiPolygon).

A position is represented by an array of numbers. There must be at least two elements, and may be more. The order of elements must follow x, y, z order (easting, northing, altitude for coordinates in a projected coordinate reference system, or longitude, latitude, altitude for coordinates in a geographic coordinate reference system). Any number of additional elements are allowed -- interpretation and meaning of additional elements is beyond the scope of this specification.

title: Position

key: position


required: level roles

key: BlueprintRoles


key: GCEGPUTypeExtension


key: UIActionItem


key: BlueprintOrgPolicyCheck


key: GCEIPForwardingExtension


required: description url

key: BlueprintCostEstimate


key: GCELocationExtension


key: ResourceTypeMeta


required: repo sourceType

key: BlueprintRepoDetail


key: BlueprintSoftware


key: BlueprintDiagram


required: diagramUrl description

key: BlueprintArchitecture


key: BlueprintDescription


key: IAMServiceAccountExtension


key: BlueprintTimeEstimate


key: BlueprintSupport


key: BlueprintVariable


key: BlueprintVariableGroup


key: BlueprintActuationTool


key: GCENetworkExtension


key: DisplaySection


key: BlueprintCloudProduct


key: GCEExternalIPExtension


key: GCEMachineTypeExtension


required: resourceType quotaType

key: BlueprintQuotaDetail


description: The data bytes transmitted in an HTTP transaction message immediately following the headers if there are any

title: Body

key: body


description: Number of times an alert should return true before Monika sends incident notifications

key: incidentThreshold


description: Postgres uri connection configuration

title: URI connection

required: host port database

description: Username with access to the database

title: Username

description: Postgres host address to connect to

description: User's database password

title: Password

description: Postgres port to connect to

title: Port

description: Name of the database

title: Database

description: Monitor postgres readiness

title: Postgres

key: postgres


description: Number of times an alert should return false before Monika sends recovery notifications

key: recoveryThreshold


description: The number of seconds to repeat the probe

title: Interval

key: interval


description: redis uri connection configuration

title: URI connection

required: host port

description: Username used for the redis AUTH, if set.

title: Username

description: The hostname or IP address of the redis server

title: Redis host

description: Password used for the redis AUTH, if set.

title: Password

description: Port number used for the redis

title: Port number

description: Monitor redis health

title: Redis

key: redis


required: assertion message

default: Http Response status code is not 200!

description: Message that will be sent to the notification channel

title: Message

default: response.status != 200

description: An expression that will trigger an alert when its is logically true. See the assertions here: https://monika.hyperjump.tech/guides/alerts#alert-query

title: Assertion

required: query message

description: Note: Query is deprecated, please use assertion

title: Query

title: Message

description: The condition which will trigger an alert and the subsequent notification

title: Alerts

key: alerts


description: Initiates a request for cross-origin resource sharing (asks server for Access-Control-* response fields)

description: List of acceptable encodings

description: General header used to inform how long a persistent connection should stay open

description: Media type(s) that is/are acceptable for the response

description: The user agent string of the user agent

description: Character sets that are acceptable

description: General header that allows the sender or client to specify options that are desired for that particular connection

description: An HTTP cookie previously sent by the server with Set-Cookie

description: Used to specify directives that must be obeyed by all caching mechanisms along the request-response chain

description: This is the address of the previous web page (referrer) from which a link to the currently requested page was followed

description: The Media type of the body of the request (used with POST and PUT requests

description: Authentication credentials for HTTP authentication

description: A list of strings sent and received by both the client program and server on every HTTP request and response

title: Headers

key: headers


description: Socket is a TCP type request

title: Socket

required: host port data

description: Address to your host

description: Data payload for the request

title: Data

description: Host port to connect to

title: Port

key: socket


required: host port username password database

description: User with access to the database

title: Username

description: The hostname or IP address of the database server

title: Database host

description: User password for authentication

title: Password

description: Port number used by your database server

title: Port number

default: Name of the database

title: Database

description: Monitor MariaDB/Mysql health

title: MariaDB/Mysql

key: mariadb


description: Username used for the MongoDB AUTH, if set.

title: Username

description: The hostname or IP address of the MongoDB server

title: MongoDB host

description: Password used for the MongoDB AUTH, if set.

title: Password

title: MongoDB URI

description: Port number used for the MongoDB

title: Port number

description: Monitor MongoDB health

title: MongoDB

key: mongo


enum: on off

description:
🐊Putout rule

"off" means rule is off
"on" means it is a on

key: rule


description: This can be FIFO or FAIR, to control whether jobs within the pool queue up behind each other (the default) or share the pool’s resources fairly.

description: Max number of Spark jobs to run in parallel, default is 1

description: Scheduler filename in the metadata folder. If not set, defaults to fairscheduler.xml.

description: Pool name to use for Spark jobs, default is 'default'

key: JobScheduling


description: should expectations be executed ?

description: When using filesystem storage, the path to the expectations file

key: Expectations


const: string

description: Any string that match the '.*' regex

const: long

description:
Any whole number that match the '[-|+|0-9][0-9]*' regex.
ints are mapped to as 'int' in some database whereas 'longs are mapped as 'bigint' and shorts as 'smallint'

const: int

const: short

const: double

description: Any decimal number that match the '[-+]?\d*\.?\d+[Ee]?[-+]?\d*' regex

const: boolean

description:
Any string that match the '(?i)true|yes|[y1]<-TF->(?i)false|no|[n0]' regex,
where the value on the left of '<-T' represent true and values on the right of 'F->' represent the false

const: byte

description: Any single char

const: date

description: Any date that match the 'yyyy-MM-dd' regex (2023-12-31)

description: Any date that match the 'yyyyMMdd' regex (20231231)

description: Timestamp based on `ISO Date with offset` pattern (2023-12-31+02:00)

description: Timestamp based on `ISO Date with or without offset` pattern (2011-12-03+02:00)

description: Timestamp based on `ISO Local Date and Time` pattern (2023-12-31T10:15:30)

description: Timestamp based on `ISO Local Date and Time` pattern (2023-12-31T10:15:30+01:00)

description: Timestamp based on `ISO Zoned Date Time`pattern (2023-12-31T10:15:30+01:00[Europe/Paris])

description: Timestamp based on `ISO Date and time with ZoneId` pattern (2011-12-03T10:15:30+01:00[Europe/Paris])

description: Timestamp based on `year and day of year` pattern (2023-337)

description: Timestamp based on `Year and Week` pattern (2012-W48-6)

description: Timestamp based on `Date and Time of an Instant` pattern - UTC only - (2023-12-31T10:15:30Z)

description: Timestamp based on `RFC 1123 / RFC 822` patterns (Tue, 3 Jun 2008 11:05:30 GMT)

const: timestamp

description:
date/time that match the 'yyyy-MM-dd HH:mm:ss' regex s (2019-12-31 23:59:02).
For epoch timestamp, set pattern attribute to 'epoch_second' or 'epoch_milli'

const: decimal

description: Any floating value that match the '-?\d*\.{0,1}\d+' regex

const: struct

description: Any attribute that has children. Set the array to true if this attribute is made of a list of attributes

key: PrimitiveType


const: text

const: keyword

const: integer

const: float

const: binary

const: ip

const: completion

const: object

const: array

key: IndexMapping


description: configure Spark internal options

description: Internal use. Do not modify.

description:
May be parquet or ORC. Default is parquet. Used for BigQuery intermediate storage. Use ORC for for JSON files to keep the original data structure.
https://stackoverflow.com/questions/53674838/spark-writing-parquet-arraystring-converts-to-a-different-datatype-when-loadin

description:
How the RDD are cached. Default is MEMORY_AND_DISK_SER.
Available options are (https://spark.apache.org/docs/latest/api/java/index.html?org/apache/spark/storage/StorageLevel.html):
- MEMORY_ONLY
- MEMORY_AND_DISK
- MEMORY_ONLY_SER
- MEMORY_AND_DISK_SER
- DISK_ONLY
- OFF_HEAP

description: The GCS bucket that temporarily holds the data before it is loaded to BigQuery.

key: Internal


description: Map of string

key: MapString


required: table domain database

description: Output for ref object

key: RefOutput


const: DSV

description: any single or multiple character delimited file. Separator is specified in the separator field

const: POSITION

description: any fixed position file. Positions are specified in the position field

const: JSON

description:
any deep json file.
To improve performance, prefer the SIMPLE_JSON format if your json documents are flat

description: any json file containing an array of json objects.

description:
any flat json file.
To improve performance, prefer this format if your json documents are flat

const: XML

description: any xml file. Use the metadata.xml.rowTag field to specify the root tag of your xml file

description: DSV by default. Supported file formats are :\n- DSV : Delimiter-separated values file. Delimiter value is specified in the "separator" field.\n- POSITION : FIXED format file where values are located at an exact position in each line.\n- SIMPLE_JSON : For optimisation purpose, we differentiate JSON with top level values from JSON\n  with deep level fields. SIMPLE_JSON are JSON files with top level fields only.\n- JSON :  Deep JSON file. Use only when your json documents contain sub-documents, otherwise prefer to\n  use SIMPLE_JSON since it is much faster.\n- XML : XML files

key: Format


required: name grants

description: Row level security policy to apply to the output data.

description: The condition that goes to the WHERE clause and limit the visible rows.

description:
user / groups / service accounts to which this security level is applied.
ex : user:me@mycompany.com,group:group@mycompany.com,serviceAccount:mysa@google-accounts.com

description: This Row Level Security unique name

description: Description for this access policy

key: RowLevelSecurity


description: Should metrics be computed ?

description: When using filesystem storage, the path to the metrics file

description: Max number of unique values accepted for a discrete column. Default is 10

key: Metrics


const: SA

description: Service account

const: USER

description: End user

const: GROUP

description: Group of users / service accounts

key: UserType


description: DDL used to create a table

description: SQL CREATE DDL statement

description:
How to test if the table exist.
Use the following statement by default: 'select count(*) from tableName where 1=0'

key: TableDdl


description: Files that cannot be ingested (do not match by any table pattern) are moved to this folder.

description: When filesystem storage is used, rejected records are stored in this folder in parquet format or any format set by the SL_DEFAULT_WRITE_FORMAT env property.

description: Invalid records are stored in this folder in source format when SL_SINK_REPLAY_TO_FILE is set to true.

description: Files that are being ingested are moved to this folder.

description: When filesystem storage is used, successfully ingested stored in this this folder in parquet format or any format set by the SL_DEFAULT_WRITE_FORMAT env property.

description: Files that have been ingested are moved to this folder if SL_ARCHIVE is set to true.

description: Files recognized by the extensions property are moved to this folder for ingestion by the "import" command.

key: Area


description: Should access policies be enforced ?

description: Taxonomy name. Required if apply is true.

description: GCP project location. Required if apply is true.

description: GCP Project id. Required if apply is true.

key: AccessPolicies


const: OVERWRITE

description: That data will overwrite the existing data or create it if it does not exist

const: APPEND

description: Append the data to an existing table or create it if it does not exist

description: Fail if teh table already exist

const: IGNORE

description: Do not save at all. Useful in interactive / test mode.

description: Append to or overwrite existing data

key: WriteMode


description: DAG reference

description: Cron expression to use for this domain/table

key: Airflow


description: Tables to scan in this domain

description: Schema in JDBC Database / Snowflake / Redshift or Dataset in BigQuery

key: ExternalDomain


description: Input for ref object

description: Table pattern to match

description: Domain pattern to match, none if any domain match

description: Database pattern to match, none if any database

key: RefInput


description: Partition columns, no partitioning by default

description: Attributes used to partition de dataset.

description: 0.0 means no sampling, > 0  && < 1 means sample dataset, >=1 absolute number of partitions. Used exclusively on Hadoop & databricks warehouses

key: Partition


description: How old may be teh data before a warning is raised. Use syntax like '3 day' or '2 hour' or '30 minute'

description: How old may be teh data before an error is raised. Use syntax like '3 day' or '2 hour' or '30 minute'

key: Freshness


required: name comment

description: Column description

description: Access policy to apply to this column

description: Column name

key: AttributeDesc


required: first last

description: Zero based position of the last character to include in this attribute

description: Zero based position of the first character for this attribute

key: Position


const: TABLE

description: SQl Table

const: VIEW

description: SQl View

const: SYSTEM TABLE

description: Database specific system table

const: GLOBAL TEMPORARY

const: LOCAL TEMPORARY

const: ALIAS

description: Table alias

const: SYNONYM

description: Table synonym

description: Table types supported by the Extract module

key: TableType


description: Name of the lock

description: Name of the lock

description: Name of the lock

description: Name of the lock

key: Lock


const: LEFT

description: Remove all leading space chars from the input

const: RIGHT

description: Remove all trailing spaces from the input

const: BOTH

description: Remove all leading and trailing spaces from the input

description: Do not remove leading or trailing spaces from the input

key: Trim


required: role grants

description: Column level security policy to apply to the attribute.

description:
user / groups / service accounts to which this security level is applied.
ex : user:me@mycompany.com,group:group@mycompany.com,serviceAccount:mysa@google-accounts.com

description: This role to give to the granted users

key: AccessControlEntry


description: Timestamp column used to identify last version, if not specified currently ingested row is considered the last

description:
Useful when you want to merge only on a subset of the existing partitions, thus improving performance and reducing costs.
You may use here:
- Any SQL condition
- latest which will be translated to the last existing partition
- column in last(10) which will apply the merge on the last 10 partitions of your dataset.
 last and latest assume that your table is partitioned by day.

description: list of attributes to join an existing and incoming dataset. Use renamed columns if any here.

description: Optional valid delete condition on the incoming dataset. Use renamed column here.

key: MergeOptions


description: table name. Set to '*' to extract all tables

description: List of columns to extract. All columns by default.

key: JDBCTable


markdownDescription: Defines scripts that should run *before* the job. Can be set globally or per job. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#before_script).


markdownDescription: Additional attributes will be provided to job if any of the provided paths matches an existing file in the repository. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#rulesexists).

key: exists