com.sinch.sdk.domains.conversation.models.v1.credentials.StaticBearerCredentials Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sinch-sdk-java Show documentation

SDK providing a Java API for the Sinch REST APIs.

There is a newer version: 1.4.0

/*
 * Conversation API | Sinch
 *
 * OpenAPI document version: 1.0
 * Contact: [email protected]
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * Do not edit the class manually.
 */

package com.sinch.sdk.domains.conversation.models.v1.credentials;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;

/**
 * This object is required for channels which use a bearer-type of credential for authentication.
 */
@JsonDeserialize(builder = StaticBearerCredentialsImpl.Builder.class)
public interface StaticBearerCredentials extends ChannelCredentials {

  /**
   * The claimed identity for the channel.
   *
   * @return claimedIdentity
   */
  String getClaimedIdentity();

  /**
   * The static bearer token for the channel.
   *
   * @return token
   */
  String getToken();

  /**
   * Getting builder
   *
   * @return New Builder instance
   */
  static Builder builder() {
    return new StaticBearerCredentialsImpl.Builder();
  }

  /** Dedicated Builder */
  interface Builder {

    /**
     * see getter
     *
     * @param claimedIdentity see getter
     * @return Current builder
     * @see #getClaimedIdentity
     */
    Builder setClaimedIdentity(String claimedIdentity);

    /**
     * see getter
     *
     * @param token see getter
     * @return Current builder
     * @see #getToken
     */
    Builder setToken(String token);

    /**
     * Create instance
     *
     * @return The instance build with current builder values
     */
    StaticBearerCredentials build();
  }
}