Class ApiKeyList

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel

    public class ApiKeyList
    extends com.ibm.cloud.sdk.core.service.model.GenericModel
    Response body format for the List API keys V1 REST request.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.List<ApiKey> getApikeys()
      Gets the apikeys.
      ResponseContext getContext()
      Gets the context.
      java.lang.String getFirst()
      Gets the first.
      java.lang.Long getLimit()
      Gets the limit.
      java.lang.String getNext()
      Gets the next.
      java.lang.Long getOffset()
      Gets the offset.
      java.lang.String getPrevious()
      Gets the previous.
      • 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

      • getContext

        public ResponseContext getContext()
        Gets the context. Context with key properties for problem determination.
        Returns:
        the context
      • getOffset

        public java.lang.Long getOffset()
        Gets the offset. The offset of the current page.
        Returns:
        the offset
      • getLimit

        public java.lang.Long getLimit()
        Gets the limit. Optional size of a single page. Default is 20 items per page. Valid range is 1 to 100.
        Returns:
        the limit
      • getFirst

        public java.lang.String getFirst()
        Gets the first. Link to the first page.
        Returns:
        the first
      • getPrevious

        public java.lang.String getPrevious()
        Gets the previous. Link to the previous available page. If 'previous' property is not part of the response no previous page is available.
        Returns:
        the previous
      • getNext

        public java.lang.String getNext()
        Gets the next. Link to the next available page. If 'next' property is not part of the response no next page is available.
        Returns:
        the next
      • getApikeys

        public java.util.List<ApiKey> getApikeys()
        Gets the apikeys. List of API keys based on the query paramters and the page size. The apikeys array is always part of the response but might be empty depending on the query parameters values provided.
        Returns:
        the apikeys