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

Class GetCatalogEntryOptions

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String account()
      Gets the account.
      java.lang.Boolean complete()
      Gets the complete.
      java.lang.Long depth()
      Gets the depth.
      java.lang.String id()
      Gets the id.
      java.lang.String include()
      Gets the include.
      java.lang.String languages()
      Gets the languages.
      GetCatalogEntryOptions.Builder newBuilder()
      New builder.

      • Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

        equals, hashCode, toString

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • id

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

      • 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

      • include

        public java.lang.String include()
        Gets the include. A GET call by default returns a basic set of properties. To include other properties, you must add this parameter. A wildcard (`*`) includes all properties for an object, for example `GET /id?include=*`. To include specific metadata fields, separate each field with a colon (:), for example `GET /id?include=metadata.ui:metadata.pricing`.
        Returns:
        the include

      • languages

        public java.lang.String languages()
        Gets the languages. Return the data strings in the specified language. By default the strings returned are of the language preferred by your browser through the Accept-Language header, which allows an override of the header. Languages are specified in standard form, such as `en-us`. To include all languages use a wildcard (*).
        Returns:
        the languages

      • complete

        public java.lang.Boolean complete()
        Gets the complete. Returns all available fields for all languages. Use the value `?complete=true` as shortcut for ?include=*&languages=*.
        Returns:
        the complete

      • depth

        public java.lang.Long depth()
        Gets the depth. Return the children down to the requested depth. Use * to include the entire children tree. If there are more children than the maximum permitted an error will be returned. Be judicious with this as it can cause a large number of database accesses and can result in a large amount of data returned.
        Returns:
        the depth