org.openapitools.client.api

Class LogStreamApi

java.lang.Object

org.openapitools.client.api.LogStreamApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T04:14:02.238-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.LogStreamApi")
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`
PagedList	activateLogStreamWithPaginationInfo(String logStreamId) Activate a Log Stream Activates a log stream by `logStreamId`
<T> T	createLogStream(Class<?> T, LogStream instance) Create a Log Stream Creates a new log stream
LogStream	createLogStream(LogStream instance) Create a Log Stream Creates a new log stream
PagedList	createLogStreamWithPaginationInfo(LogStream instance) Create a Log Stream Creates a new log stream
LogStream	deactivateLogStream(String logStreamId) Deactivate a Log Stream Deactivates a log stream by `logStreamId`
PagedList	deactivateLogStreamWithPaginationInfo(String logStreamId) Deactivate a Log Stream Deactivates a log stream by `logStreamId`
void	deleteLogStream(String logStreamId) Delete a Log Stream Deletes a log stream by `logStreamId`
ApiClient	getApiClient()
LogStream	getLogStream(String logStreamId) Retrieve a Log Stream Retrieves a log stream by `logStreamId`
PagedList	getLogStreamWithPaginationInfo(String logStreamId) Retrieve a Log Stream Retrieves a log stream by `logStreamId`
List<LogStream>	listLogStreams(String after, Integer limit, String filter) List all Log Streams Lists all log streams.
PagedList	listLogStreamsWithPaginationInfo(String after, Integer limit, String filter) List all Log Streams Lists all log streams.
<T> T	replaceLogStream(Class<?> T, String logStreamId, LogStream instance) Replace a Log Stream Replaces a log stream by `logStreamId`
LogStream	replaceLogStream(String logStreamId, LogStream instance) Replace a Log Stream Replaces a log stream by `logStreamId`
PagedList	replaceLogStreamWithPaginationInfo(String logStreamId, LogStream instance) Replace a Log Stream Replaces a log stream by `logStreamId`
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

@Autowired
public LogStreamApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activateLogStream

public LogStream activateLogStream(String logStreamId)
                            throws org.springframework.web.client.RestClientException

Activate a Log Stream Activates a log stream by `logStreamId`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

logStreamId - id of the log stream (required)

Returns:

LogStream

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

activateLogStreamWithPaginationInfo

public PagedList activateLogStreamWithPaginationInfo(String logStreamId)
                                              throws org.springframework.web.client.RestClientException

Activate a Log Stream Activates a log stream by `logStreamId`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

logStreamId - id of the log stream (required)

Returns:

ResponseEntity<LogStream>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createLogStream

public LogStream createLogStream(LogStream instance)
                          throws org.springframework.web.client.RestClientException

Create a Log Stream Creates a new log stream

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

instance - (required)

Returns:

LogStream

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createLogStream

public <T> T createLogStream(Class<?> T,
                             LogStream instance)
                      throws org.springframework.web.client.RestClientException

Create a Log Stream Creates a new log stream

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

instance - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createLogStreamWithPaginationInfo

public PagedList createLogStreamWithPaginationInfo(LogStream instance)
                                            throws org.springframework.web.client.RestClientException

Create a Log Stream Creates a new log stream

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

instance - (required)

Returns:

ResponseEntity<LogStream>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deactivateLogStream

public LogStream deactivateLogStream(String logStreamId)
                              throws org.springframework.web.client.RestClientException

Deactivate a Log Stream Deactivates a log stream by `logStreamId`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

logStreamId - id of the log stream (required)

Returns:

LogStream

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deactivateLogStreamWithPaginationInfo

public PagedList deactivateLogStreamWithPaginationInfo(String logStreamId)
                                                throws org.springframework.web.client.RestClientException

Deactivate a Log Stream Deactivates a log stream by `logStreamId`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

logStreamId - id of the log stream (required)

Returns:

ResponseEntity<LogStream>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteLogStream

public void deleteLogStream(String logStreamId)
                     throws org.springframework.web.client.RestClientException

Delete a Log Stream Deletes a log stream by `logStreamId`

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

logStreamId - id of the log stream (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getLogStream

public LogStream getLogStream(String logStreamId)
                       throws org.springframework.web.client.RestClientException

Retrieve a Log Stream Retrieves a log stream by `logStreamId`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

logStreamId - id of the log stream (required)

Returns:

LogStream

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getLogStreamWithPaginationInfo

public PagedList getLogStreamWithPaginationInfo(String logStreamId)
                                         throws org.springframework.web.client.RestClientException

Retrieve a Log Stream Retrieves a log stream by `logStreamId`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

logStreamId - id of the log stream (required)

Returns:

ResponseEntity<LogStream>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listLogStreams

public List<LogStream> listLogStreams(String after,
                                      Integer limit,
                                      String filter)
                               throws org.springframework.web.client.RestClientException

List all Log Streams Lists all log streams. You can request a paginated list or a subset of Log Streams that match a supported filter expression.

200 - OK

403 - Forbidden

429 - Too Many Requests

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 - SCIM filter expression that filters the results. This expression only supports the `eq` operator on either the `status` or `type`. (optional)

Returns:

List<LogStream>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listLogStreamsWithPaginationInfo

public PagedList listLogStreamsWithPaginationInfo(String after,
                                                  Integer limit,
                                                  String filter)
                                           throws org.springframework.web.client.RestClientException

List all Log Streams Lists all log streams. You can request a paginated list or a subset of Log Streams that match a supported filter expression.

200 - OK

403 - Forbidden

429 - Too Many Requests

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 - SCIM filter expression that filters the results. This expression only supports the `eq` operator on either the `status` or `type`. (optional)

Returns:

ResponseEntity<List<LogStream>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceLogStream

public LogStream replaceLogStream(String logStreamId,
                                  LogStream instance)
                           throws org.springframework.web.client.RestClientException

Replace a Log Stream Replaces a log stream by `logStreamId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

logStreamId - id of the log stream (required)

instance - (required)

Returns:

LogStream

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceLogStream

public <T> T replaceLogStream(Class<?> T,
                              String logStreamId,
                              LogStream instance)
                       throws org.springframework.web.client.RestClientException

Replace a Log Stream Replaces a log stream by `logStreamId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

logStreamId - id of the log stream (required)

instance - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceLogStreamWithPaginationInfo

public PagedList replaceLogStreamWithPaginationInfo(String logStreamId,
                                                    LogStream instance)
                                             throws org.springframework.web.client.RestClientException

Replace a Log Stream Replaces a log stream by `logStreamId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

logStreamId - id of the log stream (required)

instance - (required)

Returns:

ResponseEntity<LogStream>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API