/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.polaris.service.events;

import java.time.Instant;
import java.util.Map;
import java.util.Optional;
import java.util.UUID;
import org.apache.polaris.core.auth.PolarisPrincipal;
import org.apache.polaris.immutables.PolarisImmutable;
import org.immutables.value.Value;

/** Metadata associated with a Polaris event. */
@PolarisImmutable
public interface PolarisEventMetadata {

  static ImmutablePolarisEventMetadata.Builder builder() {
    return ImmutablePolarisEventMetadata.builder();
  }

  /** The unique ID of the event. */
  default UUID eventId() {
    return UUID.randomUUID();
  }

  /** The timestamp when the event was emitted. */
  @Value.Default
  default Instant timestamp() {
    return Instant.now();
  }

  /** The realm in which the event was emitted. */
  String realmId();

  /** The user who triggered the event. */
  Optional<PolarisPrincipal> user();

  /** The request ID associated with the event, if any. */
  Optional<String> requestId();

  /** The OpenTelemetry context associated with the event, if any. */
  Map<String, String> openTelemetryContext();
}
