Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modified dataflow templates parameter description #1510

Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -236,8 +236,7 @@ public interface Options
optional = false,
regexes = {".+:.+\\..+"},
description = "Output table to write to",
helpText =
"The fully qualified BigQuery table.",
helpText = "The fully qualified BigQuery table.",
rajkgupt marked this conversation as resolved.
Show resolved Hide resolved
example = "<PROJECT_ID>:<DATASET_NAME>.<TABLE_NAME>")
String getOutputTable();

Expand All @@ -249,8 +248,8 @@ public interface Options
regexes = {"^gs:\\/\\/[^\\n\\r]+$"},
description = "GCS path to javascript fn for transforming output",
helpText =
"The Cloud Storage URI of the `.js` file that defines the JavaScript user-defined function (UDF) " +
"to use.",
"The Cloud Storage URI of the `.js` file that defines the JavaScript user-defined function (UDF) "
+ "to use.",
example = "gs://your-bucket/your-transforms/*.js")
String getJavascriptTextTransformGcsPath();

Expand All @@ -262,10 +261,10 @@ public interface Options
regexes = {"[a-zA-Z0-9_]+"},
description = "UDF Javascript Function Name",
helpText =
"The name of the JavaScript user-defined function (UDF) =to use. For example, if " +
"your JavaScript function code is `myTransform(inJson) { /*...do stuff...*/ }`, then " +
"the function name is `myTransform`. For sample JavaScript UDFs, " +
"see UDF Examples (https://github.com/GoogleCloudPlatform/DataflowTemplates#udf-examples).",
"The name of the JavaScript user-defined function (UDF) =to use. For example, if "
rajkgupt marked this conversation as resolved.
Show resolved Hide resolved
+ "your JavaScript function code is `myTransform(inJson) { /*...do stuff...*/ }`, then "
+ "the function name is `myTransform`. For sample JavaScript UDFs, "
+ "see UDF Examples (https://github.com/GoogleCloudPlatform/DataflowTemplates#udf-examples).",
example = "transform_udf1")
String getJavascriptTextTransformFunctionName();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -479,8 +479,8 @@ public interface TextToBigQueryStreamingOptions
optional = true,
description = "The dead-letter table name to output failed messages to BigQuery",
helpText =
"Table for messages that failed to reach the output table. If it doesn't exist, it is created during " +
"pipeline execution. If not specified, `<outputTableSpec>_error_records` is used.",
"Table for messages that failed to reach the output table. If it doesn't exist, it is created during "
rajkgupt marked this conversation as resolved.
Show resolved Hide resolved
+ "pipeline execution. If not specified, `<outputTableSpec>_error_records` is used.",
example = "<PROJECT_ID>:<DATASET_NAME>.<TABLE_NAME>")
String getOutputDeadletterTable();

Expand Down
rajkgupt marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,7 @@ public interface Options
@TemplateParameter.PubsubSubscription(
order = 1,
description = "Pub/Sub input subscription",
helpText =
"Name of the Pub/Sub subscription.",
helpText = "Name of the Pub/Sub subscription.",
example = "projects/your-project-id/subscriptions/your-subscription-name")
@Validation.Required
String getInputSubscription();
Expand Down Expand Up @@ -285,7 +284,8 @@ public interface Options
order = 12,
optional = true,
description = "withSSLInvalidHostNameAllowed",
helpText = "Boolean value indicating whether an invalid hostname is allowed for the SSL connection.")
helpText =
"Boolean value indicating whether an invalid hostname is allowed for the SSL connection.")
@Default.Boolean(true)
Boolean getWithSSLInvalidHostNameAllowed();

Expand Down