Skip to content
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.

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

Fixing BigTable javadoc errors #3459

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
Original file line number Diff line number Diff line change
Expand Up @@ -152,8 +152,6 @@ private TableAdminClient(InstanceName instanceName, BigtableTableAdminStub stub)

/**
* Gets the instanceName this client is associated to
*
* @return InstanceName
*/
public InstanceName getInstanceName() {
return instanceName;
Expand All @@ -179,7 +177,7 @@ public void close() {
* }</pre>
*
* @param createTable
* @return Table - the newly created table
* @return the newly created table
* @see CreateTable for createTable configurations
*/
public Table createTable(CreateTable createTable) {
Expand All @@ -203,7 +201,7 @@ public Table createTable(CreateTable createTable) {
* }</pre>
*
* @param createTable
* @return ApiFuture<Table> - the newly created table
* @return the newly created table
* @see CreateTable for createTable configurations
*/
public ApiFuture<Table> createTableAsync(CreateTable createTable) {
Expand Down Expand Up @@ -240,7 +238,7 @@ public ApiFuture<Table> createTableAsync(CreateTable createTable) {
* }</pre>
*
* @param modifyFamily
* @return Table - Modified table
* @return the modified table
* @see ModifyFamilies for modifyFamily options
*/
public Table modifyFamilies(ModifyFamilies modifyFamily) {
Expand Down Expand Up @@ -279,7 +277,7 @@ public Table modifyFamilies(ModifyFamilies modifyFamily) {
* }</pre>
*
* @param modifyFamily
* @return ApiFuture<Table> - Modified table
* @return Modified table
* @see ModifyFamilies for modifyFamily options
*/
public ApiFuture<Table> modifyFamiliesAsync(ModifyFamilies modifyFamily) {
Expand Down Expand Up @@ -334,7 +332,6 @@ public ApiFuture<Void> deleteTableAsync(String tableId) {
* }</pre>
*
* @param tableId
* @return Table
*/
public Table getTable(String tableId) {
com.google.bigtable.admin.v2.Table table =
Expand All @@ -354,7 +351,6 @@ public Table getTable(String tableId) {
* }</pre>
*
* @param tableId
* @return ApiFuture<Table>
*/
public ApiFuture<Table> getTableAsync(String tableId) {
return transformToTableResponse(
Expand All @@ -371,9 +367,6 @@ public ApiFuture<Table> getTableAsync(String tableId) {
* client.listTables();
* }
* }</pre>
*
* @param tableId
* @return List<TableName>
*/
public List<TableName> listTables() {
ListTablesResponse listResp = this.stub.listTablesCallable().call(composeListTableRequest());
Expand All @@ -390,9 +383,6 @@ public List<TableName> listTables() {
* client.listTablesAsync();
* }
* }</pre>
*
* @param tableId
* @return List<TableName>
*/
public ApiFuture<List<TableName>> listTablesAsync() {
ApiFuture<ListTablesResponse> listResp =
Expand Down Expand Up @@ -512,7 +502,6 @@ public void dropAllRows(String tableId) {
* }</pre>
*
* @param tableId
* @return ApiFuture<Void>
*/
public ApiFuture<Void> dropAllRowsAsync(String tableId) {
return transformToVoid(
Expand All @@ -534,7 +523,6 @@ public ApiFuture<Void> dropAllRowsAsync(String tableId) {
* }</pre>
*
* @param tableId
* @return ConsistencyToken
*/
public ConsistencyToken generateConsistencyToken(String tableId) {
return TableAdminResponses.convertTokenResponse(
Expand All @@ -556,7 +544,6 @@ public ConsistencyToken generateConsistencyToken(String tableId) {
* }</pre>
*
* @param tableId
* @return ApiFuture<ConsistencyToken>
*/
public ApiFuture<ConsistencyToken> generateConsistencyTokenAsync(String tableId) {
ApiFuture<GenerateConsistencyTokenResponse> tokenResp =
Expand Down Expand Up @@ -587,7 +574,6 @@ public ConsistencyToken apply(GenerateConsistencyTokenResponse input) {
*
* @param tableId
* @param token
* @return boolean
*/
public boolean isConsistent(String tableId, ConsistencyToken token) {
return stub.checkConsistencyCallable()
Expand All @@ -608,7 +594,6 @@ public boolean isConsistent(String tableId, ConsistencyToken token) {
*
* @param tableId
* @param token
* @return ApiFuture<Boolean>
*/
public ApiFuture<Boolean> isConsistentAsync(String tableId, ConsistencyToken token) {
ApiFuture<CheckConsistencyResponse> checkConsResp =
Expand All @@ -629,7 +614,7 @@ public Boolean apply(CheckConsistencyResponse input) {
* projects/{project}/instances/{instance}/tables/{tableId}
*
* @param tableId
* @return String - unique table name
* @return unique table name
*/
@VisibleForTesting
String getTableName(String tableId) {
Expand All @@ -638,8 +623,6 @@ String getTableName(String tableId) {

/**
* Helper method to build an instance of ListTablesRequest
*
* @return ListTablesRequest
*/
@VisibleForTesting
ListTablesRequest composeListTableRequest() {
Expand All @@ -650,7 +633,6 @@ ListTablesRequest composeListTableRequest() {
* Helper method to build an instance of GetTableRequest
*
* @param tableId
* @return GetTableRequest
*/
@VisibleForTesting
GetTableRequest composeGetTableRequest(String tableId) {
Expand All @@ -661,7 +643,6 @@ GetTableRequest composeGetTableRequest(String tableId) {
* Helper method to build an instance of DeleteTableRequest
*
* @param tableId
* @return DeleteTableRequest
*/
@VisibleForTesting
DeleteTableRequest composeDeleteTableRequest(String tableId) {
Expand All @@ -674,7 +655,6 @@ DeleteTableRequest composeDeleteTableRequest(String tableId) {
* @param tableId
* @param rowKeyPrefix
* @param boolean dropAll
* @return DropRowRangeRequest
*/
@VisibleForTesting
DropRowRangeRequest composeDropRowRangeRequest(
Expand All @@ -693,7 +673,6 @@ DropRowRangeRequest composeDropRowRangeRequest(
* Helper method to build an instance of GenerateConsistencyTokenRequest
*
* @param tableId
* @return GenerateConsistencyTokenRequest
*/
@VisibleForTesting
GenerateConsistencyTokenRequest composeGenerateConsistencyTokenRequest(String tableId) {
Expand All @@ -704,7 +683,6 @@ GenerateConsistencyTokenRequest composeGenerateConsistencyTokenRequest(String ta
* Helper method to convert ListTablesResponse to List<TableName>
*
* @param listTablesResponse
* @return List<TableName>
*/
@VisibleForTesting
static List<TableName> convertToTableNames(ListTablesResponse listTablesResponse) {
Expand All @@ -720,7 +698,6 @@ static List<TableName> convertToTableNames(ListTablesResponse listTablesResponse
* Helper method to transform ApiFuture<com.google.bigtable.admin.v2.Table> to ApiFuture<Table>
*
* @param future
* @return ApiFuture<Table>
*/
@VisibleForTesting
static ApiFuture<Table> transformToTableResponse(
Expand All @@ -739,7 +716,6 @@ public Table apply(com.google.bigtable.admin.v2.Table table) {
* Helper method to transform ApiFuture<Empty> to ApiFuture<Void>
*
* @param future
* @return ApiFuture<Void>
*/
@VisibleForTesting
static ApiFuture<Void> transformToVoid(ApiFuture<Empty> future) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,13 @@ private GCRules() {}

/**
* Creates a new instance of the IntersectionRule
*
* @return IntersectionRule
*/
public IntersectionRule intersection() {
return new IntersectionRule();
}

/**
* Creates a new instance of the IntersectionRule
*
* @return UnionRule
*/
public UnionRule union() {
return new UnionRule();
Expand All @@ -57,7 +53,6 @@ public UnionRule union() {
* Creates a new instance of the VersionRule
*
* @param maxVersion - maximum number of cell versions to keep
* @return VersionRule
*/
public VersionRule maxVersions(int maxVersion) {
return new VersionRule(maxVersion);
Expand All @@ -68,7 +63,6 @@ public VersionRule maxVersions(int maxVersion) {
*
* @param maxAge - maximum age of the cell to keep
* @param timeUnit - timeunit for the age
* @return DurationRule
*/
public DurationRule maxAge(long maxAge, TimeUnit timeUnit) {
return maxAge(Duration.ofNanos(TimeUnit.NANOSECONDS.convert(maxAge, timeUnit)));
Expand All @@ -78,16 +72,13 @@ public DurationRule maxAge(long maxAge, TimeUnit timeUnit) {
* Creates a new instance of the DurationRule
*
* @param duration - age expressed as duration
* @return DurationRule
*/
public DurationRule maxAge(Duration duration) {
return new DurationRule(duration);
}

/**
* Creates an empty default rule
*
* @return DefaultRule
*/
public DefaultRule defaultRule() {
return new DefaultRule();
Expand All @@ -108,7 +99,6 @@ private IntersectionRule() {
* Adds a new GCRule
*
* @param rule
* @return IntersectionRule
*/
public IntersectionRule rule(@Nonnull GCRule rule) {
rulesList.add(rule);
Expand All @@ -117,8 +107,6 @@ public IntersectionRule rule(@Nonnull GCRule rule) {

/**
* Gets the list of child rules
*
* @return List<GCRule>
*/
public List<GCRule> getRulesList() {
return rulesList;
Expand Down Expand Up @@ -160,7 +148,6 @@ private UnionRule() {
* Adds a new GCRule
*
* @param rule
* @return UnionRule
*/
public UnionRule rule(@Nonnull GCRule rule) {
rulesList.add(rule);
Expand All @@ -169,8 +156,6 @@ public UnionRule rule(@Nonnull GCRule rule) {

/**
* Gets the list of child rules
*
* @return List<GCRule>
*/
public List<GCRule> getRulesList() {
return rulesList;
Expand Down Expand Up @@ -236,8 +221,6 @@ private DurationRule(Duration duration) {

/**
* Gets the configured maximum age
*
* @return Duration
*/
public Duration getMaxAge() {
return Duration.ofSeconds(builder.getSeconds(), builder.getNanos());
Expand Down
Loading