com.oracle.bmc.streaming

Class StreamClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.streaming.StreamClient

All Implemented Interfaces:

Stream, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20180418")
public class StreamClient
extends BaseSyncClient
implements Stream

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for Stream.

Constructor Summary

Constructors

Constructor and Description
StreamClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
StreamClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
StreamClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
StreamClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
StreamClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
StreamClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
StreamClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static StreamClientBuilder	builder() Create a builder for this client.
void	close()
ConsumerCommitResponse	consumerCommit(ConsumerCommitRequest request) Provides a mechanism to manually commit offsets, if not using commit-on-get consumer semantics.
ConsumerHeartbeatResponse	consumerHeartbeat(ConsumerHeartbeatRequest request) Allows long-running processes to extend the timeout on partitions reserved by a consumer instance.
CreateCursorResponse	createCursor(CreateCursorRequest request) Creates a cursor.
CreateGroupCursorResponse	createGroupCursor(CreateGroupCursorRequest request) Creates a group-cursor.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetGroupResponse	getGroup(GetGroupRequest request) Returns the current state of a consumer group.
GetMessagesResponse	getMessages(GetMessagesRequest request) Returns messages from the specified stream using the specified cursor as the starting point for consumption.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
PutMessagesResponse	putMessages(PutMessagesRequest request) Emits messages to a stream.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
protected void	setRegion(Region region)
protected void	setRegion(String regionId)
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateGroupResponse	updateGroup(UpdateGroupRequest request) Forcefully changes the current location of a group as a whole; reseting processing location of all consumers to a particular location in the stream.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

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.streaming.Stream

getEndpoint, refreshClient, setEndpoint

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Stream.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

StreamClient

@Deprecated
public StreamClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see Builder#build)

StreamClient

@Deprecated
public StreamClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see Builder#build)

configuration - Builder#configuration

StreamClient

@Deprecated
public StreamClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see Builder#build)

configuration - Builder#configuration

clientConfigurator - Builder#clientConfigurator

StreamClient

@Deprecated
public StreamClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see Builder#build)

configuration - Builder#configuration

clientConfigurator - Builder#clientConfigurator

defaultRequestSignerFactory - Builder#requestSignerFactory

StreamClient

@Deprecated
public StreamClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory,
                                List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see Builder#build)

configuration - Builder#configuration

clientConfigurator - Builder#clientConfigurator

defaultRequestSignerFactory - Builder#requestSignerFactory

additionalClientConfigurators - Builder#additionalClientConfigurators

StreamClient

@Deprecated
public StreamClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory,
                                List<ClientConfigurator> additionalClientConfigurators,
                                String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see Builder#build)

configuration - Builder#configuration

clientConfigurator - Builder#clientConfigurator

defaultRequestSignerFactory - Builder#requestSignerFactory

additionalClientConfigurators - Builder#additionalClientConfigurators

endpoint - Builder#endpoint

StreamClient

@Deprecated
public StreamClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration,
                                ClientConfigurator clientConfigurator,
                                RequestSignerFactory defaultRequestSignerFactory,
                                Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                List<ClientConfigurator> additionalClientConfigurators,
                                String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see Builder#build)

configuration - Builder#configuration

clientConfigurator - Builder#clientConfigurator

defaultRequestSignerFactory - Builder#requestSignerFactory

additionalClientConfigurators - Builder#additionalClientConfigurators

endpoint - Builder#endpoint

signingStrategyRequestSignerFactories - Builder#signingStrategyRequestSignerFactories

Method Detail

builder

public static StreamClientBuilder builder()

Create a builder for this client.

Returns:

builder

consumerCommit

public ConsumerCommitResponse consumerCommit(ConsumerCommitRequest request)

Description copied from interface: Stream

Provides a mechanism to manually commit offsets, if not using commit-on-get consumer semantics. This commits offsets assicated with the provided cursor, extends the timeout on each of the affected partitions, and returns an updated cursor.

Specified by:

consumerCommit in interface Stream

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

consumerHeartbeat

public ConsumerHeartbeatResponse consumerHeartbeat(ConsumerHeartbeatRequest request)

Description copied from interface: Stream

Allows long-running processes to extend the timeout on partitions reserved by a consumer instance.

Specified by:

consumerHeartbeat in interface Stream

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createCursor

public CreateCursorResponse createCursor(CreateCursorRequest request)

Description copied from interface: Stream

Creates a cursor. Cursors are used to consume a stream, starting from a specific point in the partition and going forward from there. You can create a cursor based on an offset, a time, the trim horizon, or the most recent message in the stream. As the oldest message inside the retention period boundary, using the trim horizon effectively lets you consume all messages in the stream. A cursor based on the most recent message allows consumption of only messages that are added to the stream after you create the cursor. Cursors expire five minutes after you receive them from the service.

Specified by:

createCursor in interface Stream

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createGroupCursor

public CreateGroupCursorResponse createGroupCursor(CreateGroupCursorRequest request)

Description copied from interface: Stream

Creates a group-cursor.

Specified by:

createGroupCursor in interface Stream

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getGroup

public GetGroupResponse getGroup(GetGroupRequest request)

Description copied from interface: Stream

Returns the current state of a consumer group.

Specified by:

getGroup in interface Stream

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getMessages

public GetMessagesResponse getMessages(GetMessagesRequest request)

Description copied from interface: Stream

Returns messages from the specified stream using the specified cursor as the starting point for consumption. By default, the number of messages returned is undefined, but the service returns as many as possible. To get messages, you must first obtain a cursor using the createCursor operation. In the response, retrieve the value of the ‘opc-next-cursor’ header to pass as a parameter to get the next batch of messages in the stream.

Specified by:

getMessages in interface Stream

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

putMessages

public PutMessagesResponse putMessages(PutMessagesRequest request)

Description copied from interface: Stream

Emits messages to a stream. There’s no limit to the number of messages in a request, but the total size of a message or request must be 1 MiB or less. The service calculates the partition ID from the message key and stores messages that share a key on the same partition. If a message does not contain a key or if the key is null, the service generates a message key for you. The partition ID cannot be passed as a parameter.

Specified by:

putMessages in interface Stream

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateGroup

public UpdateGroupResponse updateGroup(UpdateGroupRequest request)

Description copied from interface: Stream

Forcefully changes the current location of a group as a whole; reseting processing location of all consumers to a particular location in the stream.

Specified by:

updateGroup in interface Stream

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

setRegion

protected void setRegion(Region region)

setRegion

protected void setRegion(String regionId)

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()