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

Klasse GetRelationshipOperationSpec

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

Specification for the GetRelationship operation.

Find relationship from source to target

  • Felddetails

    • VALIDATION_ENABLED

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

  • Konstruktordetails

    • GetRelationshipOperationSpec

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

    • GetRelationshipOperationSpec

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

      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 the 'favourite' (i.e. 'save for later') relationship as well as any other relationship types created via [Create relationship](#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put).
      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), 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 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 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.

    • GetRelationshipOperationSpec

      protected GetRelationshipOperationSpec()

  • Methodendetails

    • validate

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

    • builder

      public static GetRelationshipOperationSpec.GetRelationshipOperationSpecBuilder builder()

    • relationName

      @NotNull public @NotNull String relationName()
      The name of the relationship. This method supports the 'favourite' (i.e. 'save for later') relationship as well as any other relationship types created via [Create relationship](#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put).

    • 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), 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 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 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.

    • relationName

      public GetRelationshipOperationSpec relationName(@NotNull @NotNull String relationName)
      The name of the relationship. This method supports the 'favourite' (i.e. 'save for later') relationship as well as any other relationship types created via [Create relationship](#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put).
      Gibt zurück:
      this.

    • sourceType

      public GetRelationshipOperationSpec 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 GetRelationshipOperationSpec sourceKey(@NotNull @NotNull String sourceKey)
      - The identifier for the source entity: - If sourceType 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 sourceType is 'content', then specify the content ID. - If sourceType is 'space', then specify the space key.
      Gibt zurück:
      this.

    • targetType

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

    • 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