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

Class GetChildObjectsOptions

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class GetChildObjectsOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    The getChildObjects 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.String descending()
      Gets the descending.
      java.lang.String id()
      Gets the id.
      java.lang.String include()
      Gets the include.
      java.lang.String kind()
      Gets the kind.
      java.lang.String languages()
      Gets the languages.
      java.lang.Long limit()
      Gets the limit.
      GetChildObjectsOptions.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

      • id

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

      • kind

        public java.lang.String kind()
        Gets the kind. The **kind** of child catalog entries to search for. A wildcard (*) includes all child catalog entries for all kinds, for example `GET /service_name/_*`.
        Returns:
        the kind

      • 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 colon (:) separated list of properties to include. A GET call by defaults return a limited set of properties. To include other properties, you must add the include parameter. A wildcard (*) includes all properties.
        Returns:
        the include

      • q

        public java.lang.String q()
        Gets the q. A query filter, for example, `q=kind:iaas IBM` will filter on entries of **kind** iaas that has `IBM` in their name, display name, or description.
        Returns:
        the q

      • sortBy

        public java.lang.String sortBy()
        Gets the sortBy. The field on which to sort the output. By default by name. Available fields are **name**, **kind**, and **provider**.
        Returns:
        the sortBy

      • descending

        public java.lang.String descending()
        Gets the descending. 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 the specified language. By default the strings returned are of the language preferred by your browser through the Accept-Language header. This allows an override of the header. Languages are specified in standard form, such as `en-us`. To include all languages use the wildcard (*).
        Returns:
        the languages

      • complete

        public java.lang.Boolean complete()
        Gets the complete. 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