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

Class PostUserWatchSpaceBySpaceKeyV1OperationSpec

java.lang.Object
io.github.primelib.confluence4j.rest.v1.operations.PostUserWatchSpaceBySpaceKeyV1OperationSpec
@Generated("io.github.primelib.primecodegen") public class PostUserWatchSpaceBySpaceKeyV1OperationSpec extends Object
PostUserWatchSpaceBySpaceKeyV1

Adds a user as a watcher to a space. Choose the user by doing one of the following: - Specify a user via a query parameter: Use the `accountId` to identify the user. - Do not specify a user: The currently logged-in user will be used. Note, you must add the `X-Atlassian-Token: no-check` header when making a request, as this operation has XSRF protection. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).

  • Field Details

    • VALIDATION_ENABLED

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

  • Constructor Details

  • Method Details

    • validate

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

    • xAtlassianToken

      public @NonNull String xAtlassianToken()
      Note, you must add header when making a request, as this operation has XSRF protection.

    • spaceKey

      public @NonNull String spaceKey()
      The key of the space to add the watcher to.

    • key

      @Deprecated public @Nullable String key()
      Deprecated.
      This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.

    • username

      @Deprecated public @Nullable String username()
      Deprecated.
      This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.

    • accountId

      public @Nullable String accountId()
      The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.

    • xAtlassianToken

      public PostUserWatchSpaceBySpaceKeyV1OperationSpec xAtlassianToken(@NonNull String xAtlassianToken)
      Note, you must add header when making a request, as this operation has XSRF protection.
      Returns:
      this.

    • spaceKey

      public PostUserWatchSpaceBySpaceKeyV1OperationSpec spaceKey(@NonNull String spaceKey)
      The key of the space to add the watcher to.
      Returns:
      this.

    • key

      @Deprecated public PostUserWatchSpaceBySpaceKeyV1OperationSpec key(@Nullable String key)
      Deprecated.
      This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      Returns:
      this.

    • username

      @Deprecated public PostUserWatchSpaceBySpaceKeyV1OperationSpec username(@Nullable String username)
      Deprecated.
      This parameter is no longer available and will be removed from the documentation soon. Use `accountId` instead. See the [deprecation notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/) for details.
      Returns:
      this.

    • accountId

      public PostUserWatchSpaceBySpaceKeyV1OperationSpec accountId(@Nullable String accountId)
      The account ID of the user. The accountId uniquely identifies the user across all Atlassian products. For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
      Returns:
      this.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object