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 protected SpaceCreate()
      Protected no-args constructor for use by serialization frameworks.

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

  • Method Details

    • name

      public String name()
      Fluent getter for name.

      The name of the new space.

      Returns:
      name

    • name

      public SpaceCreate name(String name)
      Fluent setter for name.

      The name of the new space.

      Parameters:
      name - name
      Returns:
      this

    • getName

      public String getName()
      Gets the value of name.

      The name of the new space.

      Returns:
      name

    • setName

      public void setName(String name)
      Sets the value of name.

      The name of the new space.

      Parameters:
      name - name

    • key

      public String key()
      Fluent getter for 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:
      key

    • key

      public SpaceCreate key(String key)
      Fluent setter for 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.

      Parameters:
      key - key
      Returns:
      this

    • getKey

      public String getKey()
      Gets the value of 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:
      key

    • setKey

      public void setKey(String key)
      Sets the value of 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.

      Parameters:
      key - key

    • alias

      public String alias()
      Fluent getter for 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:
      alias

    • alias

      public SpaceCreate alias(String alias)
      Fluent setter for 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.

      Parameters:
      alias - alias
      Returns:
      this

    • getAlias

      public String getAlias()
      Gets the value of 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:
      alias

    • setAlias

      public void setAlias(String alias)
      Sets the value of 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.

      Parameters:
      alias - alias

    • description

      public SpaceDescriptionCreate description()
      Fluent getter for 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:
      description

    • description

      public SpaceCreate description(SpaceDescriptionCreate description)
      Fluent setter for 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.

      Parameters:
      description - description
      Returns:
      this

    • getDescription

      public SpaceDescriptionCreate getDescription()
      Gets the value of 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:
      description

    • setDescription

      public void setDescription(SpaceDescriptionCreate description)
      Sets the value of 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.

      Parameters:
      description - description

    • permissions

      public List<Map<String,Object>> permissions()
      Fluent getter for 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:
      permissions

    • permissions

      public SpaceCreate permissions(List<Map<String,Object>> permissions)
      Fluent setter for 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.

      Parameters:
      permissions - permissions
      Returns:
      this

    • getPermissions

      public List<Map<String,Object>> getPermissions()
      Gets the value of 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:
      permissions

    • setPermissions

      public void setPermissions(List<Map<String,Object>> permissions)
      Sets the value of 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.

      Parameters:
      permissions - permissions

    • equals

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object