com.oracle.bmc.streaming

Class StreamAdminClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.streaming.StreamAdminClient

All Implemented Interfaces:

StreamAdmin, AutoCloseable

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StreamAdminClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for StreamAdmin.

Constructor Summary

Constructors

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.

Method Summary

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.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
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()
void	setEndpoint(String arg0)
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.

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.StreamAdmin

getEndpoint, refreshClient, setEndpoint

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for StreamAdmin.

Constructor Detail

StreamAdminClient

@Deprecated
public StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see StreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

StreamAdminClient

@Deprecated
public StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                     ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see StreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

StreamAdminClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see StreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

StreamAdminClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

StreamAdminClient

@Deprecated
public StreamAdminClient(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 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

StreamAdminClient

@Deprecated
public StreamAdminClient(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 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)

StreamAdminClient

@Deprecated
public StreamAdminClient(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 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

StreamAdminClient

@Deprecated
public 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.

Create a new client instance.

Parameters:

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

Method Detail

builder

public static StreamAdminClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: 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.

Specified by:

setRegion in interface StreamAdmin

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: 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.

Specified by:

setRegion in interface StreamAdmin

Parameters:

regionId - The public region ID.

changeConnectHarnessCompartment

public ChangeConnectHarnessCompartmentResponse changeConnectHarnessCompartment(ChangeConnectHarnessCompartmentRequest request)

Description copied from interface: StreamAdmin

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeConnectHarnessCompartment in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeStreamCompartment

public ChangeStreamCompartmentResponse changeStreamCompartment(ChangeStreamCompartmentRequest request)

Description copied from interface: 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.

Specified by:

changeStreamCompartment in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeStreamPoolCompartment

public ChangeStreamPoolCompartmentResponse changeStreamPoolCompartment(ChangeStreamPoolCompartmentRequest request)

Description copied from interface: StreamAdmin

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeStreamPoolCompartment in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createConnectHarness

public CreateConnectHarnessResponse createConnectHarness(CreateConnectHarnessRequest request)

Description copied from interface: 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.

Specified by:

createConnectHarness in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createStream

public CreateStreamResponse createStream(CreateStreamRequest request)

Description copied from interface: 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.

Specified by:

createStream in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createStreamPool

public CreateStreamPoolResponse createStreamPool(CreateStreamPoolRequest request)

Description copied from interface: 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.

Specified by:

createStreamPool in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteConnectHarness

public DeleteConnectHarnessResponse deleteConnectHarness(DeleteConnectHarnessRequest request)

Description copied from interface: 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.

Specified by:

deleteConnectHarness in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteStream

public DeleteStreamResponse deleteStream(DeleteStreamRequest request)

Description copied from interface: 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.

Specified by:

deleteStream in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteStreamPool

public DeleteStreamPoolResponse deleteStreamPool(DeleteStreamPoolRequest request)

Description copied from interface: StreamAdmin

Deletes a stream pool. All containing streams will also be deleted. The default stream pool of a compartment cannot be deleted.

Specified by:

deleteStreamPool in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getConnectHarness

public GetConnectHarnessResponse getConnectHarness(GetConnectHarnessRequest request)

Description copied from interface: StreamAdmin

Gets detailed information about a connect harness.

Specified by:

getConnectHarness in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getStream

public GetStreamResponse getStream(GetStreamRequest request)

Description copied from interface: StreamAdmin

Gets detailed information about a stream, including the number of partitions.

Specified by:

getStream in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getStreamPool

public GetStreamPoolResponse getStreamPool(GetStreamPoolRequest request)

Description copied from interface: StreamAdmin

Gets detailed information about the stream pool, such as Kafka settings.

Specified by:

getStreamPool in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listConnectHarnesses

public ListConnectHarnessesResponse listConnectHarnesses(ListConnectHarnessesRequest request)

Description copied from interface: StreamAdmin

Lists the connectharness.

Specified by:

listConnectHarnesses in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listStreamPools

public ListStreamPoolsResponse listStreamPools(ListStreamPoolsRequest request)

Description copied from interface: StreamAdmin

List the stream pools for a given compartment ID.

Specified by:

listStreamPools in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listStreams

public ListStreamsResponse listStreams(ListStreamsRequest request)

Description copied from interface: 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.

Specified by:

listStreams in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateConnectHarness

public UpdateConnectHarnessResponse updateConnectHarness(UpdateConnectHarnessRequest request)

Description copied from interface: StreamAdmin

Updates the tags applied to the connect harness.

Specified by:

updateConnectHarness in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateStream

public UpdateStreamResponse updateStream(UpdateStreamRequest request)

Description copied from interface: StreamAdmin

Updates the stream. Only specified values will be updated.

Specified by:

updateStream in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateStreamPool

public UpdateStreamPoolResponse updateStreamPool(UpdateStreamPoolRequest request)

Description copied from interface: StreamAdmin

Updates the specified stream pool.

Specified by:

updateStreamPool in interface StreamAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public StreamAdminWaiters getWaiters()

Description copied from interface: StreamAdmin

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface StreamAdmin

Returns:

The service waiters.

getPaginators

public StreamAdminPaginators getPaginators()

Description copied from interface: 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.

Specified by:

getPaginators in interface StreamAdmin

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

setEndpoint

public final void setEndpoint(String arg0)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

close

public final void close()

Specified by:

close in interface AutoCloseable