Skip to content

fix(job): delete old region tag update_job_with_field_mask #9940

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 6, 2025
Merged

fix(job): delete old region tag update_job_with_field_mask #9940

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions jobs/v3/src/main/java/com/google/samples/BasicJobSample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,6 @@ public static Job updateJob(String jobName, Job jobToBeUpdated) throws IOExcepti
// [END job_update_job]

// [START job_update_job_with_field_mask]
// [START update_job_with_field_mask]

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

Since the redundant tag has been removed, it's a good opportunity to add a Javadoc comment explaining the purpose of the updateJobWithFieldMask method. This improves code clarity and maintainability, aligning with the Google Java Style Guide's recommendation for clear and concise comments.

Suggested change
/**
* Updates a job using a field mask to specify which fields to modify.
*/

/** Update a job. */
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

Since this is a public method, it should have a Javadoc comment explaining its purpose, parameters, and return value, per the Google Java Style Guide. I'm recommending this change to adhere to the Google Java Style Guide. Adding clear documentation improves the maintainability and understandability of the code.

Suggested change
/** Update a job. */
/**
* Updates a job using a field mask.
*
* @param jobName The resource name of the job to update.
* @param fieldMask A comma-separated list of fields to update.
* See https://cloud.google.com/sdk/gcloud/reference/run/jobs/update#--update-mask for details.
* @param jobToBeUpdated The job object containing the updated fields.
* @return The updated job.
* @throws IOException if an I/O error occurs during the update operation.
*/

public static Job updateJobWithFieldMask(String jobName, String fieldMask, Job jobToBeUpdated)
Expand All @@ -147,7 +146,6 @@ public static Job updateJobWithFieldMask(String jobName, String fieldMask, Job j
throw e;
}
}
// [END update_job_with_field_mask]
// [END job_update_job_with_field_mask]

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

low

Now that the region tag update_job_with_field_mask has been removed from this file, it's important to verify there are no remaining references to it in other parts of the codebase or documentation. Please double-check to ensure consistency across the project.

// [START job_delete_job]
Expand Down