Package io.fabric8.openshift.api.model.console.v1

Class ConsoleExternalLogLinkSpec

java.lang.Object

io.fabric8.openshift.api.model.console.v1.ConsoleExternalLogLinkSpec

All Implemented Interfaces:

io.fabric8.kubernetes.api.builder.Editable<ConsoleExternalLogLinkSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable

@Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class ConsoleExternalLogLinkSpec
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<ConsoleExternalLogLinkSpecBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource

ConsoleExternalLogLinkSpec is the desired log link configuration. The log link will appear on the logs tab of the pod details page.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
ConsoleExternalLogLinkSpec()	No args constructor for use in serialization
ConsoleExternalLogLinkSpec(String hrefTemplate, String namespaceFilter, String text)

Method Summary

Modifier and Type	Method	Description
ConsoleExternalLogLinkSpecBuilder	edit()
Map<String,Object>	getAdditionalProperties()
String	getHrefTemplate()	hrefTemplate is an absolute secure URL (must use https) for the log link including variables to be replaced.
String	getNamespaceFilter()	namespaceFilter is a regular expression used to restrict a log link to a matching set of namespaces (e.g., `^openshift-`).
String	getText()	text is the display text for the link
void	setAdditionalProperties(Map<String,Object> additionalProperties)
void	setAdditionalProperty(String name, Object value)
void	setHrefTemplate(String hrefTemplate)	hrefTemplate is an absolute secure URL (must use https) for the log link including variables to be replaced.
void	setNamespaceFilter(String namespaceFilter)	namespaceFilter is a regular expression used to restrict a log link to a matching set of namespaces (e.g., `^openshift-`).
void	setText(String text)	text is the display text for the link
ConsoleExternalLogLinkSpecBuilder	toBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConsoleExternalLogLinkSpec

public ConsoleExternalLogLinkSpec()

No args constructor for use in serialization

ConsoleExternalLogLinkSpec

public ConsoleExternalLogLinkSpec(String hrefTemplate,
                                  String namespaceFilter,
                                  String text)

Method Detail

getHrefTemplate

public String getHrefTemplate()

hrefTemplate is an absolute secure URL (must use https) for the log link including variables to be replaced. Variables are specified in the URL with the format ${variableName}, for instance, ${containerName} and will be replaced with the corresponding values from the resource. Resource is a pod. Supported variables are: - ${resourceName} - name of the resource which containes the logs - ${resourceUID} - UID of the resource which contains the logs

- e.g. `11111111-2222-3333-4444-555555555555`

- ${containerName} - name of the resource's container that contains the logs - ${resourceNamespace} - namespace of the resource that contains the logs - ${resourceNamespaceUID} - namespace UID of the resource that contains the logs - ${podLabels} - JSON representation of labels matching the pod with the logs

- e.g. `{"key1":"value1","key2":"value2"}`

e.g., https://example.com/logs?resourceName=${resourceName}&containerName=${containerName}&resourceNamespace=${resourceNamespace}&podLabels=${podLabels}

setHrefTemplate

public void setHrefTemplate(String hrefTemplate)

hrefTemplate is an absolute secure URL (must use https) for the log link including variables to be replaced. Variables are specified in the URL with the format ${variableName}, for instance, ${containerName} and will be replaced with the corresponding values from the resource. Resource is a pod. Supported variables are: - ${resourceName} - name of the resource which containes the logs - ${resourceUID} - UID of the resource which contains the logs

- e.g. `11111111-2222-3333-4444-555555555555`

- ${containerName} - name of the resource's container that contains the logs - ${resourceNamespace} - namespace of the resource that contains the logs - ${resourceNamespaceUID} - namespace UID of the resource that contains the logs - ${podLabels} - JSON representation of labels matching the pod with the logs

- e.g. `{"key1":"value1","key2":"value2"}`

e.g., https://example.com/logs?resourceName=${resourceName}&containerName=${containerName}&resourceNamespace=${resourceNamespace}&podLabels=${podLabels}

getNamespaceFilter

public String getNamespaceFilter()

namespaceFilter is a regular expression used to restrict a log link to a matching set of namespaces (e.g., `^openshift-`). The string is converted into a regular expression using the JavaScript RegExp constructor. If not specified, links will be displayed for all the namespaces.

setNamespaceFilter

public void setNamespaceFilter(String namespaceFilter)

namespaceFilter is a regular expression used to restrict a log link to a matching set of namespaces (e.g., `^openshift-`). The string is converted into a regular expression using the JavaScript RegExp constructor. If not specified, links will be displayed for all the namespaces.

getText

public String getText()

text is the display text for the link

setText

public void setText(String text)

text is the display text for the link

edit

public ConsoleExternalLogLinkSpecBuilder edit()

Specified by:

edit in interface io.fabric8.kubernetes.api.builder.Editable<ConsoleExternalLogLinkSpecBuilder>

toBuilder

public ConsoleExternalLogLinkSpecBuilder toBuilder()

getAdditionalProperties

public Map<String,Object> getAdditionalProperties()

setAdditionalProperty

public void setAdditionalProperty(String name,
                                  Object value)

setAdditionalProperties

public void setAdditionalProperties(Map<String,Object> additionalProperties)