Skip to content

Commit 270f4ec

Browse files
authored
fix: remove warnings from mvn install (#66)
* fix: remove warnings from mvn install Signed-off-by: Grant Timmerman <[email protected]> * docs: add javadoc description to context Signed-off-by: Grant Timmerman <[email protected]>
1 parent cb4ebf6 commit 270f4ec

File tree

1 file changed

+22
-4
lines changed
  • functions-framework-api/src/main/java/com/google/cloud/functions

1 file changed

+22
-4
lines changed

functions-framework-api/src/main/java/com/google/cloud/functions/Context.java

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,32 @@
1919

2020
/** An interface for event function context. */
2121
public interface Context {
22-
/** Returns event ID. */
22+
/**
23+
* Returns event ID.
24+
*
25+
* @return event ID
26+
*/
2327
String eventId();
2428

25-
/** Returns event timestamp. */
29+
/**
30+
* Returns event timestamp.
31+
*
32+
* @return event timestamp
33+
*/
2634
String timestamp();
2735

28-
/** Returns event type. */
36+
/**
37+
* Returns event type.
38+
*
39+
* @return event type
40+
*/
2941
String eventType();
3042

31-
/** Returns event resource. */
43+
/**
44+
* Returns event resource.
45+
*
46+
* @return event resource
47+
*/
3248
String resource();
3349

3450
/**
@@ -42,6 +58,8 @@ public interface Context {
4258
* extension attributes</a>.
4359
*
4460
* <p>The map returned by this method may be empty but is never null.</p>
61+
*
62+
* @return additional attributes form this event.
4563
*/
4664
default Map<String, String> attributes() {
4765
return Collections.emptyMap();

0 commit comments

Comments
 (0)