Bigtable admin: deprecate typesafe names part 2 by igorbernstein2 · Pull Request #4258 · googleapis/google-cloud-java · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 1 addition & 1 deletion .kokoro/continuous/bigtableadmin-it.cfg
2 changes: 1 addition & 1 deletion .kokoro/nightly/bigtableadmin-it.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ env_vars: {

env_vars: {
key: "INTEGRATION_TEST_ARGS"
value: "google-cloud-clients/google-cloud-bigtable-admin -Dbigtable.instance=projects/gcloud-devel/instances/google-cloud-bigtable"
value: "google-cloud-clients/google-cloud-bigtable-admin -Dbigtable.project=gcloud-devel -Dbigtable.instance=google-cloud-bigtable"
}

env_vars: {
Expand Down
2 changes: 1 addition & 1 deletion .kokoro/presubmit/bigtableadmin-it.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ env_vars: {

env_vars: {
key: "INTEGRATION_TEST_ARGS"
value: "google-cloud-clients/google-cloud-bigtable-admin -Dbigtable.instance=projects/gcloud-devel/instances/google-cloud-bigtable"
value: "google-cloud-clients/google-cloud-bigtable-admin -Dbigtable.project=gcloud-devel -Dbigtable.instance=google-cloud-bigtable"
}

env_vars: {
Expand Down
3 changes: 2 additions & 1 deletion TESTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,8 @@ To run the tests:
created earlier. Example:
```shell
mvn verify -am -pl google-cloud-bigtable-admin \
-Dbigtable.instance=projects/my-project/instances/my-instance
-Dbigtable.project=my-project
-Dbigtable.instance=my-instance
```

### Testing code that uses Compute
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,13 @@
/**
* Settings class to configure an instance of {@link BigtableInstanceAdminClient}.
*
* <p>It must be configured with a {@link ProjectName} and can be used to change default RPC
* settings.
* <p>It must be configured with a project id and can be used to change default RPC settings.
*
* <p>Example usage:
*
* <pre>{@code
* BigtableInstanceAdminSettings.Builder settingsBuilder = BigtableInstanceAdminSettings.newBuilder()
* .setProjectName(ProjectName.of("my-project"));
* .setProjectId("my-project");
*
* settingsBuilder.stubSettings().createInstanceSettings()
* .setRetrySettings(
Expand All @@ -45,21 +44,32 @@
* }</pre>
*/
public final class BigtableInstanceAdminSettings {
private final ProjectName projectName;
private final String projectId;
private final BigtableInstanceAdminStubSettings stubSettings;

private BigtableInstanceAdminSettings(Builder builder) throws IOException {
Preconditions.checkNotNull(builder.projectName, "ProjectName must be set");
Preconditions.checkNotNull(builder.projectId, "Project ud must be set");
Verify.verifyNotNull(builder.stubSettings, "stubSettings should never be null");

this.projectName = builder.projectName;
this.projectId = builder.projectId;
this.stubSettings = builder.stubSettings.build();
}

/** Gets the anme of the project whose instances the client will manager. */
/** Gets the id of the project whose instances the client will manage. */
@Nonnull
public ProjectName getProjectName() {
return projectName;
public String getProjectId() {
return projectId;
}

/**
* Gets the name of the project whose instances the client will manager.
*
* @deprecated Please use {@link #getProjectId()}.
*/
@Deprecated
@Nonnull
public com.google.bigtable.admin.v2.ProjectName getProjectName() {
return ProjectName.of(projectId);
}

/** Gets the underlying RPC settings. */
Expand All @@ -80,29 +90,53 @@ public static Builder newBuilder() {

/** Builder for BigtableInstanceAdminSettings. */
public static final class Builder {
@Nullable private ProjectName projectName;
@Nullable private String projectId;
private final BigtableInstanceAdminStubSettings.Builder stubSettings;

private Builder() {
stubSettings = BigtableInstanceAdminStubSettings.newBuilder();
}

private Builder(BigtableInstanceAdminSettings settings) {
this.projectName = settings.projectName;
this.projectId = settings.projectId;
this.stubSettings = settings.stubSettings.toBuilder();
}

/** Sets the name of instance whose tables the client will manage. */
public Builder setProjectName(@Nonnull ProjectName projectName) {
Preconditions.checkNotNull(projectName);
this.projectName = projectName;
/** Sets the id of the project whose instances the client will manage. */
public Builder setProjectId(@Nonnull String projectId) {
Preconditions.checkNotNull(projectId);
this.projectId = projectId;
return this;
}

/** Gets the name of the project whose instances the client will manage. */
/** Gets the id of the project whose instances the client will manage. */
@Nullable
public String getProjectId() {
return projectId;
}

/**
* Sets the name of instance whose tables the client will manage.
*
* @deprecated Please use {@link #setProjectId(String)}.
*/
@Deprecated
public Builder setProjectName(@Nonnull com.google.bigtable.admin.v2.ProjectName projectName) {
return setProjectId(projectName.getProject());
}

/**
* Gets the name of the project whose instances the client will manage.
*
* @deprecated Please use {@link #getProjectId()}.
*/
@Deprecated
@Nullable
public ProjectName getProjectName() {
return projectName;
if (projectId != null) {
return ProjectName.of(projectId);
}
return null;
}

/**
Expand Down
Loading