@Generated(value="OracleSDKGenerator", comments="API Version: 20180418") public class StreamAdminClient extends BaseSyncClient implements StreamAdmin
Modifier and Type | Class and Description |
---|---|
static class |
StreamAdminClient.Builder
Builder class for this client.
|
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 StreamAdmin.
|
Constructor and Description |
---|
StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Deprecated.
Use the
builder instead. |
StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
Modifier and Type | Method and Description |
---|---|
static StreamAdminClient.Builder |
builder()
Create a builder for this client.
|
ChangeConnectHarnessCompartmentResponse |
changeConnectHarnessCompartment(ChangeConnectHarnessCompartmentRequest request)
Moves a resource into a different compartment.
|
ChangeStreamCompartmentResponse |
changeStreamCompartment(ChangeStreamCompartmentRequest request)
Moves a resource into a different compartment.
|
ChangeStreamPoolCompartmentResponse |
changeStreamPoolCompartment(ChangeStreamPoolCompartmentRequest request)
Moves a resource into a different compartment.
|
void |
close() |
CreateConnectHarnessResponse |
createConnectHarness(CreateConnectHarnessRequest request)
Starts the provisioning of a new connect harness.
|
CreateStreamResponse |
createStream(CreateStreamRequest request)
Starts the provisioning of a new stream.
|
CreateStreamPoolResponse |
createStreamPool(CreateStreamPoolRequest request)
Starts the provisioning of a new stream pool.
|
DeleteConnectHarnessResponse |
deleteConnectHarness(DeleteConnectHarnessRequest request)
Deletes a connect harness and its content.
|
DeleteStreamResponse |
deleteStream(DeleteStreamRequest request)
Deletes a stream and its content.
|
DeleteStreamPoolResponse |
deleteStreamPool(DeleteStreamPoolRequest request)
Deletes a stream pool.
|
String |
getClientCommonLibraryVersion() |
GetConnectHarnessResponse |
getConnectHarness(GetConnectHarnessRequest request)
Gets detailed information about a connect harness.
|
protected ClientConfigurator |
getDefaultConfigurator() |
String |
getEndpoint() |
Optional<String> |
getMinimumClientCommonLibraryVersionFromClient() |
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.
|
GetStreamPoolResponse |
getStreamPool(GetStreamPoolRequest request)
Gets detailed information about the stream pool, such as Kafka settings.
|
StreamAdminWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
ListConnectHarnessesResponse |
listConnectHarnesses(ListConnectHarnessesRequest request)
Lists the connectharness.
|
ListStreamPoolsResponse |
listStreamPools(ListStreamPoolsRequest request)
List the stream pools for a given compartment ID.
|
ListStreamsResponse |
listStreams(ListStreamsRequest request)
Lists the streams in the given compartment id.
|
void |
populateServiceParametersInEndpoint(String endpoint,
Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base
endpoint.
|
void |
refreshClient()
Rebuild the backing
HttpClient . |
void |
setEndpoint(String endpoint) |
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’).
|
void |
updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.
|
UpdateConnectHarnessResponse |
updateConnectHarness(UpdateConnectHarnessRequest request)
Updates the tags applied to the connect harness.
|
UpdateStreamResponse |
updateStream(UpdateStreamRequest request)
Updates the stream.
|
UpdateStreamPoolResponse |
updateStreamPool(UpdateStreamPoolRequest request)
Updates the specified stream pool.
|
void |
useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.
|
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for StreamAdmin.
public final String clientCommonLibraryVersion
@Deprecated public StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see StreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see StreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see StreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see StreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see StreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see StreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
@Deprecated public StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see StreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
- ClientBuilderBase.signingStrategyRequestSignerFactories
@Deprecated public StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see StreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
- ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
- StreamAdminClient.Builder.executorService
public static StreamAdminClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
StreamAdmin
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.
setRegion
in interface StreamAdmin
region
- The region of the service.public void setRegion(String regionId)
StreamAdmin
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
.
setRegion
in interface StreamAdmin
regionId
- The public region ID.public ChangeConnectHarnessCompartmentResponse changeConnectHarnessCompartment(ChangeConnectHarnessCompartmentRequest request)
StreamAdmin
Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
changeConnectHarnessCompartment
in interface StreamAdmin
request
- The request object containing the details to sendpublic ChangeStreamCompartmentResponse changeStreamCompartment(ChangeStreamCompartmentRequest request)
StreamAdmin
Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource. The stream will also be moved into the default stream pool in the destination compartment.
changeStreamCompartment
in interface StreamAdmin
request
- The request object containing the details to sendpublic ChangeStreamPoolCompartmentResponse changeStreamPoolCompartment(ChangeStreamPoolCompartmentRequest request)
StreamAdmin
Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.
changeStreamPoolCompartment
in interface StreamAdmin
request
- The request object containing the details to sendpublic CreateConnectHarnessResponse createConnectHarness(CreateConnectHarnessRequest request)
StreamAdmin
Starts the provisioning of a new connect harness. To track the progress of the provisioning,
you can periodically call ConnectHarness
object tells you its current state.
createConnectHarness
in interface StreamAdmin
request
- The request object containing the details to sendpublic CreateStreamResponse createStream(CreateStreamRequest request)
StreamAdmin
Starts the provisioning of a new stream. The stream will be created in the given compartment
id or stream pool id, depending on which parameter is specified. Compartment id and stream
pool id cannot be specified at the same time. 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.
createStream
in interface StreamAdmin
request
- The request object containing the details to sendpublic CreateStreamPoolResponse createStreamPool(CreateStreamPoolRequest request)
StreamAdmin
Starts the provisioning of a new stream pool. To track the progress of the provisioning, you
can periodically call GetStreamPool. In the response, the lifecycleState
parameter of the
object tells you its current state.
createStreamPool
in interface StreamAdmin
request
- The request object containing the details to sendpublic DeleteConnectHarnessResponse deleteConnectHarness(DeleteConnectHarnessRequest request)
StreamAdmin
Deletes a connect harness and its content. Connect harness contents are deleted immediately.
The service retains records of the connect harness itself for 90 days after deletion. The
lifecycleState
parameter of the ConnectHarness
object changes to DELETING
and the
connect harness becomes inaccessible for read or write operations. To verify that a connect
harness has been deleted, make a getConnectHarness
request. If the call returns the connect harness’s lifecycle state as
DELETED
, then the connect harness has been deleted. If the call returns a "404 Not Found"
error, that means all records of the connect harness have been deleted.
deleteConnectHarness
in interface StreamAdmin
request
- The request object containing the details to sendpublic DeleteStreamResponse deleteStream(DeleteStreamRequest request)
StreamAdmin
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.
deleteStream
in interface StreamAdmin
request
- The request object containing the details to sendpublic DeleteStreamPoolResponse deleteStreamPool(DeleteStreamPoolRequest request)
StreamAdmin
Deletes a stream pool. All containing streams will also be deleted. The default stream pool of a compartment cannot be deleted.
deleteStreamPool
in interface StreamAdmin
request
- The request object containing the details to sendpublic GetConnectHarnessResponse getConnectHarness(GetConnectHarnessRequest request)
StreamAdmin
Gets detailed information about a connect harness.
getConnectHarness
in interface StreamAdmin
request
- The request object containing the details to sendpublic GetStreamResponse getStream(GetStreamRequest request)
StreamAdmin
Gets detailed information about a stream, including the number of partitions.
getStream
in interface StreamAdmin
request
- The request object containing the details to sendpublic GetStreamPoolResponse getStreamPool(GetStreamPoolRequest request)
StreamAdmin
Gets detailed information about the stream pool, such as Kafka settings.
getStreamPool
in interface StreamAdmin
request
- The request object containing the details to sendpublic ListConnectHarnessesResponse listConnectHarnesses(ListConnectHarnessesRequest request)
StreamAdmin
Lists the connectharness.
listConnectHarnesses
in interface StreamAdmin
request
- The request object containing the details to sendpublic ListStreamPoolsResponse listStreamPools(ListStreamPoolsRequest request)
StreamAdmin
List the stream pools for a given compartment ID.
listStreamPools
in interface StreamAdmin
request
- The request object containing the details to sendpublic ListStreamsResponse listStreams(ListStreamsRequest request)
StreamAdmin
Lists the streams in the given compartment id. If the compartment id is specified, it will list streams in the compartment, regardless of their stream pool. If the stream pool id is specified, the action will be scoped to that stream pool. The compartment id and stream pool id cannot be specified at the same time.
listStreams
in interface StreamAdmin
request
- The request object containing the details to sendpublic UpdateConnectHarnessResponse updateConnectHarness(UpdateConnectHarnessRequest request)
StreamAdmin
Updates the tags applied to the connect harness.
updateConnectHarness
in interface StreamAdmin
request
- The request object containing the details to sendpublic UpdateStreamResponse updateStream(UpdateStreamRequest request)
StreamAdmin
Updates the stream. Only specified values will be updated.
updateStream
in interface StreamAdmin
request
- The request object containing the details to sendpublic UpdateStreamPoolResponse updateStreamPool(UpdateStreamPoolRequest request)
StreamAdmin
Updates the specified stream pool.
updateStreamPool
in interface StreamAdmin
request
- The request object containing the details to sendpublic StreamAdminWaiters getWaiters()
StreamAdmin
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface StreamAdmin
public StreamAdminPaginators getPaginators()
StreamAdmin
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.
getPaginators
in interface StreamAdmin
protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
Copyright © 2016–2024. All rights reserved.