docs(bigquery): Add javadoc description of timestamp() parameter. (#3604)

whuffman36 · web-flow · commit 6ee0c103771e · 2024-12-11T16:05:35.000-08:00
* docs(bigquery): Add javadoc description of timestamp() parameter.

* Fix formatting.
diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/QueryParameterValue.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/QueryParameterValue.java
@@ -300,7 +300,12 @@ public static QueryParameterValue bytes(byte[] value) {
     return of(value, StandardSQLTypeName.BYTES);
   }
 
-  /** Creates a {@code QueryParameterValue} object with a type of TIMESTAMP. */
+  /**
+   * Creates a {@code QueryParameterValue} object with a type of TIMESTAMP.
+   *
+   * @param value Microseconds since epoch, e.g. 1733945416000000 corresponds to 2024-12-11
+   *     19:30:16.929Z
+   */
   public static QueryParameterValue timestamp(Long value) {
     return of(value, StandardSQLTypeName.TIMESTAMP);
   }

Original file line number	Diff line number	Diff line change
`@@ -300,7 +300,12 @@ public static QueryParameterValue bytes(byte[] value) {`
`300`	`300`	`return of(value, StandardSQLTypeName.BYTES);`
`301`	`301`	`}`
`302`	`302`
`303`		`- /** Creates a {@code QueryParameterValue} object with a type of TIMESTAMP. */`
	`303`	`+ /**`
	`304`	`+ * Creates a {@code QueryParameterValue} object with a type of TIMESTAMP.`
	`305`	`+ *`
	`306`	`+ * @param value Microseconds since epoch, e.g. 1733945416000000 corresponds to 2024-12-11`
	`307`	`+ * 19:30:16.929Z`
	`308`	`+ */`
`304`	`309`	`public static QueryParameterValue timestamp(Long value) {`
`305`	`310`	`return of(value, StandardSQLTypeName.TIMESTAMP);`
`306`	`311`	`}`