Package io.github.primelib.confluence4j.rest.v1.spec

Klasse DeleteRelationshipOperationSpec

java.lang.Object
io.github.primelib.confluence4j.rest.v1.spec.DeleteRelationshipOperationSpec
@Generated("io.github.primelib.primecodegen.javafeign.JavaFeignGenerator") public class DeleteRelationshipOperationSpec extends Object
DeleteRelationshipSpec

Specification for the DeleteRelationship operation.

Delete relationship

  • Felddetails

    • VALIDATION_ENABLED

      @Experimental public static Boolean VALIDATION_ENABLED
      allows to disable validation of the spec, use with care!

  • Konstruktordetails

    • DeleteRelationshipOperationSpec

      @Internal public DeleteRelationshipOperationSpec(Consumer<DeleteRelationshipOperationSpec> spec)
      Constructs a validated instance of DeleteRelationshipOperationSpec.
      Parameter:
      spec - the specification to process

    • DeleteRelationshipOperationSpec

      @Internal public DeleteRelationshipOperationSpec(String relationName, String sourceType, String sourceKey, String targetType, String targetKey, String sourceStatus, String targetStatus, Integer sourceVersion, Integer targetVersion)
      Constructs a validated instance of DeleteRelationshipOperationSpec.

      NOTE: This constructor is not considered stable and may change if the operation is updated.

      Parameter:
      relationName - The name of the relationship.
      sourceType - The source entity type of the relationship. This must be 'user', if the relationName is 'favourite'.
      sourceKey - - The identifier for the source entity: - If sourceType is 'user', then specify either 'current' (logged-in user) or the user key. - If sourceType is 'content', then specify the content ID. - If sourceType is 'space', then specify the space key.
      targetType - The target entity type of the relationship. This must be 'space' or 'content', if the relationName is 'favourite'.
      targetKey - - The identifier for the target entity: - If sourceType is 'user', then specify either 'current' (logged-in user) or the user key. - If sourceType is 'content', then specify the content ID. - If sourceType is 'space', then specify the space key.
      sourceStatus - The status of the source. This parameter is only used when the sourceType is 'content'.
      targetStatus - The status of the target. This parameter is only used when the targetType is 'content'.
      sourceVersion - The version of the source. This parameter is only used when the sourceType is 'content' and the sourceStatus is 'historical'.
      targetVersion - The version of the target. This parameter is only used when the targetType is 'content' and the targetStatus is 'historical'.

    • DeleteRelationshipOperationSpec

      protected DeleteRelationshipOperationSpec()

  • Methodendetails

    • validate

      public void validate()
      Validates the Spec, will throw a exception if required parameters are missing
      Löst aus:
      NullPointerException

    • builder

      public static DeleteRelationshipOperationSpec.DeleteRelationshipOperationSpecBuilder builder()

    • relationName

      @NotNull public @NotNull String relationName()
      The name of the relationship.

    • sourceType

      @NotNull public @NotNull String sourceType()
      The source entity type of the relationship. This must be 'user', if the relationName is 'favourite'.

    • sourceKey

      @NotNull public @NotNull String sourceKey()
      - The identifier for the source entity: - If sourceType is 'user', then specify either 'current' (logged-in user) or the user key. - If sourceType is 'content', then specify the content ID. - If sourceType is 'space', then specify the space key.

    • targetType

      @NotNull public @NotNull String targetType()
      The target entity type of the relationship. This must be 'space' or 'content', if the relationName is 'favourite'.

    • targetKey

      @NotNull public @NotNull String targetKey()
      - The identifier for the target entity: - If sourceType is 'user', then specify either 'current' (logged-in user) or the user key. - If sourceType is 'content', then specify the content ID. - If sourceType is 'space', then specify the space key.

    • sourceStatus

      @Nullable public @Nullable String sourceStatus()
      The status of the source. This parameter is only used when the sourceType is 'content'.

    • targetStatus

      @Nullable public @Nullable String targetStatus()
      The status of the target. This parameter is only used when the targetType is 'content'.

    • sourceVersion

      @Nullable public @Nullable Integer sourceVersion()
      The version of the source. This parameter is only used when the sourceType is 'content' and the sourceStatus is 'historical'.

    • targetVersion

      @Nullable public @Nullable Integer targetVersion()
      The version of the target. This parameter is only used when the targetType is 'content' and the targetStatus is 'historical'.

    • relationName

      public DeleteRelationshipOperationSpec relationName(@NotNull @NotNull String relationName)
      The name of the relationship.
      Gibt zurück:
      this.

    • sourceType

      public DeleteRelationshipOperationSpec sourceType(@NotNull @NotNull String sourceType)
      The source entity type of the relationship. This must be 'user', if the relationName is 'favourite'.
      Gibt zurück:
      this.

    • sourceKey

      public DeleteRelationshipOperationSpec sourceKey(@NotNull @NotNull String sourceKey)
      - The identifier for the source entity: - If sourceType is 'user', then specify either 'current' (logged-in user) or the user key. - If sourceType is 'content', then specify the content ID. - If sourceType is 'space', then specify the space key.
      Gibt zurück:
      this.

    • targetType

      public DeleteRelationshipOperationSpec targetType(@NotNull @NotNull String targetType)
      The target entity type of the relationship. This must be 'space' or 'content', if the relationName is 'favourite'.
      Gibt zurück:
      this.

    • targetKey

      public DeleteRelationshipOperationSpec targetKey(@NotNull @NotNull String targetKey)
      - The identifier for the target entity: - If sourceType is 'user', then specify either 'current' (logged-in user) or the user key. - If sourceType is 'content', then specify the content ID. - If sourceType is 'space', then specify the space key.
      Gibt zurück:
      this.

    • sourceStatus

      public DeleteRelationshipOperationSpec sourceStatus(@Nullable @Nullable String sourceStatus)
      The status of the source. This parameter is only used when the sourceType is 'content'.
      Gibt zurück:
      this.

    • targetStatus

      public DeleteRelationshipOperationSpec targetStatus(@Nullable @Nullable String targetStatus)
      The status of the target. This parameter is only used when the targetType is 'content'.
      Gibt zurück:
      this.

    • sourceVersion

      public DeleteRelationshipOperationSpec sourceVersion(@Nullable @Nullable Integer sourceVersion)
      The version of the source. This parameter is only used when the sourceType is 'content' and the sourceStatus is 'historical'.
      Gibt zurück:
      this.

    • targetVersion

      public DeleteRelationshipOperationSpec targetVersion(@Nullable @Nullable Integer targetVersion)
      The version of the target. This parameter is only used when the targetType is 'content' and the targetStatus is 'historical'.
      Gibt zurück:
      this.

    • equals

      public boolean equals(Object o)
      Setzt außer Kraft:
      equals in Klasse Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Setzt außer Kraft:
      hashCode in Klasse Object

    • toString

      public String toString()
      Setzt außer Kraft:
      toString in Klasse Object