Package com.okta.sdk.resource.api

Class LogStreamApi

java.lang.Object
com.okta.sdk.resource.api.LogStreamApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]", comments="Generator version: 7.15.0") public class LogStreamApi extends Object

  • Constructor Details

    • LogStreamApi

      public LogStreamApi()

    • LogStreamApi

      public LogStreamApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • activateLogStream

      public LogStream activateLogStream(String logStreamId) throws ApiException
      Activate a log stream Activates a log stream by `logStreamId`
      Parameters:
      logStreamId - Unique identifier for the log stream (required)
      Returns:
      LogStream
      Throws:
      ApiException - if fails to make API call

    • activateLogStream

      public LogStream activateLogStream(String logStreamId, Map<String,String> additionalHeaders) throws ApiException
      Activate a log stream Activates a log stream by `logStreamId`
      Parameters:
      logStreamId - Unique identifier for the log stream (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      LogStream
      Throws:
      ApiException - if fails to make API call

    • createLogStream

      public LogStream createLogStream(LogStream instance) throws ApiException
      Create a log stream Creates a new log stream object
      Parameters:
      instance - (required)
      Returns:
      LogStream
      Throws:
      ApiException - if fails to make API call

    • createLogStream

      public LogStream createLogStream(LogStream instance, Map<String,String> additionalHeaders) throws ApiException
      Create a log stream Creates a new log stream object
      Parameters:
      instance - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      LogStream
      Throws:
      ApiException - if fails to make API call

    • deactivateLogStream

      public LogStream deactivateLogStream(String logStreamId) throws ApiException
      Deactivate a log stream Deactivates a log stream by `logStreamId`
      Parameters:
      logStreamId - Unique identifier for the log stream (required)
      Returns:
      LogStream
      Throws:
      ApiException - if fails to make API call

    • deactivateLogStream

      public LogStream deactivateLogStream(String logStreamId, Map<String,String> additionalHeaders) throws ApiException
      Deactivate a log stream Deactivates a log stream by `logStreamId`
      Parameters:
      logStreamId - Unique identifier for the log stream (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      LogStream
      Throws:
      ApiException - if fails to make API call

    • deleteLogStream

      public void deleteLogStream(String logStreamId) throws ApiException
      Delete a log stream Deletes a log stream object from your org by ID
      Parameters:
      logStreamId - Unique identifier for the log stream (required)
      Throws:
      ApiException - if fails to make API call

    • deleteLogStream

      public void deleteLogStream(String logStreamId, Map<String,String> additionalHeaders) throws ApiException
      Delete a log stream Deletes a log stream object from your org by ID
      Parameters:
      logStreamId - Unique identifier for the log stream (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getLogStream

      public LogStream getLogStream(String logStreamId) throws ApiException
      Retrieve a log stream Retrieves a log stream object by ID
      Parameters:
      logStreamId - Unique identifier for the log stream (required)
      Returns:
      LogStream
      Throws:
      ApiException - if fails to make API call

    • getLogStream

      public LogStream getLogStream(String logStreamId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a log stream Retrieves a log stream object by ID
      Parameters:
      logStreamId - Unique identifier for the log stream (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      LogStream
      Throws:
      ApiException - if fails to make API call

    • listLogStreams

      public List<LogStream> listLogStreams(String after, Integer limit, String filter) throws ApiException
      List all log streams Lists all log stream objects in your org. You can request a paginated list or a subset of log streams that match a supported filter expression.
      Parameters:
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      filter - An expression that [filters](/#filter) the returned objects. You can only use the `eq` operator on either the `status` or `type` properties in the filter expression. (optional)
      Returns:
      List<LogStream>
      Throws:
      ApiException - if fails to make API call

    • listLogStreams

      public List<LogStream> listLogStreams(String after, Integer limit, String filter, Map<String,String> additionalHeaders) throws ApiException
      List all log streams Lists all log stream objects in your org. You can request a paginated list or a subset of log streams that match a supported filter expression.
      Parameters:
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      filter - An expression that [filters](/#filter) the returned objects. You can only use the `eq` operator on either the `status` or `type` properties in the filter expression. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<LogStream>
      Throws:
      ApiException - if fails to make API call

    • listLogStreamsPaged

      public Iterable<LogStream> listLogStreamsPaged(String after, Integer limit, String filter)
      List all log streams (Paginated) Lists all log stream objects in your org. You can request a paginated list or a subset of log streams that match a supported filter expression. This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.
      Parameters:
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      filter - An expression that [filters](/#filter) the returned objects. You can only use the `eq` operator on either the `status` or `type` properties in the filter expression. (optional)
      Returns:
      Iterable<LogStream> lazy iterable over all pages

    • listLogStreamsPaged

      public Iterable<LogStream> listLogStreamsPaged(String after, Integer limit, String filter, Map<String,String> additionalHeaders)
      List all log streams (Paginated with additional headers) Lists all log stream objects in your org. You can request a paginated list or a subset of log streams that match a supported filter expression. This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      filter - An expression that [filters](/#filter) the returned objects. You can only use the `eq` operator on either the `status` or `type` properties in the filter expression. (optional)
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<LogStream> lazy iterable over all pages

    • replaceLogStream

      public LogStream replaceLogStream(String logStreamId, LogStreamPutSchema instance) throws ApiException
      Replace a log stream Replaces the log stream object properties for a given ID. This operation is typically used to update the configuration of a log stream. Depending on the type of log stream you want to update, certain properties can't be modified after the log stream is initially created. Use the [Retrieve the log stream schema for the schema type](/openapi/okta-management/management/tag/Schema/#tag/Schema/operation/getLogStreamSchema) request to determine which properties you can update for the specific log stream type. Log stream properties with the `\"writeOnce\" : true` attribute can't be updated after creation. You must still specify these `writeOnce` properties in the request body with the original values in the PUT request. > **Note:** You don't have to specify properties that have both the `\"writeOnce\": true` and the `\"writeOnly\": true` attributes in the PUT request body. These property values are ignored even if you add them in the PUT request body.
      Parameters:
      logStreamId - Unique identifier for the log stream (required)
      instance - (required)
      Returns:
      LogStream
      Throws:
      ApiException - if fails to make API call

    • replaceLogStream

      public LogStream replaceLogStream(String logStreamId, LogStreamPutSchema instance, Map<String,String> additionalHeaders) throws ApiException
      Replace a log stream Replaces the log stream object properties for a given ID. This operation is typically used to update the configuration of a log stream. Depending on the type of log stream you want to update, certain properties can't be modified after the log stream is initially created. Use the [Retrieve the log stream schema for the schema type](/openapi/okta-management/management/tag/Schema/#tag/Schema/operation/getLogStreamSchema) request to determine which properties you can update for the specific log stream type. Log stream properties with the `\"writeOnce\" : true` attribute can't be updated after creation. You must still specify these `writeOnce` properties in the request body with the original values in the PUT request. > **Note:** You don't have to specify properties that have both the `\"writeOnce\": true` and the `\"writeOnly\": true` attributes in the PUT request body. These property values are ignored even if you add them in the PUT request body.
      Parameters:
      logStreamId - Unique identifier for the log stream (required)
      instance - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      LogStream
      Throws:
      ApiException - if fails to make API call

    • getObjectMapper

      protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()