From ecf42ddd333dab016c68d6b81d0c08c5615a070a Mon Sep 17 00:00:00 2001 From: feczo Date: Fri, 30 Dec 2016 13:49:12 +1100 Subject: [PATCH 1/3] fixing doc string location and content The block moved applies to the set method not to the get method, also the set method does not work with partial values --- .../DataflowPipelineWorkerPoolOptions.java | 20 ++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.java b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.java index 05086b0d8901..e6cc10a1a122 100644 --- a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.java +++ b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.java @@ -204,18 +204,20 @@ public String create(PipelineOptions options) { List getFilesToStage(); void setFilesToStage(List value); + String getWorkerDiskType(); + /** - * Specifies what type of persistent disk should be used. The value should be a full or partial - * URL of a disk type resource, e.g., zones/us-central1-f/disks/pd-standard. For - * more information, see the - * API reference - * documentation for DiskTypes. + * Specifies what type of persistent disk should be used. The value should be a + * full disk type resource, e.g., + * compute.googleapis.com/projects//zones//diskTypes/pd-ssd. For more information, + * see the API + * reference documentation for DiskTypes. */ - @Description("Specifies what type of persistent disk should be used. The value should be a full " - + "or partial URL of a disk type resource, e.g., zones/us-central1-f/disks/pd-standard. For " - + "more information, see the API reference documentation for DiskTypes: " + @Description("Specifies what type of persistent disk should be used. The " + + "value should be a full URL of a disk type resource, e.g., " + + "compute.googleapis.com/projects//zones//diskTypes/pd-ssd. For more " + + "information, see the API reference documentation for DiskTypes: " + "https://cloud.google.com/compute/docs/reference/latest/diskTypes") - String getWorkerDiskType(); void setWorkerDiskType(String value); /** From d9c0e6de1c5edce1b9238badd7422e06dcd805ed Mon Sep 17 00:00:00 2001 From: feczo Date: Wed, 4 Jan 2017 16:24:16 +1100 Subject: [PATCH 2/3] Update DataflowPipelineWorkerPoolOptions.java since this is a get method doc, slightly adjusting the wording to reflect that "should be used" sounds like something passed onto set, that at least a few people found to be confusing --- .../options/DataflowPipelineWorkerPoolOptions.java | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.java b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.java index e6cc10a1a122..722a1a113ee3 100644 --- a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.java +++ b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.java @@ -203,21 +203,19 @@ public String create(PipelineOptions options) { @JsonIgnore List getFilesToStage(); void setFilesToStage(List value); - - String getWorkerDiskType(); - + /** - * Specifies what type of persistent disk should be used. The value should be a - * full disk type resource, e.g., - * compute.googleapis.com/projects//zones//diskTypes/pd-ssd. For more information, + * Specifies what type of persistent disk is used. The value is a full disk type resource, + * e.g., compute.googleapis.com/projects//zones//diskTypes/pd-ssd. For more information, * see the API * reference documentation for DiskTypes. */ - @Description("Specifies what type of persistent disk should be used. The " - + "value should be a full URL of a disk type resource, e.g., " + @Description("Specifies what type of persistent disk is used. The " + + "value is a full URL of a disk type resource, e.g., " + "compute.googleapis.com/projects//zones//diskTypes/pd-ssd. For more " + "information, see the API reference documentation for DiskTypes: " + "https://cloud.google.com/compute/docs/reference/latest/diskTypes") + String getWorkerDiskType(); void setWorkerDiskType(String value); /** From 617eaad243145cd9f13cc8aa5a2a8087273e94ab Mon Sep 17 00:00:00 2001 From: feczo Date: Wed, 4 Jan 2017 16:24:44 +1100 Subject: [PATCH 3/3] Update DataflowPipelineWorkerPoolOptions.java --- .../dataflow/options/DataflowPipelineWorkerPoolOptions.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.java b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.java index 722a1a113ee3..3c5d05afd1ae 100644 --- a/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.java +++ b/runners/google-cloud-dataflow-java/src/main/java/org/apache/beam/runners/dataflow/options/DataflowPipelineWorkerPoolOptions.java @@ -203,7 +203,7 @@ public String create(PipelineOptions options) { @JsonIgnore List getFilesToStage(); void setFilesToStage(List value); - + /** * Specifies what type of persistent disk is used. The value is a full disk type resource, * e.g., compute.googleapis.com/projects//zones//diskTypes/pd-ssd. For more information,