@Generated(value="OracleSDKGenerator", comments="API Version: 20180418") public interface StreamAdmin extends AutoCloseable
Modifier and Type | Method and Description |
---|---|
CreateStreamResponse |
createStream(CreateStreamRequest request)
Starts the provisioning of a new stream.
|
DeleteStreamResponse |
deleteStream(DeleteStreamRequest request)
Deletes a stream and its content.
|
StreamAdminPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
|
GetStreamResponse |
getStream(GetStreamRequest request)
Gets detailed information about a stream, including the number of partitions.
|
StreamAdminWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListStreamsResponse |
listStreams(ListStreamsRequest request)
Lists the streams.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
UpdateStreamResponse |
updateStream(UpdateStreamRequest request)
Updates the tags applied to the stream.
|
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.CreateStreamResponse createStream(CreateStreamRequest request)
Starts the provisioning of a new stream. To track the progress of the provisioning, you can periodically call getStream
. In the response, the lifecycleState
parameter of the Stream
object tells you its current state.
request
- The request object containing the details to sendBmcException
- when an error occurs.DeleteStreamResponse deleteStream(DeleteStreamRequest request)
Deletes a stream and its content. Stream contents are deleted immediately. The service retains records of the stream itself for 90 days after deletion. The lifeCycleState
parameter of the Stream
object changes to DELETING
and the stream becomes inaccessible for read or write operations. To verify that a stream has been deleted, make a getStream
request. If the call returns the stream’s lifecycle state as DELETED
, then the stream has been deleted. If the call returns a "404 Not Found" error, that means all records of the stream have been deleted.
request
- The request object containing the details to sendBmcException
- when an error occurs.GetStreamResponse getStream(GetStreamRequest request)
Gets detailed information about a stream, including the number of partitions.
request
- The request object containing the details to sendBmcException
- when an error occurs.ListStreamsResponse listStreams(ListStreamsRequest request)
Lists the streams.
request
- The request object containing the details to sendBmcException
- when an error occurs.UpdateStreamResponse updateStream(UpdateStreamRequest request)
Updates the tags applied to the stream.
request
- The request object containing the details to sendBmcException
- when an error occurs.StreamAdminWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
StreamAdminPaginators getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable
interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
Copyright © 2016–2019. All rights reserved.