Package com.oracle.bmc.streaming.requests

Class GetMessagesRequest.Builder

java.lang.Object

com.oracle.bmc.streaming.requests.GetMessagesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<GetMessagesRequest,Void>

Enclosing class:

GetMessagesRequest

public static class GetMessagesRequest.Builder
extends Object
implements BmcRequest.Builder<GetMessagesRequest,Void>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetMessagesRequest	build()	Build the instance of GetMessagesRequest as configured by this builder
GetMessagesRequest	buildWithoutInvocationCallback()	Build the instance of GetMessagesRequest as configured by this builder
GetMessagesRequest.Builder	copy(GetMessagesRequest o)	Copy method to populate the builder with values from the given instance.
GetMessagesRequest.Builder	cursor(String cursor)	The cursor used to consume the stream.
GetMessagesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
GetMessagesRequest.Builder	limit(Integer limit)	The maximum number of messages to return.
GetMessagesRequest.Builder	opcRequestId(String opcRequestId)	The unique Oracle-assigned identifier for the request.
GetMessagesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
GetMessagesRequest.Builder	streamId(String streamId)	The OCID of the stream.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

streamId

public GetMessagesRequest.Builder streamId(String streamId)

The OCID of the stream.

Parameters:

streamId - the value to set

Returns:

this builder instance

cursor

public GetMessagesRequest.Builder cursor(String cursor)

The cursor used to consume the stream.

Parameters:

cursor - the value to set

Returns:

this builder instance

limit

public GetMessagesRequest.Builder limit(Integer limit)

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.

Parameters:

limit - the value to set

Returns:

this builder instance

opcRequestId

public GetMessagesRequest.Builder opcRequestId(String opcRequestId)

The unique Oracle-assigned identifier for the request.

If you need to contact Oracle about a particular request, please provide the request ID.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

public GetMessagesRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public GetMessagesRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public GetMessagesRequest.Builder copy(GetMessagesRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<GetMessagesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public GetMessagesRequest build()

Build the instance of GetMessagesRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<GetMessagesRequest,Void>

Returns:

instance of GetMessagesRequest

buildWithoutInvocationCallback

public GetMessagesRequest buildWithoutInvocationCallback()

Build the instance of GetMessagesRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of GetMessagesRequest