ParameterMetadata

import type { ParameterMetadata } from "https://googleapis.deno.dev/v1/dataflow:v1b3.ts";

Metadata for a specific parameter.

interface ParameterMetadata {

customMetadata?: {

[key: string]: string;

};

defaultValue?: string;

enumOptions?: ParameterMetadataEnumOption[];

groupName?: string;

helpText?: string;

hiddenUi?: boolean;

isOptional?: boolean;

label?: string;

name?: string;

paramType?:

| "DEFAULT"

| "TEXT"

| "GCS_READ_BUCKET"

| "GCS_WRITE_BUCKET"

| "GCS_READ_FILE"

| "GCS_WRITE_FILE"

| "GCS_READ_FOLDER"

| "GCS_WRITE_FOLDER"

| "PUBSUB_TOPIC"

| "PUBSUB_SUBSCRIPTION"

| "BIGQUERY_TABLE"

| "JAVASCRIPT_UDF_FILE"

| "SERVICE_ACCOUNT"

| "MACHINE_TYPE"

| "KMS_KEY_NAME"

| "WORKER_REGION"

| "WORKER_ZONE"

| "BOOLEAN"

| "ENUM"

| "NUMBER"

| "KAFKA_TOPIC";

parentName?: string;

parentTriggerValues?: string[];

regexes?: string[];

}

§Properties

customMetadata?: {

[key: string]: string;

}

[src]

Optional. Additional metadata for describing this parameter.

defaultValue?: string

[src]

Optional. The default values will pre-populate the parameter with the given value from the proto. If default_value is left empty, the parameter will be populated with a default of the relevant type, e.g. false for a boolean.

enumOptions?: ParameterMetadataEnumOption[]

[src]

Optional. The options shown when ENUM ParameterType is specified.

groupName?: string

[src]

Optional. Specifies a group name for this parameter to be rendered under. Group header text will be rendered exactly as specified in this field. Only considered when parent_name is NOT provided.

helpText?: string

[src]

Required. The help text to display for the parameter.

hiddenUi?: boolean

[src]

Optional. Whether the parameter should be hidden in the UI.

isOptional?: boolean

[src]

Optional. Whether the parameter is optional. Defaults to false.

label?: string

[src]

Required. The label to display for the parameter.

name?: string

[src]

Required. The name of the parameter.

[src]

Optional. The type of the parameter. Used for selecting input picker.

parentName?: string

[src]

Optional. Specifies the name of the parent parameter. Used in conjunction with 'parent_trigger_values' to make this parameter conditional (will only be rendered conditionally). Should be mappable to a ParameterMetadata.name field.

parentTriggerValues?: string[]

[src]

Optional. The value(s) of the 'parent_name' parameter which will trigger this parameter to be shown. If left empty, ANY non-empty value in parent_name will trigger this parameter to be shown. Only considered when this parameter is conditional (when 'parent_name' has been provided).

regexes?: string[]

[src]

Optional. Regexes that the parameter must match.