software.amazon.awssdk.eventstreamrpc

Class EventStreamRPCServiceModel

java.lang.Object

software.amazon.awssdk.eventstreamrpc.EventStreamRPCServiceModel

Direct Known Subclasses:

GreengrassCoreIPCServiceModel

public abstract class EventStreamRPCServiceModel
extends Object

Implementers of this service model are expected to likely be singletons. There should be little value to having more than one, though between different instances properly constructed for a service, they can be used interchangeably

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_TYPE_APPLICATION_JSON
static String	CONTENT_TYPE_APPLICATION_TEXT
static String	CONTENT_TYPE_HEADER
static String	SERVICE_MODEL_TYPE_HEADER

Constructor Summary

Constructors

Constructor and Description
EventStreamRPCServiceModel()

Method Summary

Modifier and Type	Method and Description
static boolean	blobTypeEquals(Optional<byte[]> lhs, Optional<byte[]> rhs) Used to compare two members of a blob shape for equality.
<T extends EventStreamJsonMessage> T	fromJson(Class<T> clazz, byte[] payload)
EventStreamJsonMessage	fromJson(String applicationModelType, byte[] payload) Uses this service's specific model class
abstract Collection<String>	getAllOperations() Retreives all operations on the service
Optional<Class<? extends EventStreamJsonMessage>>	getApplicationModelClass(String applicationModelType)
abstract OperationModelContext	getOperationModelContext(String operationName) Retrieves the operation model context for a given operation name on the service This may not be a useful interface as generated code will typically pull a known operation model context Public visibility is useful for testing
abstract String	getServiceName() For actual
static com.google.gson.Gson	getStaticGson() In situations where the framework needs to do some JSON processing without a specific service/operation in context
byte[]	toJson(EventStreamJsonMessage message)
String	toJsonString(EventStreamJsonMessage message)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONTENT_TYPE_HEADER

public static final String CONTENT_TYPE_HEADER

See Also:

Constant Field Values

CONTENT_TYPE_APPLICATION_TEXT

public static final String CONTENT_TYPE_APPLICATION_TEXT

See Also:

Constant Field Values

CONTENT_TYPE_APPLICATION_JSON

public static final String CONTENT_TYPE_APPLICATION_JSON

See Also:

Constant Field Values

SERVICE_MODEL_TYPE_HEADER

public static final String SERVICE_MODEL_TYPE_HEADER

See Also:

Constant Field Values

Constructor Detail

EventStreamRPCServiceModel

public EventStreamRPCServiceModel()

Method Detail

blobTypeEquals

public static boolean blobTypeEquals(Optional<byte[]> lhs,
                                     Optional<byte[]> rhs)

Used to compare two members of a blob shape for equality. Array equals nesting inside of an Optional doesn't work Note: Generated code for equals method of Smithy shapes relies on this

Parameters:

lhs -

rhs -

Returns:

getServiceName

public abstract String getServiceName()

For actual

Returns:

getApplicationModelClass

public final Optional<Class<? extends EventStreamJsonMessage>> getApplicationModelClass(String applicationModelType)

getAllOperations

public abstract Collection<String> getAllOperations()

Retreives all operations on the service

Returns:

getOperationModelContext

public abstract OperationModelContext getOperationModelContext(String operationName)

Retrieves the operation model context for a given operation name on the service This may not be a useful interface as generated code will typically pull a known operation model context Public visibility is useful for testing

Parameters:

operationName -

Returns:

toJson

public byte[] toJson(EventStreamJsonMessage message)

toJsonString

public String toJsonString(EventStreamJsonMessage message)

getStaticGson

public static com.google.gson.Gson getStaticGson()

In situations where the framework needs to do some JSON processing without a specific service/operation in context

Returns:

the static Gson instance capable of processing the basics of EventStreamableJsonMessage

fromJson

public EventStreamJsonMessage fromJson(String applicationModelType,
                                       byte[] payload)

Uses this service's specific model class

Parameters:

applicationModelType -

payload -

Returns:

fromJson

public <T extends EventStreamJsonMessage> T fromJson(Class<T> clazz,
                                                     byte[] payload)