org.projectnessie.events.api.Content Maven / Gradle / Ivy
/*
* Copyright (C) 2023 Dremio
*
* Licensed 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.projectnessie.events.api;
import java.util.Collections;
import java.util.Map;
import org.immutables.value.Value;
/** An object stored in Nessie, such as a table or a view. */
@Value.Immutable
public interface Content {
/**
* Returns the type for this object.
*
* Values returned here match the JSON type name used for serializing the original content
* object.
*
*
The currently-known built-in content types are:
*
*
* - {@code ICEBERG_TABLE};
*
- {@code ICEBERG_VIEW};
*
- {@code NAMESPACE};
*
- {@code UDF};
*
- {@code DELTA_LAKE_TABLE}.
*
*
* Other content types may be added in the future, or registered by end users.
*/
String getType();
/**
* Unique id for this object.
*
* This id is unique for the entire lifetime of this Content object and persists across
* renames. Two content objects with the same key will have different ids.
*
*
Content ids are usually UUIDs, but this is not enforced currently in Nessie's model API.
*/
String getId();
/** A map of attributes that can be used to add additional information to the content object. */
@Value.Default
default Map getProperties() {
return Collections.emptyMap();
}
}