Exception FirestoreException (3.3.0)

public class FirestoreException extends BaseGrpcServiceException

A Firestore Service exception.

Inherited Members

com.google.cloud.BaseServiceException.equals(java.lang.Object)

com.google.cloud.BaseServiceException.getCode()

com.google.cloud.BaseServiceException.getDebugInfo()

com.google.cloud.BaseServiceException.getLocation()

com.google.cloud.BaseServiceException.getReason()

com.google.cloud.BaseServiceException.hashCode()

com.google.cloud.BaseServiceException.isRetryable()

com.google.cloud.BaseServiceException.isRetryable(boolean,java.io.IOException)

com.google.cloud.BaseServiceException.isRetryable(java.lang.Integer,java.lang.String,boolean,java.util.Set<com.google.cloud.BaseServiceException.Error>)

com.google.cloud.BaseServiceException.translate(com.google.cloud.RetryHelper.RetryHelperException)

com.google.cloud.BaseServiceException.translate(java.util.concurrent.ExecutionException)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Throwable.addSuppressed(Throwable)

Throwable.fillInStackTrace()

Throwable.getCause()

Throwable.getLocalizedMessage()

Throwable.getMessage()

Throwable.getStackTrace()

Throwable.getSuppressed()

Throwable.initCause(Throwable)

Throwable.printStackTrace()

Throwable.printStackTrace(PrintStream)

Throwable.printStackTrace(PrintWriter)

Throwable.setStackTrace(StackTraceElement[])

Throwable.toString()

Static Methods

forApiException(ApiException exception)

public static FirestoreException forApiException(ApiException exception)

Creates a FirestoreException from an ApiException.

Parameter

Name	Description
exception	`ApiException`

Returns

Type	Description
FirestoreException	The FirestoreException

forApiException(ApiException exception, String message)

public static FirestoreException forApiException(ApiException exception, String message)

Creates a FirestoreException from an ApiException.

Parameters

Name	Description
exception	`ApiException`
message	`String`

Returns

Type	Description
FirestoreException	The FirestoreException

forIOException(IOException exception, boolean retryable)

public static FirestoreException forIOException(IOException exception, boolean retryable)

Creates a FirestoreException from an IOException.

Parameters

Name	Description
exception	`IOException`
retryable	`boolean`

Returns

Type	Description
FirestoreException	The FirestoreException

forInvalidArgument(String message, Object[] params)

public static FirestoreException forInvalidArgument(String message, Object[] params)

Creates a FirestoreException with an INVALID_ARGUMENT status code and the provided message in a nested exception.

Parameters

Name	Description
message	`String`
params	`Object[]`

Returns

Type	Description
FirestoreException	The FirestoreException

forServerRejection(Status status, String message, Object[] params)

public static FirestoreException forServerRejection(Status status, String message, Object[] params)

Creates a FirestoreException with the provided GRPC Status code and message in a nested exception.

Parameters

Name	Description
status	`io.grpc.Status`
message	`String`
params	`Object[]`

Returns

Type	Description
FirestoreException	The FirestoreException

forServerRejection(Status status, Throwable cause, String message, Object[] params)

public static FirestoreException forServerRejection(Status status, Throwable cause, String message, Object[] params)

Creates a FirestoreException with the provided GRPC Status code and message in a nested exception.

Parameters

Name	Description
status	`io.grpc.Status`
cause	`Throwable`
message	`String`
params	`Object[]`

Returns

Type	Description
FirestoreException	The FirestoreException

Methods

getStatus()

public Status getStatus()

Returns

Type	Description
io.grpc.Status