Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StreamAdminClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • StreamAdminClient

Constructors

constructor

  • new StreamAdminClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): StreamAdminClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "StreamAdmin"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://streaming.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

changeConnectHarnessCompartment

  • Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeConnectHarnessCompartment API.

    Parameters

    Returns Promise<ChangeConnectHarnessCompartmentResponse>

    ChangeConnectHarnessCompartmentResponse

changeStreamCompartment

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeStreamCompartment API.

    Parameters

    Returns Promise<ChangeStreamCompartmentResponse>

    ChangeStreamCompartmentResponse

changeStreamPoolCompartment

  • Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeStreamPoolCompartment API.

    Parameters

    Returns Promise<ChangeStreamPoolCompartmentResponse>

    ChangeStreamPoolCompartmentResponse

close

  • close(): void

createConnectHarness

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateConnectHarness API.

    Parameters

    Returns Promise<CreateConnectHarnessResponse>

    CreateConnectHarnessResponse

createStream

  • 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 {@link #getStream(GetStreamRequest) getStream}. In the response, the lifecycleState parameter of the Stream object tells you its current state.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateStream API.

    Parameters

    Returns Promise<CreateStreamResponse>

    CreateStreamResponse

createStreamPool

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateStreamPool API.

    Parameters

    Returns Promise<CreateStreamPoolResponse>

    CreateStreamPoolResponse

createWaiters

  • Creates a new StreamAdminWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns StreamAdminWaiter

    The service waiters.

deleteConnectHarness

  • 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 {@link #getConnectHarness(GetConnectHarnessRequest) 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteConnectHarness API.

    Parameters

    Returns Promise<DeleteConnectHarnessResponse>

    DeleteConnectHarnessResponse

deleteStream

  • 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 {@link #getStream(GetStreamRequest) 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteStream API.

    Parameters

    Returns Promise<DeleteStreamResponse>

    DeleteStreamResponse

deleteStreamPool

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteStreamPool API.

    Parameters

    Returns Promise<DeleteStreamPoolResponse>

    DeleteStreamPoolResponse

getConnectHarness

  • Gets detailed information about a connect harness. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetConnectHarness API.

    Parameters

    Returns Promise<GetConnectHarnessResponse>

    GetConnectHarnessResponse

getStream

  • Gets detailed information about a stream, including the number of partitions. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetStream API.

    Parameters

    Returns Promise<GetStreamResponse>

    GetStreamResponse

getStreamPool

  • Gets detailed information about the stream pool, such as Kafka settings. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetStreamPool API.

    Parameters

    Returns Promise<GetStreamPoolResponse>

    GetStreamPoolResponse

getWaiters

listAllConnectHarnesses

  • NOTE: This function is deprecated in favor of listConnectHarnessesRecordIterator function. Creates a new async iterator which will iterate over the models.ConnectHarnessSummary objects contained in responses from the listConnectHarnesses operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ConnectHarnessSummary>

listAllConnectHarnessesResponses

  • NOTE: This function is deprecated in favor of listConnectHarnessesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listConnectHarnesses operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListConnectHarnessesResponse>

listAllStreamPools

  • NOTE: This function is deprecated in favor of listStreamPoolsRecordIterator function. Creates a new async iterator which will iterate over the models.StreamPoolSummary objects contained in responses from the listStreamPools operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<StreamPoolSummary>

listAllStreamPoolsResponses

  • NOTE: This function is deprecated in favor of listStreamPoolsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listStreamPools operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListStreamPoolsResponse>

listAllStreams

  • NOTE: This function is deprecated in favor of listStreamsRecordIterator function. Creates a new async iterator which will iterate over the models.StreamSummary objects contained in responses from the listStreams operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<StreamSummary>

listAllStreamsResponses

  • NOTE: This function is deprecated in favor of listStreamsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listStreams operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListStreamsResponse>

listConnectHarnesses

listConnectHarnessesRecordIterator

  • Creates a new async iterator which will iterate over the models.ConnectHarnessSummary objects contained in responses from the listConnectHarnesses operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ConnectHarnessSummary>

listConnectHarnessesResponseIterator

listStreamPools

  • List the stream pools for a given compartment ID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListStreamPools API.

    Parameters

    Returns Promise<ListStreamPoolsResponse>

    ListStreamPoolsResponse

listStreamPoolsRecordIterator

  • Creates a new async iterator which will iterate over the models.StreamPoolSummary objects contained in responses from the listStreamPools operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<StreamPoolSummary>

listStreamPoolsResponseIterator

listStreams

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListStreams API.

    Parameters

    Returns Promise<ListStreamsResponse>

    ListStreamsResponse

listStreamsRecordIterator

  • Creates a new async iterator which will iterate over the models.StreamSummary objects contained in responses from the listStreams operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<StreamSummary>

listStreamsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listStreams operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListStreamsResponse>

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateConnectHarness

  • Updates the tags applied to the connect harness.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateConnectHarness API.

    Parameters

    Returns Promise<UpdateConnectHarnessResponse>

    UpdateConnectHarnessResponse

updateStream

  • Updates the stream. Only specified values will be updated.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateStream API.

    Parameters

    Returns Promise<UpdateStreamResponse>

    UpdateStreamResponse

updateStreamPool

  • Updates the specified stream pool.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateStreamPool API.

    Parameters

    Returns Promise<UpdateStreamPoolResponse>

    UpdateStreamPoolResponse