org.apache.beam.sdk.options.Validation.Required Java Examples

/**
 * Output the requirement groups that the property is a member of, including all properties that
 * satisfy the group requirement, breaking up long lines on white space characters and attempting
 * to honor a line limit of {@code TERMINAL_WIDTH}.
 */
private static void prettyPrintRequiredGroups(
    PrintStream out,
    Required annotation,
    SortedSetMultimap<String, String> requiredGroupNameToProperties) {
  if (annotation == null || annotation.groups() == null) {
    return;
  }
  for (String group : annotation.groups()) {
    SortedSet<String> groupMembers = requiredGroupNameToProperties.get(group);
    String requirement;
    if (groupMembers.size() == 1) {
      requirement = Iterables.getOnlyElement(groupMembers) + " is required.";
    } else {
      requirement = "At least one of " + groupMembers + " is required";
    }
    terminalPrettyPrint(out, requirement.split("\\s+"));
  }
}
 

@Description(
    "The output file to write failures during the decompression process "
        + "(e.g. gs://bucket-name/decompressed/failed.txt). The contents will be one line for "
        + "each file which failed decompression. Note that this parameter will "
        + "allow the pipeline to continue processing in the event of a failure.")
@Required
ValueProvider<String> getOutputFailureFile();
 

@Description(
    "DLP API has a limit for payload size of 524KB /api call. "
        + "That's why dataflow process will need to chunk it. User will have to decide "
        + "on how they would like to batch the request depending on number of rows "
        + "and how big each row is.")
@Required
ValueProvider<Integer> getBatchSize();
 

@Description(
    "The output file to write failures during the compression process "
        + "(e.g. gs://bucket-name/compressed/failed.txt). The contents will be one line for "
        + "each file which failed compression. Note that this parameter will "
        + "allow the pipeline to continue processing in the event of a failure.")
@Required
ValueProvider<String> getOutputFailureFile();
 

/**
 * Returns a map of required groups of arguments to the properties that satisfy the requirement.
 */
private static SortedSetMultimap<String, String> getRequiredGroupNamesToProperties(
    Map<String, Method> propertyNamesToGetters) {
  SortedSetMultimap<String, String> result = TreeMultimap.create();
  for (Map.Entry<String, Method> propertyEntry : propertyNamesToGetters.entrySet()) {
    Required requiredAnnotation =
        propertyEntry.getValue().getAnnotation(Validation.Required.class);
    if (requiredAnnotation != null) {
      for (String groupName : requiredAnnotation.groups()) {
        result.put(groupName, propertyEntry.getKey());
      }
    }
  }
  return result;
}
 

@Required
@Description(
    "JSON string representation of the Store that import job will write FeatureRow to."
        + "Store follows the format in feast.core.Store proto."
        + "Multiple Store can be passed by specifying '--store={...}' multiple times"
        + "The conversion of Proto message to JSON should follow this mapping:"
        + "https://developers.google.com/protocol-buffers/docs/proto3#json"
        + "Please minify and remove all insignificant whitespace such as newline in the JSON string"
        + "to prevent error when parsing the options")
List<String> getStoresJson();
 

@Description(
    "DLP API has a limit for payload size of 524KB /api call. "
        + "That's why dataflow process will need to chunk it. User will have to decide "
        + "on how they would like to batch the request depending on number of rows "
        + "and how big each row is.")
@Required
ValueProvider<Integer> getBatchSize();
 

@Required
@Description(
    "JSON string representation of the SpecsPipe configuration."
        + "Job will use this to know where read new FeatureSetSpec from (kafka broker & topic)"
        + "and where send acknowledgment on successful update of job's state to."
        + "SpecsStreamingUpdateConfig follows the format in feast.core.IngestionJob.SpecsStreamingUpdateConfig proto."
        + "The conversion of Proto message to JSON should follow this mapping:"
        + "https://developers.google.com/protocol-buffers/docs/proto3#json"
        + "Please minify and remove all insignificant whitespace such as newline in the JSON string"
        + "to prevent error when parsing the options")
String getSpecsStreamingUpdateConfigJson();
 

@Required
@Description(
    "JSON string representation of the Source that will be used to read FeatureRows from."
        + "Source follows the format in featst.core.Source proto. Currently only kafka source is supported"
        + "The conversion of Proto message to JSON should follow this mapping:"
        + "https://developers.google.com/protocol-buffers/docs/proto3#json"
        + "Please minify and remove all insignificant whitespace such as newline in the JSON string"
        + "to prevent error when parsing the options")
String getSourceJson();
 

/**
 * Set this option to choose a different input file or glob.
 */
@Description("Path of the file to read from")
@Required
String getInputFile();
 

@Override
@Description("The ID of the Google Genomics variant set from which this pipeline "
    + "will identify private variants.")
@Required
String getVariantSetId();
 

@Description("The compression algorithm to use on the matched files.")
@Required
ValueProvider<Compression> getCompression();
 

/** Set this required option to specify where to write the output. */
@Description("Path of the file to write to")
@Required
String getOutput();
 

@Required
@Description("The ID of the Google Genomics variant set this pipeline is accessing.")
String getVariantSetId();
 

@Description("Path of the output file including its filename prefix.")
@Required
String getOutput();
 

@Required
@Description("The Google Cloud Bigtable instance ID .")
String getBigtableInstanceId();
 

@Required
@Description("The Cloud Bigtable table ID in the instance." )
String getBigtableTableId();
 

@Description("The Cloud Pub/Sub topic to read from.")
@Required
String getInputTopic();
 

@Description("The Cloud Storage filepath to a comma-separated or tab-separated file of variant ids. "
    + "The variant id will be retrieved from the first column.  Any other columns will be ignored. "
    + "The file should not include any header lines.")
@Required
String getInput();
 

@Description("The output location to write to (e.g. gs://bucket-name/compressed)")
@Required
ValueProvider<String> getOutputDirectory();
 

@Description("The input file pattern to read from (e.g. gs://bucket-name/uncompressed/*.gz)")
@Required
ValueProvider<String> getInputFilePattern();
 

@Description(
    "DLP Deidentify Template to be used for API request "
        + "(e.g.projects/{project_id}/deidentifyTemplates/{deIdTemplateId}")
@Required
ValueProvider<String> getDeidentifyTemplateName();
 

@Description(
    "DLP Deidentify Template to be used for API request "
        + "(e.g.projects/{project_id}/deidentifyTemplates/{deIdTemplateId}")
@Required
ValueProvider<String> getDeidentifyTemplateName();
 

/**
 * Set this required option to specify where to write the output.
 */
@Description("Path of the file to write to")
@Required
String getOutput();
 

@Description("The output location to write to (e.g. gs://bucket-name/decompressed)")
@Required
ValueProvider<String> getOutputDirectory();
 

@Description("The input file pattern to read from (e.g. gs://bucket-name/compressed/*.gz)")
@Required
ValueProvider<String> getInputFilePattern();
 

@Description("The Avro Write Temporary Directory. Must end with /")
@Required
ValueProvider<String> getAvroTempDirectory();
 

@Description("The directory to output files to. Must end with a slash.")
@Required
ValueProvider<String> getOutputDirectory();
 

@Description("The Cloud Pub/Sub topic to read from.")
@Required
ValueProvider<String> getInputTopic();
 

@Description("As sub-processes can be heavy weight define the level of concurrency level")
@Required
Integer getConcurrency();