Skip to content

Commit

Permalink
update javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
mutianf committed Feb 22, 2022
1 parent ef347fd commit 94e96bb
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -215,9 +215,6 @@ public boolean isRefreshingChannel() {
}

/**
* Gets the table ids that will be used to send warmup requests when {@link
* #isRefreshingChannel()} is enabled.
*
* @deprecated This field is ignored. If {@link #isRefreshingChannel()} is enabled, warm up
* requests will be sent to all table ids of the instance.
*/
Expand Down Expand Up @@ -390,9 +387,6 @@ public Builder setPrimingTableIds(String... tableIds) {
}

/**
* Gets the table ids that will be used to send warmup requests when {@link
* #setRefreshingChannel(boolean)} is enabled.
*
* @deprecated This field is ignored. If {@link #isRefreshingChannel()} is enabled, warm up
* requests will be sent to all table ids of the instance.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -236,8 +236,11 @@ public boolean isRefreshingChannel() {
return isRefreshingChannel;
}

/** Gets the tables that will be primed during a channel refresh. */
@BetaApi("Channel priming is not currently stable and might change in the future")
/**
* @deprecated This field is ignored. If {@link #isRefreshingChannel()} is enabled, warm up
* requests will be sent to all table ids of the instance.
*/
@Deprecated
public List<String> getPrimedTableIds() {
return primedTableIds;
}
Expand Down Expand Up @@ -727,9 +730,8 @@ public String getAppProfileId() {
/**
* Sets if channels will gracefully refresh connections to Cloud Bigtable service.
*
* <p>When enabled, this will wait for the connection to complete the SSL handshake. The effect
* can be enhanced by configuring table ids that can be used warm serverside caches using {@link
* #setPrimedTableIds(String...)}.
* <p>When enabled, this will wait for the connection to complete the SSL handshake and warm up
* serverside caches for all the tables of the instance.
*
* @see com.google.cloud.bigtable.data.v2.BigtableDataSettings.Builder#setRefreshingChannel
*/
Expand All @@ -739,8 +741,11 @@ public Builder setRefreshingChannel(boolean isRefreshingChannel) {
return this;
}

/** Configures which tables will be primed when a connection is created. */
@BetaApi("Channel priming is not currently stable and might change in the future")
/**
* @deprecated This field is ignored. If {@link #isRefreshingChannel()} is enabled, warm up
* requests will be sent to all table ids of the instance.
*/
@Deprecated
public Builder setPrimedTableIds(String... tableIds) {
this.primedTableIds = ImmutableList.copyOf(tableIds);
return this;
Expand All @@ -753,8 +758,6 @@ public boolean isRefreshingChannel() {
}

/**
* Gets the tables that will be primed during a channel refresh.
*
* @deprecated This field is ignored. If {@link #isRefreshingChannel()} is enabled, warm up
* requests will be sent to all table ids of the instance.
*/
Expand Down

0 comments on commit 94e96bb

Please sign in to comment.