kalix.javasdk.annotations.GenerateId Maven / Gradle / Ivy
/*
* Copyright 2021 Lightbend Inc.
*
* 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 kalix.javasdk.annotations;
import java.lang.annotation.*;
/**
* Indicates that Kalix should generate an id when this method is invoked.
* The generated id is accessible via the entity/workflow context supplied in the SDK.
* A method annotated with this annotation should not be annotated with {@link Id},
* if it does, an error will be raised.
*
* The generated key will be a Version 4 (random) UUID. The UUID will be generated using a cryptographically secure
* random number generator.
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface GenerateId {
Type value() default Type.VERSION_4_UUID;
enum Type {
/**
* Generate a Version 4 (random) UUID. The UUID will be generated using a cryptographically secure random
* number generator.
*/
VERSION_4_UUID
}
}