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 Description static classStreamAdminClient.BuilderBuilder class for this client.
-
Field Summary
Fields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for StreamAdmin.
-
Constructor Summary
Constructors Constructor Description StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StreamAdminClient.Builderbuilder()Create a builder for this client.ChangeConnectHarnessCompartmentResponsechangeConnectHarnessCompartment(ChangeConnectHarnessCompartmentRequest request)Moves a resource into a different compartment.ChangeStreamCompartmentResponsechangeStreamCompartment(ChangeStreamCompartmentRequest request)Moves a resource into a different compartment.ChangeStreamPoolCompartmentResponsechangeStreamPoolCompartment(ChangeStreamPoolCompartmentRequest request)Moves a resource into a different compartment.voidclose()CreateConnectHarnessResponsecreateConnectHarness(CreateConnectHarnessRequest request)Starts the provisioning of a new connect harness.CreateStreamResponsecreateStream(CreateStreamRequest request)Starts the provisioning of a new stream.CreateStreamPoolResponsecreateStreamPool(CreateStreamPoolRequest request)Starts the provisioning of a new stream pool.DeleteConnectHarnessResponsedeleteConnectHarness(DeleteConnectHarnessRequest request)Deletes a connect harness and its content.DeleteStreamResponsedeleteStream(DeleteStreamRequest request)Deletes a stream and its content.DeleteStreamPoolResponsedeleteStreamPool(DeleteStreamPoolRequest request)Deletes a stream pool.StringgetClientCommonLibraryVersion()GetConnectHarnessResponsegetConnectHarness(GetConnectHarnessRequest request)Gets detailed information about a connect harness.protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Optional<String>getMinimumClientCommonLibraryVersionFromClient()StreamAdminPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetStreamResponsegetStream(GetStreamRequest request)Gets detailed information about a stream, including the number of partitions.GetStreamPoolResponsegetStreamPool(GetStreamPoolRequest request)Gets detailed information about the stream pool, such as Kafka settings.StreamAdminWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListConnectHarnessesResponselistConnectHarnesses(ListConnectHarnessesRequest request)Lists the connectharness.ListStreamPoolsResponselistStreamPools(ListStreamPoolsRequest request)List the stream pools for a given compartment ID.ListStreamsResponselistStreams(ListStreamsRequest request)Lists the streams in the given compartment id.voidpopulateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)Populate the parameters in the endpoint with its corresponding value and update the base endpoint.voidrefreshClient()Rebuild the backingHttpClient.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).voidupdateBaseEndpoint(String endpoint)This method should be used for parameterized endpoint templates only.UpdateConnectHarnessResponseupdateConnectHarness(UpdateConnectHarnessRequest request)Updates the tags applied to the connect harness.UpdateStreamResponseupdateStream(UpdateStreamRequest request)Updates the stream.UpdateStreamPoolResponseupdateStreamPool(UpdateStreamPoolRequest request)Updates the specified stream pool.voiduseRealmSpecificEndpointTemplate(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 java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.streaming.StreamAdmin
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
StreamAdminClient
@Deprecated public StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeStreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
-
StreamAdminClient
@Deprecated public StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeStreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configuration
-
StreamAdminClient
@Deprecated public StreamAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeStreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
StreamAdminClient
@Deprecated public StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeStreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeStreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfigurators
-
StreamAdminClient
@Deprecated public StreamAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeStreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeStreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-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 thebuilderinstead.Create a new client instance.- Parameters:
authenticationDetailsProvider- The authentication details (seeStreamAdminClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))configuration-ClientBuilderBase.configurationclientConfigurator-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)defaultRequestSignerFactory-ClientBuilderBase.requestSignerFactoryadditionalClientConfigurators-ClientBuilderBase.additionalClientConfiguratorsendpoint-ClientBuilderBase.endpoint(java.lang.String)signingStrategyRequestSignerFactories-ClientBuilderBase.signingStrategyRequestSignerFactoriesexecutorService-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:StreamAdminSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call
setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.- Specified by:
setRegionin interfaceStreamAdmin- Parameters:
region- The region of the service.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:StreamAdminSets 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 callsetEndpoint.- Specified by:
setRegionin interfaceStreamAdmin- Parameters:
regionId- The public region ID.
-
changeConnectHarnessCompartment
public ChangeConnectHarnessCompartmentResponse changeConnectHarnessCompartment(ChangeConnectHarnessCompartmentRequest request)
Description copied from interface:StreamAdminMoves a resource into a different compartment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeConnectHarnessCompartmentin interfaceStreamAdmin- 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:StreamAdminMoves 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:
changeStreamCompartmentin interfaceStreamAdmin- 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:StreamAdminMoves a resource into a different compartment.When provided, If-Match is checked against ETag values of the resource.
- Specified by:
changeStreamPoolCompartmentin interfaceStreamAdmin- 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:StreamAdminStarts the provisioning of a new connect harness.To track the progress of the provisioning, you can periodically call
ConnectHarnessobject tells you its current state.- Specified by:
createConnectHarnessin interfaceStreamAdmin- 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:StreamAdminStarts 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, thelifecycleStateparameter of theStreamobject tells you its current state.- Specified by:
createStreamin interfaceStreamAdmin- 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:StreamAdminStarts the provisioning of a new stream pool.To track the progress of the provisioning, you can periodically call GetStreamPool. In the response, the
lifecycleStateparameter of the object tells you its current state.- Specified by:
createStreamPoolin interfaceStreamAdmin- 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:StreamAdminDeletes 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
lifecycleStateparameter of theConnectHarnessobject changes toDELETINGand the connect harness becomes inaccessible for read or write operations. To verify that a connect harness has been deleted, make agetConnectHarnessrequest. If the call returns the connect harness’s lifecycle state asDELETED, 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:
deleteConnectHarnessin interfaceStreamAdmin- 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:StreamAdminDeletes a stream and its content.Stream contents are deleted immediately. The service retains records of the stream itself for 90 days after deletion. The
lifecycleStateparameter of theStreamobject changes toDELETINGand the stream becomes inaccessible for read or write operations. To verify that a stream has been deleted, make agetStreamrequest. If the call returns the stream’s lifecycle state asDELETED, 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:
deleteStreamin interfaceStreamAdmin- 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:StreamAdminDeletes a stream pool.All containing streams will also be deleted. The default stream pool of a compartment cannot be deleted.
- Specified by:
deleteStreamPoolin interfaceStreamAdmin- 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:StreamAdminGets detailed information about a connect harness.- Specified by:
getConnectHarnessin interfaceStreamAdmin- 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:StreamAdminGets detailed information about a stream, including the number of partitions.- Specified by:
getStreamin interfaceStreamAdmin- 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:StreamAdminGets detailed information about the stream pool, such as Kafka settings.- Specified by:
getStreamPoolin interfaceStreamAdmin- 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:StreamAdminLists the connectharness.- Specified by:
listConnectHarnessesin interfaceStreamAdmin- 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:StreamAdminList the stream pools for a given compartment ID.- Specified by:
listStreamPoolsin interfaceStreamAdmin- 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:StreamAdminLists 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:
listStreamsin interfaceStreamAdmin- 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:StreamAdminUpdates the tags applied to the connect harness.- Specified by:
updateConnectHarnessin interfaceStreamAdmin- 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:StreamAdminUpdates the stream.Only specified values will be updated.
- Specified by:
updateStreamin interfaceStreamAdmin- 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:StreamAdminUpdates the specified stream pool.- Specified by:
updateStreamPoolin interfaceStreamAdmin- 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:StreamAdminGets the pre-configured waiters available for resources for this service.- Specified by:
getWaitersin interfaceStreamAdmin- Returns:
- The service waiters.
-
getPaginators
public StreamAdminPaginators getPaginators()
Description copied from interface:StreamAdminGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginatorsin interfaceStreamAdmin- Returns:
- The service paginators.
-
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 userequiredParametersMap- 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 backingHttpClient.This will call
ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
closein interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-