Tag representation.

Listing tags

All the tags associated with the UpCloud account are available via the Tags API. Tags associated with an individual server are seen in the Server.tags property.

Creating tags

Tags can be created by first using the Builder API, and then passing the tag to the Resource creation API.

The only required property is the name property. Existing servers can be tagged at the same time.

     import static fi.linuxbox.upcloud.resource.Builder.tag

     def dev = tag {
         name = 'DEV'
         description = 'Development servers'
         servers = [
              existingServer.uuid
         ]
     }

     upcloud.create dev, { resp, err ->
         ...
     }
 

Modifying tags

Tags can be modified by first using the Builder API, and then passing the tag to the Tag update API.

The only required property is the name property. Existing servers can be tagged at the same time.

     import fi.linuxbox.upcloud.api.Tag
     import static fi.linuxbox.upcloud.resource.Builder.tag

     def prod = tag {
         name = 'PROD'
         description = 'Production servers'
     }

     def tagApi = dev.withTraits(Tag)
     tagApi.update prod, { resp, err ->
         ...
     }
 

Deleting tags

Tags must be deleted one by one using the Tag delete API. Deleting a tag will automatically remove that tag from any servers.

     import fi.linuxbox.upcloud.api.Tag
     import static fi.linuxbox.upcloud.resource.Builder.tag

     def prod = tag SESSION: session, {
         name = 'PROD'
     }

     def tagApi = prod.withTraits(Tag)

     tagApi.delete { resp, err ->
         ...
     }
 

Deleting all the tags requires first listing the tags and then deleting them one by one (but concurrently).

     import java.util.concurrent.CompletableFuture
     import fi.linuxbox.upcloud.api.Tag

     def tagsDeleted = new CompletableFuture()

     upcloud.tags { resp ->
         def tagDeletions = resp.tags.collect { tag ->
             tag.withTraits(Tag).delete {}
         }

         CompletableFuture.allOf(*tagDeletions).thenRun {
             tagsDeleted.complete(null)
         }
     }

     tagsDeleted.thenRun {
         close()
     }
 

Assinging and removing tags from a server

A special case of tag modification is adding one or more tags to one server. This can be done like shown above, adding the server to one tag at a time. But more efficient way is to use the Server tagging API. Similarly, removing tags from one server can be done using the Server untagging API.