Class SdkKey


  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
               date="2026-06-30T13:33:45.929090Z[Etc/UTC]",
               comments="Generator version: 7.18.0")
    public class SdkKey
    extends java.lang.Object
    SdkKey
    • Field Detail

      • SERIALIZED_NAME_LINKS

        public static final java.lang.String SERIALIZED_NAME_LINKS
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_KIND

        public static final java.lang.String SERIALIZED_NAME_KIND
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_KEY

        public static final java.lang.String SERIALIZED_NAME_KEY
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_NAME

        public static final java.lang.String SERIALIZED_NAME_NAME
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_DESCRIPTION

        public static final java.lang.String SERIALIZED_NAME_DESCRIPTION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_EXPIRY

        public static final java.lang.String SERIALIZED_NAME_EXPIRY
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_VALUE

        public static final java.lang.String SERIALIZED_NAME_VALUE
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_IS_DEFAULT

        public static final java.lang.String SERIALIZED_NAME_IS_DEFAULT
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_CREATED_BY_MEMBER_ID

        public static final java.lang.String SERIALIZED_NAME_CREATED_BY_MEMBER_ID
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_CREATED_AT

        public static final java.lang.String SERIALIZED_NAME_CREATED_AT
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_UPDATED_AT

        public static final java.lang.String SERIALIZED_NAME_UPDATED_AT
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_VERSION

        public static final java.lang.String SERIALIZED_NAME_VERSION
        See Also:
        Constant Field Values
      • SERIALIZED_NAME_VIEW_SUMMARIES

        public static final java.lang.String SERIALIZED_NAME_VIEW_SUMMARIES
        See Also:
        Constant Field Values
      • openapiFields

        public static java.util.HashSet<java.lang.String> openapiFields
      • openapiRequiredFields

        public static java.util.HashSet<java.lang.String> openapiRequiredFields
    • Constructor Detail

      • SdkKey

        public SdkKey()
    • Method Detail

      • getKind

        @Nonnull
        public SdkKeyKind getKind()
        Get kind
        Returns:
        kind
      • setKind

        public void setKind​(@Nonnull
                            SdkKeyKind kind)
      • key

        public SdkKey key​(@Nonnull
                          java.lang.String key)
      • getKey

        @Nonnull
        public java.lang.String getKey()
        The user-defined identifying key of the SDK key. This is used solely to identify an SDK key and is distinct from the value field, which is the actual SDK key value.
        Returns:
        key
      • setKey

        public void setKey​(@Nonnull
                           java.lang.String key)
      • name

        public SdkKey name​(@Nonnull
                           java.lang.String name)
      • getName

        @Nonnull
        public java.lang.String getName()
        The human-readable name of the SDK key.
        Returns:
        name
      • setName

        public void setName​(@Nonnull
                            java.lang.String name)
      • description

        public SdkKey description​(@Nullable
                                  java.lang.String description)
      • getDescription

        @Nullable
        public java.lang.String getDescription()
        The optional description of the SDK key.
        Returns:
        description
      • setDescription

        public void setDescription​(@Nullable
                                   java.lang.String description)
      • expiry

        public SdkKey expiry​(@Nullable
                             java.lang.Long expiry)
      • getExpiry

        @Nullable
        public java.lang.Long getExpiry()
        Get expiry
        Returns:
        expiry
      • setExpiry

        public void setExpiry​(@Nullable
                              java.lang.Long expiry)
      • value

        public SdkKey value​(@Nonnull
                            java.lang.String value)
      • getValue

        @Nonnull
        public java.lang.String getValue()
        The string value of the SDK key. Use this when configuring your SDK.
        Returns:
        value
      • setValue

        public void setValue​(@Nonnull
                             java.lang.String value)
      • isDefault

        public SdkKey isDefault​(@Nonnull
                                java.lang.Boolean isDefault)
      • getIsDefault

        @Nonnull
        public java.lang.Boolean getIsDefault()
        Indicates if this SDK key is the system-defined default for the environment. There may also be an expiring default SDK key for the environment (not possible with mobile keys).
        Returns:
        isDefault
      • setIsDefault

        public void setIsDefault​(@Nonnull
                                 java.lang.Boolean isDefault)
      • createdByMemberId

        public SdkKey createdByMemberId​(@Nullable
                                        java.lang.String createdByMemberId)
      • getCreatedByMemberId

        @Nullable
        public java.lang.String getCreatedByMemberId()
        The ID of the member who created the SDK key. This field is immutable.
        Returns:
        createdByMemberId
      • setCreatedByMemberId

        public void setCreatedByMemberId​(@Nullable
                                         java.lang.String createdByMemberId)
      • createdAt

        public SdkKey createdAt​(@Nonnull
                                java.lang.Long createdAt)
      • getCreatedAt

        @Nonnull
        public java.lang.Long getCreatedAt()
        Get createdAt
        Returns:
        createdAt
      • setCreatedAt

        public void setCreatedAt​(@Nonnull
                                 java.lang.Long createdAt)
      • updatedAt

        public SdkKey updatedAt​(@Nonnull
                                java.lang.Long updatedAt)
      • getUpdatedAt

        @Nonnull
        public java.lang.Long getUpdatedAt()
        Get updatedAt
        Returns:
        updatedAt
      • setUpdatedAt

        public void setUpdatedAt​(@Nonnull
                                 java.lang.Long updatedAt)
      • version

        public SdkKey version​(@Nonnull
                              java.lang.Integer version)
      • getVersion

        @Nonnull
        public java.lang.Integer getVersion()
        The auto-incremented version number of the SDK key.
        Returns:
        version
      • setVersion

        public void setVersion​(@Nonnull
                               java.lang.Integer version)
      • viewSummaries

        public SdkKey viewSummaries​(@Nullable
                                    java.util.List<ViewSummary> viewSummaries)
      • addViewSummariesItem

        public SdkKey addViewSummariesItem​(ViewSummary viewSummariesItem)
      • getViewSummaries

        @Nullable
        public java.util.List<ViewSummary> getViewSummaries()
        Summaries of views associated with the SDK key.
        Returns:
        viewSummaries
      • setViewSummaries

        public void setViewSummaries​(@Nullable
                                     java.util.List<ViewSummary> viewSummaries)
      • putAdditionalProperty

        public SdkKey putAdditionalProperty​(java.lang.String key,
                                            java.lang.Object value)
        Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
        Parameters:
        key - name of the property
        value - value of the property
        Returns:
        the SdkKey instance itself
      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()
        Return the additional (undeclared) property.
        Returns:
        a map of objects
      • getAdditionalProperty

        public java.lang.Object getAdditionalProperty​(java.lang.String key)
        Return the additional (undeclared) property with the specified name.
        Parameters:
        key - name of the property
        Returns:
        an object
      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • validateJsonElement

        public static void validateJsonElement​(com.google.gson.JsonElement jsonElement)
                                        throws java.io.IOException
        Validates the JSON Element and throws an exception if issues found
        Parameters:
        jsonElement - JSON Element
        Throws:
        java.io.IOException - if the JSON Element is invalid with respect to SdkKey
      • fromJson

        public static SdkKey fromJson​(java.lang.String jsonString)
                               throws java.io.IOException
        Create an instance of SdkKey given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of SdkKey
        Throws:
        java.io.IOException - if the JSON string is invalid with respect to SdkKey
      • toJson

        public java.lang.String toJson()
        Convert an instance of SdkKey to an JSON string
        Returns:
        JSON string