com.oracle.bmc.streaming.requests

Class GetMessagesRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.streaming.requests.GetMessagesRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180418")
public class GetMessagesRequest
extends BmcRequest<Void>

Example: Click here to see how to use GetMessagesRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetMessagesRequest.Builder

Constructor Summary

Constructors

Constructor and Description
GetMessagesRequest()

Method Summary

Modifier and Type	Method and Description
static GetMessagesRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getCursor() The cursor used to consume the stream.
Integer	getLimit() The maximum number of messages to return.
String	getOpcRequestId() The unique Oracle-assigned identifier for the request.
String	getStreamId() The OCID of the stream.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
GetMessagesRequest.Builder	toBuilder() Return an instance of GetMessagesRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

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

Constructor Detail

GetMessagesRequest

public GetMessagesRequest()

Method Detail

getStreamId

public String getStreamId()

The OCID of the stream.

getCursor

public String getCursor()

The cursor used to consume the stream.

getLimit

public Integer getLimit()

The maximum number of messages to return. You can specify any value up to 10000. By default, the service returns as many messages as possible. Consider your average message size to help avoid exceeding throughput on the stream.

getOpcRequestId

public String getOpcRequestId()

The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

toBuilder

public GetMessagesRequest.Builder toBuilder()

Return an instance of GetMessagesRequest.Builder that allows you to modify request properties.

Returns:

instance of GetMessagesRequest.Builder that allows you to modify request properties.

builder

public static GetMessagesRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>