Package software.amazon.awssdk.protocol

Class OperationInfo

java.lang.Object

software.amazon.awssdk.protocol.OperationInfo

public class OperationInfo
extends Object

Static information about an API operation used to marshall it correctly.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationInfo.Builder	Builder for a OperationInfo.

Method Summary

Modifier and Type	Method	Description
static OperationInfo.Builder	builder()
boolean	hasExplicitPayloadMember()
boolean	hasPayloadMembers()
HttpMethodName	httpMethodName()
String	operationIdentifier()
Protocol	protocol()
String	requestUri()
String	serviceName()

Methods inherited from class java.lang.Object

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

Method Detail

protocol

public Protocol protocol()

Returns:

The protocol of the client. Gives hints to the marshaller on how things should be transformed.

requestUri

public String requestUri()

Returns:

Request URI for operation (may contain placeholders for members bound to the uri).

httpMethodName

public HttpMethodName httpMethodName()

Returns:

HTTP Method that should be used when sending the request.

operationIdentifier

public String operationIdentifier()

Returns:

Identifer for the operation/API being invoked. This is used for RPC based protocols that need to identify which action is being taken. For Query/EC2 protocol this is sent as the 'Action' query parameter, for JSON RPC this is sent as the 'X-Amz-Target' header.

serviceName

public String serviceName()

Returns:

Display name for the service. Mainly used for the metrics system but is also available on the Request object (to do something in a RequestHandler for example). This is usually the service interface name but may be customized at generation time ('AmazonDynamoDBv2' for example).

hasExplicitPayloadMember

public boolean hasExplicitPayloadMember()

Returns:

True if the operation has a member that's explicitly marked as the payload. False otherwise. (Applicable only to RESTUL protocols).

hasPayloadMembers

public boolean hasPayloadMembers()

Returns:

True if the operation has members bound to the payload. Some requests (especially GET and DELETE) may not have any members bound to the payload. (Applicable only to RESTFUL protocols).

builder

public static OperationInfo.Builder builder()

Returns:

Builder instance to construct a OperationInfo.