com.ibm.cloud.objectstorage.protocol

Enum Protocol

java.lang.Object

java.lang.Enum<Protocol>

com.ibm.cloud.objectstorage.protocol.Protocol

All Implemented Interfaces:

Serializable, Comparable<Protocol>

public enum Protocol
extends Enum<Protocol>

Supported protocols for the new marshalling style. Currently only includes JSON based services.

Enum Constant Summary

Enum Constants

Enum Constant and Description
API_GATEWAY A variation of REST_JSON for externally generated, API Gateway clients.
AWS_JSON RPC protocol that sends all data in the payload as JSON and sends the X-Amz-Target header to indicate the operation to invoke.
REST_JSON Protocol that supports RESTful bindings.

Method Summary

Modifier and Type	Method and Description
static Protocol	valueOf(String name) Returns the enum constant of this type with the specified name.
static Protocol[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AWS_JSON

public static final Protocol AWS_JSON

RPC protocol that sends all data in the payload as JSON and sends the X-Amz-Target header to indicate the operation to invoke.

REST_JSON

public static final Protocol REST_JSON

Protocol that supports RESTful bindings. Members can be bound to the headers, query params, path, or payload. Supports binary and streaming data. Operation is identified by HTTP verb and resource path combination.

API_GATEWAY

public static final Protocol API_GATEWAY

A variation of REST_JSON for externally generated, API Gateway clients.

Method Detail

values

public static Protocol[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Protocol c : Protocol.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Protocol valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null