DigitalOcean.Tag (digital_ocean v0.5.0)

Summary

Functions

Create a tag.

Delete a tag.

Retrieve details about a specific tag.

Retrieve a list of tags.

Tag the given resources with specific tag.

Untag the given resources with specific tag.

Functions

create(opts)

@spec create(Keyword.t()) :: DigitalOcean.Operation.t()

Create a tag.

Examples

iex> DigitalOcean.Tag.create(
...>   name: "mytag",
...> ) |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

delete(tag_name)

@spec delete(String.t()) :: DigitalOcean.Operation.t()

Delete a tag.

Examples

iex> DigitalOcean.Tag.delete("mytag") |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

get(tag_name)

Retrieve details about a specific tag.

Examples

iex> DigitalOcean.Tag.get("mytag") |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

list(opts \\ [])

@spec list(Keyword.t()) :: DigitalOcean.Operation.t()

Retrieve a list of tags.

Examples

iex> DigitalOcean.Tag.list() |> DigitalOcean.request()
{ :ok, %DigitalOcean.Response{} }

tag_resources(tag_name, opts)

@spec tag_resources(String.t(), Keyword.t()) :: DigitalOcean.Operation.t()

Tag the given resources with specific tag.

Examples

iex> DigitalOcean.Tag.tag_resources("mytag", resources: [resource_id: "123", resource_name: "mydroplet"]) |> DigitalOcean.request()

{ :ok, %DigitalOcean.Response{} }

untag_resources(tag_name, opts)

@spec untag_resources(String.t(), Keyword.t()) :: DigitalOcean.Operation.t()

Untag the given resources with specific tag.

Examples

iex> DigitalOcean.Tag.untag_resources("mytag", resources: [resource_id: "123", resource_name: "mydroplet"]) |> DigitalOcean.request()

{ :ok, %DigitalOcean.Response{} }