@Generated(value="OracleSDKGenerator", comments="API Version: 20180418") public class StreamAdminClient extends Object implements StreamAdmin
Modifier and Type | Class and Description |
---|---|
static class |
StreamAdminClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for StreamAdmin.
|
Modifier | Constructor and Description |
---|---|
|
StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration.
|
protected |
StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
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.
|
GetConnectHarnessResponse |
getConnectHarness(GetConnectHarnessRequest request)
Gets detailed information about a connect harness.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
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 |
refreshClient()
Rebuilds the client from scratch.
|
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’).
|
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.
|
public static final Service SERVICE
Service instance for StreamAdmin.
public StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorprotected StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
Use the StreamAdminClient.Builder
to get access to all these parameters.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static StreamAdminClient.Builder builder()
Create a builder for this client.
public void refreshClient()
StreamAdmin
Rebuilds the client from scratch. Useful to refresh certificates.
refreshClient
in interface StreamAdmin
public void setEndpoint(String endpoint)
StreamAdmin
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface StreamAdmin
endpoint
- The endpoint of the service.public String getEndpoint()
StreamAdmin
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface StreamAdmin
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 void close()
close
in interface AutoCloseable
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
Copyright © 2016–2022. All rights reserved.