Package com.cloudera.cdp.audit.api

Class AuditClient

java.lang.Object

com.cloudera.cdp.client.CdpClient

com.cloudera.cdp.audit.api.AuditClient

@Generated(value="com.cloudera.cdp.client.codegen.CdpSDKJavaCodegen",
           date="2024-09-27T08:40:27.499-07:00")
public class AuditClient
extends CdpClient

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_NAME

Fields inherited from class com.cloudera.cdp.client.CdpClient

NO_EXTENSION

Constructor Summary

Constructors

Constructor	Description
AuditClient(CdpCredentials credentials, String endPoint, CdpClientConfiguration clientConfiguration)
AuditClient(CdpRequestContext<?> context)

Method Summary

Modifier and Type	Method	Description
ArchiveAuditEventsResponse	archiveAuditEvents(ArchiveAuditEventsRequest input)	Archive audit events.
BatchEventsForArchivingResponse	batchEventsForArchiving(BatchEventsForArchivingRequest input)	Create batches of audit events to be archived.
ConfigureArchivingResponse	configureArchiving(ConfigureArchivingRequest input)	Configures the audit system for archiving audit events to external cloud storage.
GetArchivingConfigResponse	getArchivingConfig(GetArchivingConfigRequest input)	Retrieve the current archiving configuration.
GetArchivingStatusResponse	getArchivingStatus(GetArchivingStatusRequest input)	Retrieve the status for an archive process.
GetBatchEventsForArchivingStatusResponse	getBatchEventsForArchivingStatus(GetBatchEventsForArchivingStatusRequest input)	Get the status of creating batches of audit events to be archived.
protected String	getRequestContentType()	Gets the request Content-Type, used by 'Conent-Type' request header.
protected String	getResponseContentType()	Gets the expected response Content-Type, used by 'Accept' request header.
protected String	getServiceName()	Gets the service name.
ListEventsResponse	listEvents(ListEventsRequest input)	List all audit events recorded in a specified time span, and optionally with a specified request ID and/or event source.
ListEventsInArchiveBatchResponse	listEventsInArchiveBatch(ListEventsInArchiveBatchRequest input)	List events contained in a single archive batch.
ListOutstandingArchiveBatchesResponse	listOutstandingArchiveBatches(ListOutstandingArchiveBatchesRequest input)	List outstanding (unarchived) archive batches.
ListRecentArchiveRunsResponse	listRecentArchiveRuns(ListRecentArchiveRunsRequest input)	List recent archive runs.
MarkArchiveBatchesAsSuccessfulResponse	markArchiveBatchesAsSuccessful(MarkArchiveBatchesAsSuccessfulRequest input)	Mark archive batches as successful.

Methods inherited from class com.cloudera.cdp.client.CdpClient

invokeAPI, invokeAPI, invokeAPI, invokeAPI, parameterToPair, parameterToPairs, parameterToString, shutdown

Methods inherited from class java.lang.Object

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

Field Details

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

• Constant Field Values

Constructor Details

AuditClient

public AuditClient(CdpCredentials credentials,
 String endPoint,
 CdpClientConfiguration clientConfiguration)

AuditClient

public AuditClient(CdpRequestContext<?> context)

Method Details

getServiceName

protected String getServiceName()

Description copied from class: CdpClient

Gets the service name.

Specified by:

getServiceName in class CdpClient

Returns:

the service name

getRequestContentType

protected String getRequestContentType()

Description copied from class: CdpClient

Gets the request Content-Type, used by 'Conent-Type' request header.

Overrides:

getRequestContentType in class CdpClient

Returns:

the request Content-Type

getResponseContentType

protected String getResponseContentType()

Description copied from class: CdpClient

Gets the expected response Content-Type, used by 'Accept' request header.

Overrides:

getResponseContentType in class CdpClient

Returns:

the response Content-Type

archiveAuditEvents

public ArchiveAuditEventsResponse archiveAuditEvents(ArchiveAuditEventsRequest input)

Archive audit events.

Parameters:

input -

Returns:

ArchiveAuditEventsResponse

batchEventsForArchiving

public BatchEventsForArchivingResponse batchEventsForArchiving(BatchEventsForArchivingRequest input)

Create batches of audit events to be archived.

Parameters:

input -

Returns:

BatchEventsForArchivingResponse

configureArchiving

public ConfigureArchivingResponse configureArchiving(ConfigureArchivingRequest input)

Configures the audit system for archiving audit events to external cloud storage.

Parameters:

input -

Returns:

ConfigureArchivingResponse

getArchivingConfig

public GetArchivingConfigResponse getArchivingConfig(GetArchivingConfigRequest input)

Retrieve the current archiving configuration.

Parameters:

input -

Returns:

GetArchivingConfigResponse

getArchivingStatus

public GetArchivingStatusResponse getArchivingStatus(GetArchivingStatusRequest input)

Retrieve the status for an archive process.

Parameters:

input -

Returns:

GetArchivingStatusResponse

getBatchEventsForArchivingStatus

public GetBatchEventsForArchivingStatusResponse getBatchEventsForArchivingStatus(GetBatchEventsForArchivingStatusRequest input)

Get the status of creating batches of audit events to be archived.

Parameters:

input -

Returns:

GetBatchEventsForArchivingStatusResponse

listEvents

public ListEventsResponse listEvents(ListEventsRequest input)

List all audit events recorded in a specified time span, and optionally with a specified request ID and/or event source.

Parameters:

input -

Returns:

ListEventsResponse

listEventsInArchiveBatch

public ListEventsInArchiveBatchResponse listEventsInArchiveBatch(ListEventsInArchiveBatchRequest input)

List events contained in a single archive batch.

Parameters:

input -

Returns:

ListEventsInArchiveBatchResponse

listOutstandingArchiveBatches

public ListOutstandingArchiveBatchesResponse listOutstandingArchiveBatches(ListOutstandingArchiveBatchesRequest input)

List outstanding (unarchived) archive batches.

Parameters:

input -

Returns:

ListOutstandingArchiveBatchesResponse

listRecentArchiveRuns

public ListRecentArchiveRunsResponse listRecentArchiveRuns(ListRecentArchiveRunsRequest input)

List recent archive runs.

Parameters:

input -

Returns:

ListRecentArchiveRunsResponse

markArchiveBatchesAsSuccessful

public MarkArchiveBatchesAsSuccessfulResponse markArchiveBatchesAsSuccessful(MarkArchiveBatchesAsSuccessfulRequest input)

Mark archive batches as successful.

Parameters:

input -

Returns:

MarkArchiveBatchesAsSuccessfulResponse