com.google.api.services.dataflow.model

Class Status

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dataflow.model.Status

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Status
extends GenericJson

The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` that can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Dataflow API. For a detailed explanation see: http://code.google.com/p/google-http-java-client/wiki/JSON

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Status()

Method Summary

Methods

Modifier and Type	Method and Description
Status	clone()
Integer	getCode() The status code, which should be an enum value of google.rpc.Code.
List<Map<String,Object>>	getDetails() A list of messages that carry the error details.
String	getMessage() A developer-facing error message, which should be in English.
Status	set(String fieldName, Object value)
Status	setCode(Integer code) The status code, which should be an enum value of google.rpc.Code.
Status	setDetails(List<Map<String,Object>> details) A list of messages that carry the error details.
Status	setMessage(String message) A developer-facing error message, which should be in English.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Status

public Status()

Method Detail

getCode

public Integer getCode()

The status code, which should be an enum value of google.rpc.Code.

Returns:

value or null for none

setCode

public Status setCode(Integer code)

The status code, which should be an enum value of google.rpc.Code.

Parameters:

code - code or null for none

getDetails

public List<Map<String,Object>> getDetails()

A list of messages that carry the error details. There will be a common set of message types for APIs to use.

Returns:

value or null for none

setDetails

public Status setDetails(List<Map<String,Object>> details)

A list of messages that carry the error details. There will be a common set of message types for APIs to use.

Parameters:

details - details or null for none

getMessage

public String getMessage()

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Returns:

value or null for none

setMessage

public Status setMessage(String message)

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Parameters:

message - message or null for none

set

public Status set(String fieldName,
         Object value)

Overrides:

set in class GenericJson

clone

public Status clone()

Overrides:

clone in class GenericJson