com.google.firebase.auth.DeleteUsersResult Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of firebase-admin Show documentation

This is the official Firebase Admin Java SDK. Build extraordinary native JVM apps in minutes with Firebase. The Firebase platform can power your app’s backend, user authentication, static hosting, and more.

There is a newer version: 9.2.0

Show newest version

/*
 * Copyright 2020 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.firebase.auth;

import static com.google.common.base.Preconditions.checkArgument;

import com.google.common.collect.ImmutableList;
import com.google.firebase.auth.internal.BatchDeleteResponse;
import com.google.firebase.internal.NonNull;
import java.util.List;

/**
 * Represents the result of the {@link FirebaseAuth#deleteUsersAsync(List)} API.
 */
public final class DeleteUsersResult {

  private final int successCount;
  private final List errors;

  DeleteUsersResult(int users, BatchDeleteResponse response) {
    ImmutableList.Builder errorsBuilder = ImmutableList.builder();
    List responseErrors = response.getErrors();
    if (responseErrors != null) {
      checkArgument(users >= responseErrors.size());
      for (BatchDeleteResponse.ErrorInfo error : responseErrors) {
        errorsBuilder.add(new ErrorInfo(error.getIndex(), error.getMessage()));
      }
    }
    errors = errorsBuilder.build();
    successCount = users - errors.size();
  }

  /**
   * Returns the number of users that were deleted successfully (possibly zero). Users that did not
   * exist prior to calling {@link FirebaseAuth#deleteUsersAsync(List)} are considered to be
   * successfully deleted.
   */ 
  public int getSuccessCount() {
    return successCount;
  }

  /**
   * Returns the number of users that failed to be deleted (possibly zero).
   */
  public int getFailureCount() {
    return errors.size();
  }

  /**
   * A list of {@link ErrorInfo} instances describing the errors that were encountered during
   * the deletion. Length of this list is equal to the return value of 
   * {@link #getFailureCount()}.
   *
   * @return A non-null list (possibly empty).
   */
  @NonNull
  public List getErrors() {
    return errors;
  }
}