• Home
• com.google.apis
• google-api-services-dataflow
• v1b3-rev20231112-2.0.0
• source code
• Status.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.dataflow.model.Status.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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 com.google.api.client.json.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).
 Each `Status` message contains three pieces of data: error code, error message, and error
 details. You can find out more about this error model and how to work with it in the [API Design
 Guide](https://cloud.google.com/apis/design/errors).

 
 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 Dataflow API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.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

All Methods Instance Methods Concrete 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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














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 is 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 is 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 com.google.api.client.json.GenericJson








clone
public Status clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2023 Google. All rights reserved.