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

Klasse FindSourcesForTargetOperationSpec

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

Specification for the FindSourcesForTarget operation.

Find source entities related to a target entity

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • FindSourcesForTargetOperationSpec

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

    • FindSourcesForTargetOperationSpec

      @Internal public FindSourcesForTargetOperationSpec(String relationName, String sourceType, String targetType, String targetKey, String sourceStatus, String targetStatus, Integer sourceVersion, Integer targetVersion, List<String> expand, Integer start, Integer limit)
      Constructs a validated instance of FindSourcesForTargetOperationSpec.

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

      Parameter:
      relationName - The name of the relationship. This method supports relationships created via [Create relationship](#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put). Note, this method does not support 'like' or 'favourite' relationships.
      sourceType - The source entity type of the relationship.
      targetType - The target entity type of the relationship.
      targetKey - The identifier for the target entity: - If targetType is user, then specify either current (logged-in user), the user key of the user, or the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - If targetType is 'content', then specify the content ID. - If targetType 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'.
      expand - A multi-value parameter indicating which properties of the response object to expand. - relationData returns information about the relationship, such as who created it and when it was created. - source returns the source entity. - target returns the target entity.
      start - The starting index of the returned relationships.
      limit - The maximum number of relationships to return per page. Note, this may be restricted by fixed system limits.

    • FindSourcesForTargetOperationSpec

      protected FindSourcesForTargetOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static FindSourcesForTargetOperationSpec.FindSourcesForTargetOperationSpecBuilder builder()

    • relationName

      @NotNull public @NotNull String relationName()
      The name of the relationship. This method supports relationships created via [Create relationship](#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put). Note, this method does not support 'like' or 'favourite' relationships.

    • sourceType

      @NotNull public @NotNull String sourceType()
      The source entity type of the relationship.

    • targetType

      @NotNull public @NotNull String targetType()
      The target entity type of the relationship.

    • targetKey

      @NotNull public @NotNull String targetKey()
      The identifier for the target entity: - If targetType is user, then specify either current (logged-in user), the user key of the user, or the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - If targetType is 'content', then specify the content ID. - If targetType 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'.

    • expand

      @Nullable public @Nullable List<String> expand()
      A multi-value parameter indicating which properties of the response object to expand. - relationData returns information about the relationship, such as who created it and when it was created. - source returns the source entity. - target returns the target entity.

    • start

      @Nullable public @Nullable Integer start()
      The starting index of the returned relationships.

    • limit

      @Nullable public @Nullable Integer limit()
      The maximum number of relationships to return per page. Note, this may be restricted by fixed system limits.

    • relationName

      public FindSourcesForTargetOperationSpec relationName(@NotNull @NotNull String relationName)
      The name of the relationship. This method supports relationships created via [Create relationship](#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put). Note, this method does not support 'like' or 'favourite' relationships.
      Gibt zurück:
      this.

    • sourceType

      public FindSourcesForTargetOperationSpec sourceType(@NotNull @NotNull String sourceType)
      The source entity type of the relationship.
      Gibt zurück:
      this.

    • targetType

      public FindSourcesForTargetOperationSpec targetType(@NotNull @NotNull String targetType)
      The target entity type of the relationship.
      Gibt zurück:
      this.

    • targetKey

      public FindSourcesForTargetOperationSpec targetKey(@NotNull @NotNull String targetKey)
      The identifier for the target entity: - If targetType is user, then specify either current (logged-in user), the user key of the user, or the account ID of the user. Note that the user key has been deprecated in favor of the account ID for this parameter. See the [migration guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details. - If targetType is 'content', then specify the content ID. - If targetType is 'space', then specify the space key.
      Gibt zurück:
      this.

    • sourceStatus

      public FindSourcesForTargetOperationSpec 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 FindSourcesForTargetOperationSpec 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 FindSourcesForTargetOperationSpec 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 FindSourcesForTargetOperationSpec 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.

    • expand

      public FindSourcesForTargetOperationSpec expand(@Nullable @Nullable List<String> expand)
      A multi-value parameter indicating which properties of the response object to expand. - relationData returns information about the relationship, such as who created it and when it was created. - source returns the source entity. - target returns the target entity.
      Gibt zurück:
      this.

    • start

      public FindSourcesForTargetOperationSpec start(@Nullable @Nullable Integer start)
      The starting index of the returned relationships.
      Gibt zurück:
      this.

    • limit

      public FindSourcesForTargetOperationSpec limit(@Nullable @Nullable Integer limit)
      The maximum number of relationships to return per page. Note, this may be restricted by fixed system limits.
      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