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

Class ConsoleCustomization

  • All Implemented Interfaces:
    io.fabric8.kubernetes.api.builder.Editable<ConsoleCustomizationBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource, Serializable
    @Generated("io.fabric8.kubernetes.schema.generator.model.ModelGenerator")
public class ConsoleCustomization
extends Object
implements io.fabric8.kubernetes.api.builder.Editable<ConsoleCustomizationBuilder>, io.fabric8.kubernetes.api.model.KubernetesResource
    ConsoleCustomization defines a list of optional configuration for the console UI. Ensure that Logos and CustomLogoFile cannot be set at the same time.
    See Also:
    Serialized Form

    • Method Detail

      • getAddPage

        public AddPage getAddPage()
        ConsoleCustomization defines a list of optional configuration for the console UI. Ensure that Logos and CustomLogoFile cannot be set at the same time.

      • setAddPage

        public void setAddPage​(AddPage addPage)
        ConsoleCustomization defines a list of optional configuration for the console UI. Ensure that Logos and CustomLogoFile cannot be set at the same time.

      • getBrand

        public String getBrand()
        brand is the default branding of the web console which can be overridden by providing the brand field. There is a limited set of specific brand options. This field controls elements of the console such as the logo. Invalid value will prevent a console rollout.

      • setBrand

        public void setBrand​(String brand)
        brand is the default branding of the web console which can be overridden by providing the brand field. There is a limited set of specific brand options. This field controls elements of the console such as the logo. Invalid value will prevent a console rollout.

      • getCapabilities

        public List<Capability> getCapabilities()
        capabilities defines an array of capabilities that can be interacted with in the console UI. Each capability defines a visual state that can be interacted with the console to render in the UI. Available capabilities are LightspeedButton and GettingStartedBanner. Each of the available capabilities may appear only once in the list.

      • setCapabilities

        public void setCapabilities​(List<Capability> capabilities)
        capabilities defines an array of capabilities that can be interacted with in the console UI. Each capability defines a visual state that can be interacted with the console to render in the UI. Available capabilities are LightspeedButton and GettingStartedBanner. Each of the available capabilities may appear only once in the list.

      • getCustomLogoFile

        public io.fabric8.openshift.api.model.config.v1.ConfigMapFileReference getCustomLogoFile()
        ConsoleCustomization defines a list of optional configuration for the console UI. Ensure that Logos and CustomLogoFile cannot be set at the same time.

      • setCustomLogoFile

        public void setCustomLogoFile​(io.fabric8.openshift.api.model.config.v1.ConfigMapFileReference customLogoFile)
        ConsoleCustomization defines a list of optional configuration for the console UI. Ensure that Logos and CustomLogoFile cannot be set at the same time.

      • getCustomProductName

        public String getCustomProductName()
        customProductName is the name that will be displayed in page titles, logo alt text, and the about dialog instead of the normal OpenShift product name.

      • setCustomProductName

        public void setCustomProductName​(String customProductName)
        customProductName is the name that will be displayed in page titles, logo alt text, and the about dialog instead of the normal OpenShift product name.

      • getDeveloperCatalog

        public DeveloperConsoleCatalogCustomization getDeveloperCatalog()
        ConsoleCustomization defines a list of optional configuration for the console UI. Ensure that Logos and CustomLogoFile cannot be set at the same time.

      • setDeveloperCatalog

        public void setDeveloperCatalog​(DeveloperConsoleCatalogCustomization developerCatalog)
        ConsoleCustomization defines a list of optional configuration for the console UI. Ensure that Logos and CustomLogoFile cannot be set at the same time.

      • getDocumentationBaseURL

        public String getDocumentationBaseURL()
        documentationBaseURL links to external documentation are shown in various sections of the web console. Providing documentationBaseURL will override the default documentation URL. Invalid value will prevent a console rollout.

      • setDocumentationBaseURL

        public void setDocumentationBaseURL​(String documentationBaseURL)
        documentationBaseURL links to external documentation are shown in various sections of the web console. Providing documentationBaseURL will override the default documentation URL. Invalid value will prevent a console rollout.

      • getLogos

        public List<Logo> getLogos()
        logos is used to replace the OpenShift Masthead and Favicon logos in the console UI with custom logos. logos is an optional field that allows a list of logos. Only one of logos or customLogoFile can be set at a time. If logos is set, customLogoFile must be unset. When specified, there must be at least one entry and no more than 2 entries. Each type must appear only once in the list.

      • setLogos

        public void setLogos​(List<Logo> logos)
        logos is used to replace the OpenShift Masthead and Favicon logos in the console UI with custom logos. logos is an optional field that allows a list of logos. Only one of logos or customLogoFile can be set at a time. If logos is set, customLogoFile must be unset. When specified, there must be at least one entry and no more than 2 entries. Each type must appear only once in the list.

      • getPerspectives

        public List<Perspective> getPerspectives()
        perspectives allows enabling/disabling of perspective(s) that user can see in the Perspective switcher dropdown.

      • setPerspectives

        public void setPerspectives​(List<Perspective> perspectives)
        perspectives allows enabling/disabling of perspective(s) that user can see in the Perspective switcher dropdown.

      • getProjectAccess

        public ProjectAccess getProjectAccess()
        ConsoleCustomization defines a list of optional configuration for the console UI. Ensure that Logos and CustomLogoFile cannot be set at the same time.

      • setProjectAccess

        public void setProjectAccess​(ProjectAccess projectAccess)
        ConsoleCustomization defines a list of optional configuration for the console UI. Ensure that Logos and CustomLogoFile cannot be set at the same time.

      • getQuickStarts

        public QuickStarts getQuickStarts()
        ConsoleCustomization defines a list of optional configuration for the console UI. Ensure that Logos and CustomLogoFile cannot be set at the same time.

      • setQuickStarts

        public void setQuickStarts​(QuickStarts quickStarts)
        ConsoleCustomization defines a list of optional configuration for the console UI. Ensure that Logos and CustomLogoFile cannot be set at the same time.

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()

      • setAdditionalProperty

        public void setAdditionalProperty​(String name,
                                  Object value)

      • setAdditionalProperties

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