Package com.commercetools.api.models.api_client

Interface ApiClientDraft

All Superinterfaces:
Draft<ApiClientDraft>
public interface ApiClientDraft extends Draft<ApiClientDraft>
ApiClientDraft
Example to create an instance using the builder pattern 

     ApiClientDraft apiClientDraft = ApiClientDraft.builder()
             .name("{name}")
             .scope("{scope}")
             .build()

  • Method Details

    • getName

      @NotNull @NotNull String getName()

      Name of the APIClient.

      Returns:
      name

    • getScope

      @NotNull @NotNull String getScope()

      Whitespace-separated list of OAuth scopes that can be used when obtaining an access token.

      Returns:
      scope

    • getDeleteDaysAfterCreation

      Long getDeleteDaysAfterCreation()

      If set, the Client will be deleted after the specified amount of days.

      Returns:
      deleteDaysAfterCreation

    • getAccessTokenValiditySeconds

      Integer getAccessTokenValiditySeconds()

      Expiration time in seconds for each access token obtained by the APIClient. If not set the default value applies.

      Returns:
      accessTokenValiditySeconds

    • getRefreshTokenValiditySeconds

      Integer getRefreshTokenValiditySeconds()

      Inactivity expiration time in seconds for each refresh token obtained by the APIClient. The expiration time for refresh tokens is restarted each time the token is used. If not set the default value applies.

      Returns:
      refreshTokenValiditySeconds

    • setName

      void setName(String name)

      Name of the APIClient.

      Parameters:
      name - value to be set

    • setScope

      void setScope(String scope)

      Whitespace-separated list of OAuth scopes that can be used when obtaining an access token.

      Parameters:
      scope - value to be set

    • setDeleteDaysAfterCreation

      void setDeleteDaysAfterCreation(Long deleteDaysAfterCreation)

      If set, the Client will be deleted after the specified amount of days.

      Parameters:
      deleteDaysAfterCreation - value to be set

    • setAccessTokenValiditySeconds

      void setAccessTokenValiditySeconds(Integer accessTokenValiditySeconds)

      Expiration time in seconds for each access token obtained by the APIClient. If not set the default value applies.

      Parameters:
      accessTokenValiditySeconds - value to be set

    • setRefreshTokenValiditySeconds

      void setRefreshTokenValiditySeconds(Integer refreshTokenValiditySeconds)

      Inactivity expiration time in seconds for each refresh token obtained by the APIClient. The expiration time for refresh tokens is restarted each time the token is used. If not set the default value applies.

      Parameters:
      refreshTokenValiditySeconds - value to be set

    • of

      static ApiClientDraft of()
      factory method
      Returns:
      instance of ApiClientDraft

    • of

      static ApiClientDraft of(ApiClientDraft template)
      factory method to create a shallow copy ApiClientDraft
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • copyDeep

      ApiClientDraft copyDeep()

    • deepCopy

      @Nullable static ApiClientDraft deepCopy(@Nullable ApiClientDraft template)
      factory method to create a deep copy of ApiClientDraft
      Parameters:
      template - instance to be copied
      Returns:
      copy instance

    • builder

      static ApiClientDraftBuilder builder()
      builder factory method for ApiClientDraft
      Returns:
      builder

    • builder

      static ApiClientDraftBuilder builder(ApiClientDraft template)
      create builder for ApiClientDraft instance
      Parameters:
      template - instance with prefilled values for the builder
      Returns:
      builder

    • withApiClientDraft

      default <T> T withApiClientDraft(Function<ApiClientDraft,T> helper)
      accessor map function
      Type Parameters:
      T - mapped type
      Parameters:
      helper - function to map the object
      Returns:
      mapped value

    • typeReference

      static com.fasterxml.jackson.core.type.TypeReference<ApiClientDraft> typeReference()
      gives a TypeReference for usage with Jackson DataBind
      Returns:
      TypeReference