Package com.ibm.cloud.platform_services.global_catalog.v1.model

Class UpdateCatalogEntryOptions

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class UpdateCatalogEntryOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    The updateCatalogEntry options.

    • Method Detail

      • id

        public java.lang.String id()
        Gets the id. The object's unique ID.
        Returns:
        the id

      • name

        public java.lang.String name()
        Gets the name. Programmatic name for this catalog entry, which must be formatted like a CRN segment. See the display name in OverviewUI for a user-readable name.
        Returns:
        the name

      • kind

        public java.lang.String kind()
        Gets the kind. The type of catalog entry which determines the type and shape of the object. Valid GC types are buildpack, cname, dataset, geography, iaas, platform_service, runtime, service, template, ui-dashboard.
        Returns:
        the kind

      • overviewUi

        public java.util.Map<java.lang.String,​Overview> overviewUi()
        Gets the overviewUi. Overview is nested in the top level. The key value pair is `[_language_]overview_ui`.
        Returns:
        the overviewUi

      • images

        public Image images()
        Gets the images. Image annotation for this catalog entry. The image is a URL.
        Returns:
        the images

      • disabled

        public java.lang.Boolean disabled()
        Gets the disabled. Boolean value that determines the global visibility for the catalog entry, and its children. If it is not enabled, all plans are disabled.
        Returns:
        the disabled

      • tags

        public java.util.List<java.lang.String> tags()
        Gets the tags. A searchable list of tags. For example, IBM, 3rd Party, Beta, GA, and Single Tenant. Valid values found at https://globalcatalog.test.cloud.ibm.com/search.
        Returns:
        the tags

      • provider

        public Provider provider()
        Gets the provider. Information related to the provider associated with a catalog entry.
        Returns:
        the provider

      • parentId

        public java.lang.String parentId()
        Gets the parentId. The ID of the parent catalog entry if it exists.
        Returns:
        the parentId

      • group

        public java.lang.Boolean group()
        Gets the group. Boolean value that determines whether the catalog entry is a group.
        Returns:
        the group

      • active

        public java.lang.Boolean active()
        Gets the active. Boolean value that describes whether the service is active.
        Returns:
        the active

      • url

        public java.lang.String url()
        Gets the url. Url of the object.
        Returns:
        the url

      • metadata

        public ObjectMetadataSet metadata()
        Gets the metadata. Model used to describe metadata object that can be set.
        Returns:
        the metadata

      • account

        public java.lang.String account()
        Gets the account. This changes the scope of the request regardless of the authorization header. Example scopes are `account` and `global`. `account=global` is reqired if operating with a service ID that has a global admin policy, for example `GET /?account=global`.
        Returns:
        the account

      • move

        public java.lang.String move()
        Gets the move. Reparenting object. In the body set the parent_id to a different parent. Or remove the parent_id field to reparent to the root of the catalog. If this is not set to 'true' then changing the parent_id in the body of the request will not be permitted. If this is 'true' and no change to parent_id then this is also error. This is to prevent accidental changing of parent.
        Returns:
        the move