Tag

All Superinterfaces:

Constructible, Extensible<Tag>
```
public interface Tag
extends Constructible, Extensible<Tag>
```
Tag
An object to store metadata to be available in the OpenAPI document.

See Also:

OpenAPI Specification Tag Object

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default Tag`	`description(java.lang.String description)` Sets the description property of a Tag instance to the given string.
`default Tag`	`externalDocs(ExternalDocumentation externalDocs)` Sets the externalDocs property of a Tag instance to the given object.
`java.lang.String`	`getDescription()` Returns the description property from a Tag instance.
`ExternalDocumentation`	`getExternalDocs()` Returns the externalDocs property from a Tag instance.
`java.lang.String`	`getName()` Returns the name property from a Tag instance.
`default Tag`	`name(java.lang.String name)` Sets the name property of a Tag instance to the given string.
`void`	`setDescription(java.lang.String description)` Sets the description property of a Tag instance to the given string.
`void`	`setExternalDocs(ExternalDocumentation externalDocs)` Sets the externalDocs property of a Tag instance to the given object.
`void`	`setName(java.lang.String name)` Sets the name property of a Tag instance to the given string.

Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible
addExtension, extensions, getExtensions, removeExtension, setExtensions

- Method Detail
  - getName
```
java.lang.String getName()
```
    Returns the name property from a Tag instance.
    
    Returns:
    
    the name property from this tag
  - setName
```
void setName(java.lang.String name)
```
    Sets the name property of a Tag instance to the given string.
    
    Parameters:
    
    name - the name property for this tag
  - name
```
default Tag name(java.lang.String name)
```
    Sets the name property of a Tag instance to the given string.
    
    Parameters:
    
    name - the name property for this tag
    
    Returns:
    
    the current Tag instance
  - getDescription
```
java.lang.String getDescription()
```
    Returns the description property from a Tag instance.
    
    Returns:
    
    the description property from this tag
  - setDescription
```
void setDescription(java.lang.String description)
```
    Sets the description property of a Tag instance to the given string.
    
    Parameters:
    
    description - the description property for this tag
  - description
```
default Tag description(java.lang.String description)
```
    Sets the description property of a Tag instance to the given string.
    
    Parameters:
    
    description - the description property for this tag
    
    Returns:
    
    the current Tag instance
  - getExternalDocs
```
ExternalDocumentation getExternalDocs()
```
    Returns the externalDocs property from a Tag instance.
    
    Returns:
    
    additional external documentation from this tag
  - setExternalDocs
```
void setExternalDocs(ExternalDocumentation externalDocs)
```
    Sets the externalDocs property of a Tag instance to the given object.
    
    Parameters:
    
    externalDocs - additional external documentation for this tag
  - externalDocs
```
default Tag externalDocs(ExternalDocumentation externalDocs)
```
    Sets the externalDocs property of a Tag instance to the given object.
    
    Parameters:
    
    externalDocs - additional external documentation for this tag
    
    Returns:
    
    the current Tag instance

Interface Tag

Method Summary

Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible

Method Detail

getName

setName

name

getDescription

setDescription

description

getExternalDocs

setExternalDocs

externalDocs