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

Class ListCatalogEntriesOptions

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String account()
      Gets the account.
      java.lang.Boolean catalog()
      Gets the catalog.
      java.lang.Boolean complete()
      Gets the complete.
      java.lang.String descending()
      Gets the descending.
      java.lang.String include()
      Gets the include.
      java.lang.String languages()
      Gets the languages.
      java.lang.Long limit()
      Gets the limit.
      ListCatalogEntriesOptions.Builder newBuilder()
      New builder.
      java.lang.Long offset()
      Gets the offset.
      java.lang.String q()
      Gets the q.
      java.lang.String sortBy()
      Gets the sortBy.

      • 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

      • 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 /?include=*`. To include specific metadata fields, separate each field with a colon (:), for example `GET /?include=metadata.ui:metadata.pricing`.
        Returns:
        the include

      • q

        public java.lang.String q()
        Gets the q. Searches the catalog entries for keywords. Add filters to refine your search. A query filter, for example, `q=kind:iaas service_name rc:true`, filters entries of kind iaas with metadata.service.rc_compatible set to true and have a service name is in their name, display name, or description. Valid tags are **kind**:<string>, **tag**:<strging>, **rc**:[true|false], **iam**:[true|false], **active**:[true|false], **geo**:<string>, and **price**:<string>.
        Returns:
        the q

      • sortBy

        public java.lang.String sortBy()
        Gets the sortBy. The field on which the output is sorted. Sorts by default by **name** property. Available fields are **name**, **displayname** (overview_ui.display_name), **kind**, **provider** (provider.name), **sbsindex** (metadata.ui.side_by_side_index), and the time **created**, and **updated**.
        Returns:
        the sortBy

      • descending

        public java.lang.String descending()
        Gets the descending. Sets the sort order. The default is false, which is ascending.
        Returns:
        the descending

      • languages

        public java.lang.String languages()
        Gets the languages. Return the data strings in a 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

      • catalog

        public java.lang.Boolean catalog()
        Gets the catalog. Checks to see if a catalog's object is visible, or if it's filtered by service, plan, deployment, or region. Use the value `?catalog=true`. If a `200` code is returned, the object is visible. If a `403` code is returned, the object is not visible for the user.
        Returns:
        the catalog

      • 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

      • offset

        public java.lang.Long offset()
        Gets the offset. Useful for pagination, specifies index (origin 0) of first item to return in response.
        Returns:
        the offset

      • limit

        public java.lang.Long limit()
        Gets the limit. Useful for pagination, specifies the maximum number of items to return in the response.
        Returns:
        the limit