java.lang.Object
- io.fabric8.openshift.api.model.console.v1.ConsoleSampleSpec

All Implemented Interfaces:

io.fabric8.kubernetes.api.builder.Editable<ConsoleSampleSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
```
@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class ConsoleSampleSpec
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<ConsoleSampleSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
```
ConsoleSampleSpec is the desired sample for the web console. Samples will appear with their title, descriptions and a badge in a samples catalog.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor	Description
`ConsoleSampleSpec()`	No args constructor for use in serialization
`ConsoleSampleSpec(String _abstract, String description, String icon, String provider, ConsoleSampleSource source, List<String> tags, String title, String type)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ConsoleSampleSpecBuilder`	`edit()`
`String`	`getAbstract()`	abstract is a short introduction to the sample.
`Map<String,Object>`	`getAdditionalProperties()`
`String`	`getDescription()`	description is a long form explanation of the sample.
`String`	`getIcon()`	icon is an optional base64 encoded image and shown beside the sample title.
`String`	`getProvider()`	provider is an optional label to honor who provides the sample.
`ConsoleSampleSource`	`getSource()`	ConsoleSampleSpec is the desired sample for the web console.
`List<String>`	`getTags()`	tags are optional string values that can be used to find samples in the samples catalog.
`String`	`getTitle()`	title is the display name of the sample.
`String`	`getType()`	type is an optional label to group multiple samples.
`void`	`setAbstract(String _abstract)`	abstract is a short introduction to the sample.
`void`	`setAdditionalProperties(Map<String,Object> additionalProperties)`
`void`	`setAdditionalProperty(String name, Object value)`
`void`	`setDescription(String description)`	description is a long form explanation of the sample.
`void`	`setIcon(String icon)`	icon is an optional base64 encoded image and shown beside the sample title.
`void`	`setProvider(String provider)`	provider is an optional label to honor who provides the sample.
`void`	`setSource(ConsoleSampleSource source)`	ConsoleSampleSpec is the desired sample for the web console.
`void`	`setTags(List<String> tags)`	tags are optional string values that can be used to find samples in the samples catalog.
`void`	`setTitle(String title)`	title is the display name of the sample.
`void`	`setType(String type)`	type is an optional label to group multiple samples.
`ConsoleSampleSpecBuilder`	`toBuilder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ConsoleSampleSpec
```
public ConsoleSampleSpec()
```
    No args constructor for use in serialization
  - ConsoleSampleSpec
```
public ConsoleSampleSpec(String _abstract,
                         String description,
                         String icon,
                         String provider,
                         ConsoleSampleSource source,
                         List<String> tags,
                         String title,
                         String type)
```
- Method Detail
  - getAbstract
```
public String getAbstract()
```
    abstract is a short introduction to the sample.
    
    It is required and must be no more than 100 characters in length.
    
    The abstract is shown on the sample card tile below the title and provider and is limited to three lines of content.
  - setAbstract
```
public void setAbstract(String _abstract)
```
    abstract is a short introduction to the sample.
    
    It is required and must be no more than 100 characters in length.
    
    The abstract is shown on the sample card tile below the title and provider and is limited to three lines of content.
  - getDescription
```
public String getDescription()
```
    description is a long form explanation of the sample.
    
    It is required and can have a maximum length of **4096** characters.
    
    It is a README.md-like content for additional information, links, pre-conditions, and other instructions. It will be rendered as Markdown so that it can contain line breaks, links, and other simple formatting.
  - setDescription
```
public void setDescription(String description)
```
    description is a long form explanation of the sample.
    
    It is required and can have a maximum length of **4096** characters.
    
    It is a README.md-like content for additional information, links, pre-conditions, and other instructions. It will be rendered as Markdown so that it can contain line breaks, links, and other simple formatting.
  - getIcon
```
public String getIcon()
```
    icon is an optional base64 encoded image and shown beside the sample title.
    
    The format must follow the data: URL format and can have a maximum size of **10 KB**.
    
    data:[<mediatype>][;base64],<base64 encoded image>
    
    For example:
    
    data:image;base64, plus the base64 encoded image.
    
    Vector images can also be used. SVG icons must start with:
    
    data:image/svg+xml;base64, plus the base64 encoded SVG image.
    
    All sample catalog icons will be shown on a white background (also when the dark theme is used). The web console ensures that different aspect ratios work correctly. Currently, the surface of the icon is at most 40x100px.
    
    For more information on the data URL format, please visit https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs.
  - setIcon
```
public void setIcon(String icon)
```
    icon is an optional base64 encoded image and shown beside the sample title.
    
    The format must follow the data: URL format and can have a maximum size of **10 KB**.
    
    data:[<mediatype>][;base64],<base64 encoded image>
    
    For example:
    
    data:image;base64, plus the base64 encoded image.
    
    Vector images can also be used. SVG icons must start with:
    
    data:image/svg+xml;base64, plus the base64 encoded SVG image.
    
    All sample catalog icons will be shown on a white background (also when the dark theme is used). The web console ensures that different aspect ratios work correctly. Currently, the surface of the icon is at most 40x100px.
    
    For more information on the data URL format, please visit https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs.
  - getProvider
```
public String getProvider()
```
    provider is an optional label to honor who provides the sample.
    
    It is optional and must be no more than 50 characters in length.
    
    A provider can be a company like "Red Hat" or an organization like "CNCF" or "Knative".
    
    Currently, the provider is only shown on the sample card tile below the title with the prefix "Provided by "
  - setProvider
```
public void setProvider(String provider)
```
    provider is an optional label to honor who provides the sample.
    
    It is optional and must be no more than 50 characters in length.
    
    A provider can be a company like "Red Hat" or an organization like "CNCF" or "Knative".
    
    Currently, the provider is only shown on the sample card tile below the title with the prefix "Provided by "
  - getSource
```
public ConsoleSampleSource getSource()
```
    ConsoleSampleSpec is the desired sample for the web console. Samples will appear with their title, descriptions and a badge in a samples catalog.
  - setSource
```
public void setSource(ConsoleSampleSource source)
```
    ConsoleSampleSpec is the desired sample for the web console. Samples will appear with their title, descriptions and a badge in a samples catalog.
  - getTags
```
public List<String> getTags()
```
    tags are optional string values that can be used to find samples in the samples catalog.
    
    Examples of common tags may be "Java", "Quarkus", etc.
    
    They will be displayed on the samples details page.
  - setTags
```
public void setTags(List<String> tags)
```
    tags are optional string values that can be used to find samples in the samples catalog.
    
    Examples of common tags may be "Java", "Quarkus", etc.
    
    They will be displayed on the samples details page.
  - getTitle
```
public String getTitle()
```
    title is the display name of the sample.
    
    It is required and must be no more than 50 characters in length.
  - setTitle
```
public void setTitle(String title)
```
    title is the display name of the sample.
    
    It is required and must be no more than 50 characters in length.
  - getType
```
public String getType()
```
    type is an optional label to group multiple samples.
    
    It is optional and must be no more than 20 characters in length.
    
    Recommendation is a singular term like "Builder Image", "Devfile" or "Serverless Function".
    
    Currently, the type is shown a badge on the sample card tile in the top right corner.
  - setType
```
public void setType(String type)
```
    type is an optional label to group multiple samples.
    
    It is optional and must be no more than 20 characters in length.
    
    Recommendation is a singular term like "Builder Image", "Devfile" or "Serverless Function".
    
    Currently, the type is shown a badge on the sample card tile in the top right corner.
  - edit
```
public ConsoleSampleSpecBuilder edit()
```
    Specified by:
    
    edit in interface io.fabric8.kubernetes.api.builder.Editable<ConsoleSampleSpecBuilder>
  - toBuilder
```
public ConsoleSampleSpecBuilder toBuilder()
```
  - getAdditionalProperties
```
public Map<String,Object> getAdditionalProperties()
```
  - setAdditionalProperty
```
public void setAdditionalProperty(String name,
                                  Object value)
```
  - setAdditionalProperties
```
public void setAdditionalProperties(Map<String,Object> additionalProperties)
```

Class ConsoleSampleSpec

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ConsoleSampleSpec

ConsoleSampleSpec

Method Detail

getAbstract

setAbstract

getDescription

setDescription

getIcon

setIcon

getProvider

setProvider

getSource

setSource

getTags

setTags

getTitle

setTitle

getType

setType

edit

toBuilder

getAdditionalProperties

setAdditionalProperty

setAdditionalProperties