Exception ApiException (2.83.0)

2.83.0 (latest) 2.82.0 2.81.0 2.80.0 2.79.0 2.76.0 2.75.0 2.74.1 2.73.1 2.72.2 2.71.0 2.70.3 2.69.0 2.68.2 2.67.0 2.66.0 2.65.0 2.63.1 2.62.0 2.61.0 2.60.0 2.59.1 2.58.0 2.57.0 2.55.0 2.54.1 2.53.0 2.52.0 2.51.0 2.50.0 2.49.0 2.48.1 2.47.0 2.46.1 2.45.0 2.43.0 2.42.0 2.41.0 2.39.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.1 2.33.0 2.32.1 2.31.1 2.30.1 2.24.0 2.23.3 2.22.0 2.21.0 2.20.1 2.19.6 2.18.7 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.2 2.11.0 2.10.0 2.9.0 2.8.1 2.7.1

public class ApiException extends RuntimeException

Represents an exception thrown during an RPC call.

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

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()

Constructors

ApiException(@Nullable String message, @Nullable Throwable cause, StatusCode statusCode, boolean retryable)

public ApiException(@Nullable String message, @Nullable Throwable cause, StatusCode statusCode, boolean retryable)

Parameters
Name	Description
message	@org.jspecify.annotations.Nullable java.lang.String
cause	@org.jspecify.annotations.Nullable java.lang.Throwable
statusCode	StatusCode
retryable	boolean

ApiException(@Nullable String message, @Nullable Throwable cause, StatusCode statusCode, boolean retryable, @Nullable ErrorDetails errorDetails)

public ApiException(@Nullable String message, @Nullable Throwable cause, StatusCode statusCode, boolean retryable, @Nullable ErrorDetails errorDetails)

Parameters
Name	Description
message	@org.jspecify.annotations.Nullable java.lang.String
cause	@org.jspecify.annotations.Nullable java.lang.Throwable
statusCode	StatusCode
retryable	boolean
errorDetails	@org.jspecify.annotations.Nullable com.google.api.gax.rpc.ErrorDetails

ApiException(@Nullable Throwable cause, StatusCode statusCode, boolean retryable)

public ApiException(@Nullable Throwable cause, StatusCode statusCode, boolean retryable)

Parameters
Name	Description
cause	@org.jspecify.annotations.Nullable java.lang.Throwable
statusCode	StatusCode
retryable	boolean

ApiException(@Nullable Throwable cause, StatusCode statusCode, boolean retryable, @Nullable ErrorDetails errorDetails)

public ApiException(@Nullable Throwable cause, StatusCode statusCode, boolean retryable, @Nullable ErrorDetails errorDetails)

Parameters
Name	Description
cause	@org.jspecify.annotations.Nullable java.lang.Throwable
statusCode	StatusCode
retryable	boolean
errorDetails	@org.jspecify.annotations.Nullable com.google.api.gax.rpc.ErrorDetails

Methods

getDomain()

public @Nullable String getDomain()

Returns the logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. e.g. googleapis.com

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.String

getErrorDetails()

public ErrorDetails getErrorDetails()

Returns all standard error messages that server sends.

Returns
Type	Description
ErrorDetails

getMetadata()

public @Nullable Map<String,String> getMetadata()

Returns additional structured details about this exception.

Returns
Type	Description
@org.jspecify.annotations.Nullable java.util.Map<String,String>

getReason()

public @Nullable String getReason()

Returns the reason of the exception. This is a constant value that identifies the proximate cause of the error. e.g. SERVICE_DISABLED

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.String

getStatusCode()

public StatusCode getStatusCode()

Returns the status code of the underlying exception.

Returns
Type	Description
StatusCode

isRetryable()

public boolean isRetryable()

Returns whether the failed request can be retried.

Returns
Type	Description
boolean