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

Add Documentation Hint for Template Job Creation in DataflowRunner #34204

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

gayatrikate04
Copy link

This PR resolves #18217 by improving the SDK documentation for DataflowPipelineOptions and DataflowRunner.
Changes Made:
Added a hint to the setTemplateLocation method, clarifying its role in creating template jobs in Google Dataflow.
Addressed potential confusion caused by the removal of DataflowTemplateRunner.
Enhanced documentation to improve developer experience and save time.

Let me know if any further improvements are needed. Thanks!

Copy link
Contributor

github-actions bot commented Mar 7, 2025

Checks are failing. Will not request review until checks are succeeding. If you'd like to override that behavior, comment assign set of reviewers

@gayatrikate04
Copy link
Author

Hi there,
I’m working on a pull request, but I’ve run into an issue with the PreCommit Spotless check — it’s failing due to some formatting problems. The issue is that I’m unable to run the Spotless plugin locally, as it doesn’t seem to be configured in the project’s pom.xml file.

Since I can’t modify the pom.xml myself, I wanted to reach out for some advice. Here’s what I was wondering:

  • If the Spotless plugin needs to be added to the pom.xml, could someone help configure it or let me know if that’s something I should wait for the maintainers to do?
  • Alternatively, if there’s a way to format the code correctly without modifying the pom.xml, I’d really appreciate any tips or guidance on how to get the PreCommit Spotless check to pass.

Here’s a quick example of what the Spotless plugin configuration looks like, just in case it’s helpful:

<build>
  <plugins>
    <plugin>
      <groupId>com.diffplug.spotless</groupId>
      <artifactId>spotless-maven-plugin</artifactId>
      <version>2.12.0</version> <!-- latest version -->
      <executions>
        <execution>
          <goals>
            <goal>apply</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Hint to template job creation in DataflowRunner / DataflowPipelineOptions
1 participant