com.databricks.sdk.service.billing

Class LogDeliveryAPI

java.lang.Object

com.databricks.sdk.service.billing.LogDeliveryAPI

@Generated
public class LogDeliveryAPI
extends Object

These APIs manage Log delivery configurations for this account. Log delivery configs enable you to configure the delivery of the specified type of logs to your storage account.

Constructor Summary

Constructors

Constructor and Description
LogDeliveryAPI(ApiClient apiClient) Regular-use constructor
LogDeliveryAPI(LogDeliveryService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
WrappedLogDeliveryConfiguration	create(CreateLogDeliveryConfigurationParams logDeliveryConfiguration)
WrappedLogDeliveryConfiguration	create(WrappedCreateLogDeliveryConfiguration request) Create a new log delivery configuration.
GetLogDeliveryConfigurationResponse	get(GetLogDeliveryRequest request) Get log delivery configuration.
GetLogDeliveryConfigurationResponse	get(String logDeliveryConfigurationId)
LogDeliveryService	impl()
Iterable<LogDeliveryConfiguration>	list(ListLogDeliveryRequest request) Get all log delivery configurations.
void	patchStatus(String logDeliveryConfigurationId, LogDeliveryConfigStatus status)
void	patchStatus(UpdateLogDeliveryConfigurationStatusRequest request) Enable or disable log delivery configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogDeliveryAPI

public LogDeliveryAPI(ApiClient apiClient)

Regular-use constructor

LogDeliveryAPI

public LogDeliveryAPI(LogDeliveryService mock)

Constructor for mocks

Method Detail

create

public WrappedLogDeliveryConfiguration create(CreateLogDeliveryConfigurationParams logDeliveryConfiguration)

create

public WrappedLogDeliveryConfiguration create(WrappedCreateLogDeliveryConfiguration request)

Create a new log delivery configuration.

Creates a new Databricks log delivery configuration to enable delivery of the specified type of logs to your storage location. This requires that you already created a [credential object](:method:Credentials/Create) (which encapsulates a cross-account service IAM role) and a [storage configuration object](:method:Storage/Create) (which encapsulates an S3 bucket).

For full details, including the required IAM role policies and bucket policies, see [Deliver and access billable usage logs] or [Configure audit logging].

**Note**: There is a limit on the number of log delivery configurations available per account (each limit applies separately to each log type including billable usage and audit logs). You can create a maximum of two enabled account-level delivery configurations (configurations without a workspace filter) per type. Additionally, you can create two enabled workspace-level delivery configurations per workspace for each log type, which means that the same workspace ID can occur in the workspace filter for no more than two delivery configurations per log type.

You cannot delete a log delivery configuration, but you can disable it (see [Enable or disable log delivery configuration](:method:LogDelivery/PatchStatus)).

[Configure audit logging]: https://docs.databricks.com/administration-guide/account-settings/audit-logs.html [Deliver and access billable usage logs]: https://docs.databricks.com/administration-guide/account-settings/billable-usage-delivery.html

get

public GetLogDeliveryConfigurationResponse get(String logDeliveryConfigurationId)

get

public GetLogDeliveryConfigurationResponse get(GetLogDeliveryRequest request)

Get log delivery configuration.

Gets a Databricks log delivery configuration object for an account, both specified by ID.

list

public Iterable<LogDeliveryConfiguration> list(ListLogDeliveryRequest request)

Get all log delivery configurations.

Gets all Databricks log delivery configurations associated with an account specified by ID.

patchStatus

public void patchStatus(String logDeliveryConfigurationId,
                        LogDeliveryConfigStatus status)

patchStatus

public void patchStatus(UpdateLogDeliveryConfigurationStatusRequest request)

Enable or disable log delivery configuration.

Enables or disables a log delivery configuration. Deletion of delivery configurations is not supported, so disable log delivery configurations that are no longer needed. Note that you can't re-enable a delivery configuration if this would violate the delivery configuration limits described under [Create log delivery](:method:LogDelivery/Create).

impl

public LogDeliveryService impl()