Skip to content

feat(gapic-generator): Add Nullable annotation to generated classes #13558

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

Open
nnicolee wants to merge 8 commits into
base: main
Choose a base branch
from
Open

feat(gapic-generator): Add Nullable annotation to generated classes #13558

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
dc13ef7
feat(gapic-generator): Add Nullable annotation to generated classes
nnicolee Jun 25, 2026
56bb725
feat: revert generator pom.xml and temp compiler dump files
nnicolee Jun 25, 2026
17b370c
feat:update ast + glde
nnicolee Jun 25, 2026
22eb3e6
feat:fixed scoping construct errors
nnicolee Jun 25, 2026
6f283eb
feat: added storage tests
nnicolee Jun 26, 2026
dc59d71
feat:added missing @Nullable and updated goldens
nnicolee Jun 26, 2026
783d6b6
feat: fixed linting
nnicolee Jun 26, 2026
96dffb8
feat: updated @Nullable annotations
nnicolee Jun 29, 2026
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
4 changes: 3 additions & 1 deletion java-showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/ComplianceClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
Expand Down Expand Up @@ -360,7 +361,7 @@
@BetaApi
@Generated("by gapic-generator-java")
public class ComplianceClient implements BackgroundResource {
private final ComplianceSettings settings;
@Nullable private final ComplianceSettings settings;
Comment thread
nnicolee marked this conversation as resolved.
private final ComplianceStub stub;

/** Constructs an instance of ComplianceClient with default settings. */
Expand Down Expand Up @@ -398,6 +399,7 @@ protected ComplianceClient(ComplianceStub stub) {
this.stub = stub;
}

@Nullable
Comment thread
nnicolee marked this conversation as resolved.
public final ComplianceSettings getSettings() {
return settings;
}
Expand Down
4 changes: 3 additions & 1 deletion java-showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/EchoClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
Expand Down Expand Up @@ -369,7 +370,7 @@
@BetaApi
@Generated("by gapic-generator-java")
public class EchoClient implements BackgroundResource {
private final EchoSettings settings;
@Nullable private final EchoSettings settings;
private final EchoStub stub;
private final OperationsClient httpJsonOperationsClient;
private final com.google.longrunning.OperationsClient operationsClient;
Expand Down Expand Up @@ -415,6 +416,7 @@ protected EchoClient(EchoStub stub) {
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}

@Nullable
public final EchoSettings getSettings() {
return settings;
}
Expand Down
4 changes: 3 additions & 1 deletion java-showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/IdentityClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
Expand Down Expand Up @@ -291,7 +292,7 @@
@BetaApi
@Generated("by gapic-generator-java")
public class IdentityClient implements BackgroundResource {
private final IdentitySettings settings;
@Nullable private final IdentitySettings settings;
private final IdentityStub stub;

/** Constructs an instance of IdentityClient with default settings. */
Expand Down Expand Up @@ -329,6 +330,7 @@ protected IdentityClient(IdentityStub stub) {
this.stub = stub;
}

@Nullable
public final IdentitySettings getSettings() {
return settings;
}
Expand Down
8 changes: 5 additions & 3 deletions java-showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/MessagingClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
Expand Down Expand Up @@ -454,7 +455,7 @@
@BetaApi
@Generated("by gapic-generator-java")
public class MessagingClient implements BackgroundResource {
private final MessagingSettings settings;
@Nullable private final MessagingSettings settings;
private final MessagingStub stub;
private final OperationsClient httpJsonOperationsClient;
private final com.google.longrunning.OperationsClient operationsClient;
Expand Down Expand Up @@ -500,6 +501,7 @@ protected MessagingClient(MessagingStub stub) {
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}

@Nullable
public final MessagingSettings getSettings() {
return settings;
}
Expand Down Expand Up @@ -1976,7 +1978,7 @@ public final UnaryCallable<ListBlurbsRequest, ListBlurbsResponse> listBlurbsCall
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<SearchBlurbsResponse, SearchBlurbsMetadata> searchBlurbsAsync(
ProfileName parent, String query) {
@Nullable ProfileName parent, String query) {
SearchBlurbsRequest request =
SearchBlurbsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
Expand Down Expand Up @@ -2013,7 +2015,7 @@ public final OperationFuture<SearchBlurbsResponse, SearchBlurbsMetadata> searchB
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<SearchBlurbsResponse, SearchBlurbsMetadata> searchBlurbsAsync(
RoomName parent, String query) {
@Nullable RoomName parent, String query) {
SearchBlurbsRequest request =
SearchBlurbsRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
Expand Down
4 changes: 3 additions & 1 deletion ...wcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/SequenceServiceClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
Expand Down Expand Up @@ -314,7 +315,7 @@
@BetaApi
@Generated("by gapic-generator-java")
public class SequenceServiceClient implements BackgroundResource {
private final SequenceServiceSettings settings;
@Nullable private final SequenceServiceSettings settings;
private final SequenceServiceStub stub;

/** Constructs an instance of SequenceServiceClient with default settings. */
Expand Down Expand Up @@ -354,6 +355,7 @@ protected SequenceServiceClient(SequenceServiceStub stub) {
this.stub = stub;
}

@Nullable
public final SequenceServiceSettings getSettings() {
return settings;
}
Expand Down
4 changes: 3 additions & 1 deletion java-showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/TestingClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
Expand Down Expand Up @@ -323,7 +324,7 @@
@BetaApi
@Generated("by gapic-generator-java")
public class TestingClient implements BackgroundResource {
private final TestingSettings settings;
@Nullable private final TestingSettings settings;
private final TestingStub stub;

/** Constructs an instance of TestingClient with default settings. */
Expand Down Expand Up @@ -361,6 +362,7 @@ protected TestingClient(TestingStub stub) {
this.stub = stub;
}

@Nullable
public final TestingSettings getSettings() {
return settings;
}
Expand Down
3 changes: 3 additions & 0 deletions java-showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/stub/EchoStub.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
import com.google.showcase.v1beta1.WaitResponse;
import javax.annotation.Generated;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
Expand All @@ -68,10 +69,12 @@
@Generated("by gapic-generator-java")
public abstract class EchoStub implements BackgroundResource {

@Nullable
public OperationsStub getOperationsStub() {
return null;
}

@Nullable
public com.google.api.gax.httpjson.longrunning.stub.OperationsStub getHttpJsonOperationsStub() {
return null;
}
Expand Down
3 changes: 3 additions & 0 deletions ...showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/stub/MessagingStub.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
import com.google.showcase.v1beta1.UpdateRoomRequest;
import javax.annotation.Generated;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
Expand All @@ -74,10 +75,12 @@
@Generated("by gapic-generator-java")
public abstract class MessagingStub implements BackgroundResource {

@Nullable
public OperationsStub getOperationsStub() {
return null;
}

@Nullable
public com.google.api.gax.httpjson.longrunning.stub.OperationsStub getHttpJsonOperationsStub() {
return null;
}
Expand Down
6 changes: 4 additions & 2 deletions ...ase/proto-gapic-showcase-v1beta1/src/main/java/com/google/showcase/v1beta1/BlurbName.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import java.util.Objects;
import javax.annotation.Generated;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
@NullMarked
Expand Down Expand Up @@ -188,6 +189,7 @@ public static String formatRoomLegacyRoomBlurbName(String room, String legacyRoo
.toString();
}

@Nullable

@lqiu96 lqiu96 Jun 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

same here, should be type-use annotation here.

public static BlurbName parse(String formattedString) {
if (formattedString.isEmpty()) {
return null;
Expand Down Expand Up @@ -218,7 +220,7 @@ public static List<BlurbName> parseList(List<String> formattedStrings) {
return list;
}

public static List<String> toStringList(List<BlurbName> values) {
public static List<String> toStringList(List<@Nullable BlurbName> values) {
List<String> list = new ArrayList<>(values.size());
for (BlurbName value : values) {
if (value == null) {
Expand Down Expand Up @@ -275,7 +277,7 @@ public String toString() {
}

@Override
public boolean equals(Object o) {
public boolean equals(@Nullable Object o) {
if (o == this) {
return true;
}
Expand Down
6 changes: 4 additions & 2 deletions ...e/proto-gapic-showcase-v1beta1/src/main/java/com/google/showcase/v1beta1/ProfileName.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import java.util.Objects;
import javax.annotation.Generated;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
@NullMarked
Expand Down Expand Up @@ -65,6 +66,7 @@ public static String format(String user) {
return newBuilder().setUser(user).build().toString();
}

@Nullable
public static ProfileName parse(String formattedString) {
if (formattedString.isEmpty()) {
return null;
Expand All @@ -83,7 +85,7 @@ public static List<ProfileName> parseList(List<String> formattedStrings) {
return list;
}

public static List<String> toStringList(List<ProfileName> values) {
public static List<String> toStringList(List<@Nullable ProfileName> values) {
List<String> list = new ArrayList<>(values.size());
for (ProfileName value : values) {
if (value == null) {
Expand Down Expand Up @@ -125,7 +127,7 @@ public String toString() {
}

@Override
public boolean equals(Object o) {
public boolean equals(@Nullable Object o) {
if (o == this) {
return true;
}
Expand Down
6 changes: 4 additions & 2 deletions ...case/proto-gapic-showcase-v1beta1/src/main/java/com/google/showcase/v1beta1/RoomName.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import java.util.Objects;
import javax.annotation.Generated;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
@NullMarked
Expand Down Expand Up @@ -64,6 +65,7 @@ public static String format(String room) {
return newBuilder().setRoom(room).build().toString();
}

@Nullable
public static RoomName parse(String formattedString) {
if (formattedString.isEmpty()) {
return null;
Expand All @@ -81,7 +83,7 @@ public static List<RoomName> parseList(List<String> formattedStrings) {
return list;
}

public static List<String> toStringList(List<RoomName> values) {
public static List<String> toStringList(List<@Nullable RoomName> values) {
List<String> list = new ArrayList<>(values.size());
for (RoomName value : values) {
if (value == null) {
Expand Down Expand Up @@ -123,7 +125,7 @@ public String toString() {
}

@Override
public boolean equals(Object o) {
public boolean equals(@Nullable Object o) {
if (o == this) {
return true;
}
Expand Down
6 changes: 4 additions & 2 deletions .../proto-gapic-showcase-v1beta1/src/main/java/com/google/showcase/v1beta1/SequenceName.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import java.util.Objects;
import javax.annotation.Generated;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
@NullMarked
Expand Down Expand Up @@ -65,6 +66,7 @@ public static String format(String sequence) {
return newBuilder().setSequence(sequence).build().toString();
}

@Nullable
public static SequenceName parse(String formattedString) {
if (formattedString.isEmpty()) {
return null;
Expand All @@ -83,7 +85,7 @@ public static List<SequenceName> parseList(List<String> formattedStrings) {
return list;
}

public static List<String> toStringList(List<SequenceName> values) {
public static List<String> toStringList(List<@Nullable SequenceName> values) {
List<String> list = new ArrayList<>(values.size());
for (SequenceName value : values) {
if (value == null) {
Expand Down Expand Up @@ -125,7 +127,7 @@ public String toString() {
}

@Override
public boolean equals(Object o) {
public boolean equals(@Nullable Object o) {
if (o == this) {
return true;
}
Expand Down
6 changes: 4 additions & 2 deletions ...-gapic-showcase-v1beta1/src/main/java/com/google/showcase/v1beta1/SequenceReportName.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import java.util.Objects;
import javax.annotation.Generated;
import org.jspecify.annotations.NullMarked;
import org.jspecify.annotations.Nullable;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
@NullMarked
Expand Down Expand Up @@ -65,6 +66,7 @@ public static String format(String sequence) {
return newBuilder().setSequence(sequence).build().toString();
}

@Nullable
public static SequenceReportName parse(String formattedString) {
if (formattedString.isEmpty()) {
return null;
Expand All @@ -83,7 +85,7 @@ public static List<SequenceReportName> parseList(List<String> formattedStrings)
return list;
}

public static List<String> toStringList(List<SequenceReportName> values) {
public static List<String> toStringList(List<@Nullable SequenceReportName> values) {
List<String> list = new ArrayList<>(values.size());
for (SequenceReportName value : values) {
if (value == null) {
Expand Down Expand Up @@ -125,7 +127,7 @@ public String toString() {
}

@Override
public boolean equals(Object o) {
public boolean equals(@Nullable Object o) {
if (o == this) {
return true;
}
Expand Down
Loading
Loading