GraphQLWsRequest (graphql 3.2.0 API)

java.lang.Object
- io.micronaut.configuration.graphql.ws.GraphQLWsRequest

```
public class GraphQLWsRequest
extends java.lang.Object
```
Class to handle the message to and from the websocket.

Since:

1.3

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class GraphQLWsRequest.ClientType
Types of messages received from the client.

Constructor Summary

Constructors
Constructor Description

GraphQLWsRequest()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getId()`	Get the id.
`GraphQLRequestBody`	`getPayload()`	Get the payload.
`GraphQLWsRequest.ClientType`	`getType()`	Get the type.
`void`	`setId(java.lang.String id)`	Sets the id.
`void`	`setPayload(GraphQLRequestBody payload)`	Sets the payload.
`void`	`setType(java.lang.String type)`	Sets the type.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- GraphQLWsRequest
```
public GraphQLWsRequest()
```

Method Detail

getType
```
public GraphQLWsRequest.ClientType getType()
```
Get the type.

Returns:

the type of message as ClientType

setType
```
public void setType(java.lang.String type)
```
Sets the type.

Parameters:

type - the type as string

getId

@Nullable
public java.lang.String getId()

Get the id.

Returns:: id as string

setId

public void setId(@Nullable
                  java.lang.String id)

Sets the id.

Parameters:: id - the id

getPayload
```
@Nullable
public GraphQLRequestBody getPayload()
```
Get the payload.

Returns:

payload as map, likely to contain a graphql query

setPayload

public void setPayload(@Nullable
                       GraphQLRequestBody payload)

Sets the payload.

Parameters:: payload - the payload