Class JsonRpcRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.rpc2.JsonRpcRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

@Beta
public class JsonRpcRequest
extends GenericData

Beta
JSON-RPC 2.0 request object.

Implementation is not thread-safe.

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from class GenericData

GenericData.Flags

Nested classes/interfaces inherited from class AbstractMap

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

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
private Object	id	Identifier established by the client that must be a string or a number or null for a notification and therefore not expect to receive a response.
private final String	jsonrpc	Version of the JSON-RPC protocol which is "2.0".
private String	method	Name of the method to be invoked.
private Object	params	Structured value that holds the parameter values to be used during the invocation of the method or null for none.

Constructor Summary

Constructors

Constructor	Description
JsonRpcRequest()

Method Summary

Modifier and Type	Method	Description
JsonRpcRequest	clone()	Makes a "deep" clone of the generic data, in which the clone is completely independent of the original.
Object	getId()	Returns the identifier established by the client that must be a string or a number or null for a notification and therefore not expect to receive a response.
String	getMethod()	Returns the name of the method to be invoked.
Object	getParameters()	Returns the structured value that holds the parameter values to be used during the invocation of the method or null for none.
String	getVersion()	Returns the version of the JSON-RPC protocol which is "2.0".
JsonRpcRequest	set(String fieldName, Object value)	Sets the given field value (may be null) for the given field name.
void	setId(Object id)	Sets the identifier established by the client that must be a string or a number or null for a notification and therefore not expect to receive a response.
void	setMethod(String method)	Sets the name of the method to be invoked.
void	setParameters(Object parameters)	Sets the structured value that holds the parameter values to be used during the invocation of the method or null for none.

Methods inherited from class GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class AbstractMap

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

Methods inherited from class Object

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

Methods inherited from interface Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Details

jsonrpc

private final String jsonrpc

Version of the JSON-RPC protocol which is "2.0".

See Also:

• Constant Field Values

id

private Object id

Identifier established by the client that must be a string or a number or null for a notification and therefore not expect to receive a response.

method

private String method

Name of the method to be invoked.

params

private Object params

Structured value that holds the parameter values to be used during the invocation of the method or null for none.

Constructor Details

JsonRpcRequest

public JsonRpcRequest()

Method Details

getVersion

public String getVersion()

Returns the version of the JSON-RPC protocol which is "2.0".

Since:

1.5

getId

public Object getId()

Returns the identifier established by the client that must be a string or a number or null for a notification and therefore not expect to receive a response.

Since:

1.5

setId

public void setId(Object id)

Sets the identifier established by the client that must be a string or a number or null for a notification and therefore not expect to receive a response.

Since:

1.5

getMethod

public String getMethod()

Returns the name of the method to be invoked.

Since:

1.5

setMethod

public void setMethod(String method)

Sets the name of the method to be invoked.

Since:

1.5

getParameters

public Object getParameters()

Returns the structured value that holds the parameter values to be used during the invocation of the method or null for none.

Since:

1.5

setParameters

public void setParameters(Object parameters)

Sets the structured value that holds the parameter values to be used during the invocation of the method or null for none.

Since:

1.5

set

public JsonRpcRequest set(String fieldName,
 Object value)

Description copied from class: GenericData

Sets the given field value (may be null) for the given field name. Any existing value for the field will be overwritten. It may be more slightly more efficient than GenericData.put(String, Object) because it avoids accessing the field's original value.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Overrides:

set in class GenericData

clone

public JsonRpcRequest clone()

Description copied from class: GenericData

Makes a "deep" clone of the generic data, in which the clone is completely independent of the original.

Overrides:

clone in class GenericData