org.openapitools.client.api

Class LogStreamApi

java.lang.Object

org.openapitools.client.api.LogStreamApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-07-14T17:07:26.321-05:00[America/Chicago]")
public class LogStreamApi
extends Object

Constructor Summary

Constructors

Constructor and Description
LogStreamApi()
LogStreamApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
LogStream	activateLogStream(String logStreamId) Activate a Log Stream Activates a log stream by `logStreamId`
LogStream	activateLogStream(String logStreamId, Map<String,String> additionalHeaders) Activate a Log Stream Activates a log stream by `logStreamId`
LogStream	createLogStream(LogStream instance) Create a Log Stream Creates a new Log Stream object
LogStream	createLogStream(LogStream instance, Map<String,String> additionalHeaders) Create a Log Stream Creates a new Log Stream object
LogStream	deactivateLogStream(String logStreamId) Deactivate a Log Stream Deactivates a log stream by `logStreamId`
LogStream	deactivateLogStream(String logStreamId, Map<String,String> additionalHeaders) Deactivate a Log Stream Deactivates a log stream by `logStreamId`
void	deleteLogStream(String logStreamId) Delete a Log Stream Deletes a Log Stream object from your org by ID
void	deleteLogStream(String logStreamId, Map<String,String> additionalHeaders) Delete a Log Stream Deletes a Log Stream object from your org by ID
ApiClient	getApiClient()
LogStream	getLogStream(String logStreamId) Retrieve a Log Stream Retrieves a Log Stream object by ID
LogStream	getLogStream(String logStreamId, Map<String,String> additionalHeaders) Retrieve a Log Stream Retrieves a Log Stream object by ID
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<LogStream>	listLogStreams(String after, Integer limit, String filter) List all Log Streams Lists all Log Stream objects in your org.
List<LogStream>	listLogStreams(String after, Integer limit, String filter, Map<String,String> additionalHeaders) List all Log Streams Lists all Log Stream objects in your org.
LogStream	replaceLogStream(String logStreamId, LogStreamPutSchema instance) Replace a Log Stream Replaces the Log Stream object properties for a given ID.
LogStream	replaceLogStream(String logStreamId, LogStreamPutSchema instance, Map<String,String> additionalHeaders) Replace a Log Stream Replaces the Log Stream object properties for a given ID.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LogStreamApi

public LogStreamApi()

LogStreamApi

public LogStreamApi(ApiClient apiClient)

Method Detail

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](/#pagination) for more information. (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](/#pagination) for more information. (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

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()