Enum DataGroup

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      CAMPAIGN
      The replicated campaign data group.
      CONTENT_INDEX
      The replicated content index data group.
      CONTROL_QUERY
      The replicated control query data group.
      DICTIONARY
      The replicated dictionary data group.
      PROMOTION
      The replicated promotion data group.
      QUERY_ARCHIVE
      The replicated query archive data group.
      RELEVANCY
      The replicated relevancy (models and features) data group.
      SEARCH_PROFILE
      The replicated search profile data group.
      SIGNAL
      The replicated signal data group.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static DataGroup forAuthority​(java.lang.String authority)
      Retrieve the DataGroup for the given authority.
      java.lang.String getAuthority()
      Return the exact authority name.
      java.lang.String getAuthorityPrefix()
      Return the authority prefix.
      static java.util.Set<DataGroup> getMasterReplicatedDataGroups()
      Return the data groups that originate from a master in a multi-region deployment.
      static java.util.Set<DataGroup> getSlaveReplicatedDataGroups()
      Return the data groups that originate from a slave in a multi-region deployment.
      java.lang.String toString()  
      static DataGroup valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DataGroup[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • CONTENT_INDEX

        public static final DataGroup CONTENT_INDEX
        The replicated content index data group. One or more authorities may map to this instance.
      • SEARCH_PROFILE

        public static final DataGroup SEARCH_PROFILE
        The replicated search profile data group.
      • DICTIONARY

        public static final DataGroup DICTIONARY
        The replicated dictionary data group.
      • CONTROL_QUERY

        public static final DataGroup CONTROL_QUERY
        The replicated control query data group.
      • PROMOTION

        public static final DataGroup PROMOTION
        The replicated promotion data group.
      • CAMPAIGN

        public static final DataGroup CAMPAIGN
        The replicated campaign data group.
      • RELEVANCY

        public static final DataGroup RELEVANCY
        The replicated relevancy (models and features) data group.
      • SIGNAL

        public static final DataGroup SIGNAL
        The replicated signal data group.
      • QUERY_ARCHIVE

        public static final DataGroup QUERY_ARCHIVE
        The replicated query archive data group.
    • Method Detail

      • values

        public static DataGroup[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (DataGroup c : DataGroup.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static DataGroup valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • forAuthority

        public static DataGroup forAuthority​(java.lang.String authority)
        Retrieve the DataGroup for the given authority. The authority is resolved to a DataGroup first by exact string match then by prefix.
        Parameters:
        authority - String the authority to resolve
        Returns:
        DataGroup the data group for the given authority or null if one could not be found
      • getMasterReplicatedDataGroups

        public static java.util.Set<DataGroup> getMasterReplicatedDataGroups()
        Return the data groups that originate from a master in a multi-region deployment.
        Returns:
        Set of data groups
      • getSlaveReplicatedDataGroups

        public static java.util.Set<DataGroup> getSlaveReplicatedDataGroups()
        Return the data groups that originate from a slave in a multi-region deployment.
        Returns:
        Set of data groups
      • getAuthority

        public java.lang.String getAuthority()
        Return the exact authority name. This will be null (e.g. CONTENT_INDEX) if the getAuthorityPrefix() is used to dynamically compute the authority.
        Returns:
        String authority; may be null
      • getAuthorityPrefix

        public java.lang.String getAuthorityPrefix()
        Return the authority prefix. This will be null (e.g. DICTIONARY) if the getAuthority() represents the exact authority name.
        Returns:
        String authority prefix; may be null
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<DataGroup>