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

Class SpaceCreate

java.lang.Object
io.github.primelib.confluence4j.rest.v1.models.SpaceCreate
@Generated("io.github.primelib.primecodegen") public class SpaceCreate extends Object
SpaceCreate

This is the request object used when creating a new space.

  • Field Details

    • name

      protected String name
      The name of the new space.

    • key

      protected String key
      The key for the new space. Format: See [Space keys](https://confluence.atlassian.com/x/lqNMMQ). If `alias` is not provided, this is required.

    • alias

      protected String alias
      This field will be used as the new identifier for the space in confluence page URLs. If the property is not provided the alias will be the provided key. This property is experimental and may be changed or removed in the future.

    • description

      protected SpaceDescriptionCreate description
      The description of the new/updated space. Note, only the 'plain' representation can be used for the description when creating or updating a space.

    • permissions

      protected List<Map<String,Object>> permissions
      The permissions for the new space. If no permissions are provided, the [Confluence default space permissions](https://confluence.atlassian.com/x/UAgzKw#CreateaSpace-Spacepermissions) are applied. Note that if permissions are provided, the space is created with only the provided set of permissions, not including the default space permissions. Space permissions can be modified after creation using the space permissions endpoints, and a private space can be created using the create private space endpoint.

  • Constructor Details

    • SpaceCreate

      public SpaceCreate(Consumer<SpaceCreate> spec)
      Constructs a validated instance of SpaceCreate.
      Parameters:
      spec - the specification to process

    • SpaceCreate

      @Internal public SpaceCreate(String name, String key, String alias, SpaceDescriptionCreate description, List<Map<String,Object>> permissions)
      Constructs a validated instance of SpaceCreate.

      NOTE: This constructor is not considered stable and may change if the model is updated. Consider using SpaceCreate(Consumer) instead.

      Parameters:
      name - The name of the new space.
      key - The key for the new space. Format: See [Space keys](https://confluence.atlassian.com/x/lqNMMQ). If `alias` is not provided, this is required.
      alias - This field will be used as the new identifier for the space in confluence page URLs. If the property is not provided the alias will be the provided key. This property is experimental and may be changed or removed in the future.
      description - The description of the new/updated space. Note, only the 'plain' representation can be used for the description when creating or updating a space.
      permissions - The permissions for the new space. If no permissions are provided, the [Confluence default space permissions](https://confluence.atlassian.com/x/UAgzKw#CreateaSpace-Spacepermissions) are applied. Note that if permissions are provided, the space is created with only the provided set of permissions, not including the default space permissions. Space permissions can be modified after creation using the space permissions endpoints, and a private space can be created using the create private space endpoint.

    • SpaceCreate

      protected SpaceCreate()

  • Method Details

    • name

      public String name()
      The name of the new space.

    • key

      public String key()
      The key for the new space. Format: See [Space keys](https://confluence.atlassian.com/x/lqNMMQ). If `alias` is not provided, this is required.

    • alias

      public String alias()
      This field will be used as the new identifier for the space in confluence page URLs. If the property is not provided the alias will be the provided key. This property is experimental and may be changed or removed in the future.

    • description

      public SpaceDescriptionCreate description()
      The description of the new/updated space. Note, only the 'plain' representation can be used for the description when creating or updating a space.

    • permissions

      public List<Map<String,Object>> permissions()
      The permissions for the new space. If no permissions are provided, the [Confluence default space permissions](https://confluence.atlassian.com/x/UAgzKw#CreateaSpace-Spacepermissions) are applied. Note that if permissions are provided, the space is created with only the provided set of permissions, not including the default space permissions. Space permissions can be modified after creation using the space permissions endpoints, and a private space can be created using the create private space endpoint.

    • name

      public SpaceCreate name(String name)
      The name of the new space.
      Returns:
      this.

    • key

      public SpaceCreate key(String key)
      The key for the new space. Format: See [Space keys](https://confluence.atlassian.com/x/lqNMMQ). If `alias` is not provided, this is required.
      Returns:
      this.

    • alias

      public SpaceCreate alias(String alias)
      This field will be used as the new identifier for the space in confluence page URLs. If the property is not provided the alias will be the provided key. This property is experimental and may be changed or removed in the future.
      Returns:
      this.

    • description

      public SpaceCreate description(SpaceDescriptionCreate description)
      The description of the new/updated space. Note, only the 'plain' representation can be used for the description when creating or updating a space.
      Returns:
      this.

    • permissions

      public SpaceCreate permissions(List<Map<String,Object>> permissions)
      The permissions for the new space. If no permissions are provided, the [Confluence default space permissions](https://confluence.atlassian.com/x/UAgzKw#CreateaSpace-Spacepermissions) are applied. Note that if permissions are provided, the space is created with only the provided set of permissions, not including the default space permissions. Space permissions can be modified after creation using the space permissions endpoints, and a private space can be created using the create private space endpoint.
      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