123456789_123456789_123456789_123456789_123456789_

Module: Octokit::EnterpriseAdminClient::SearchIndexing

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Included In:
::Octokit::EnterpriseAdminClient
Defined in: lib/octokit/enterprise_admin_client/search_indexing.rb

Overview

Methods for the Enterprise Search Indexing API

See Also:

Instance Method Summary

Instance Method Details

#index_organization(user)

Alias for #index_user.

[ GitHub ] 

  


# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 16



alias index_organization index_user


  








  

    #index_organizations_repositories(user)  
  



  

    
Alias for #index_users_repositories.


  



  [ GitHub ]


  

  


# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 49



alias index_organizations_repositories index_users_repositories


  








  

    #index_organizations_repositories_code(user)  
  



  

    
Alias for #index_users_repositories_code.


  



  [ GitHub ]


  

  


# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 69



alias index_organizations_repositories_code index_users_repositories_code


  








  

    #index_organizations_repositories_issues(user)  
  



  

    
Alias for #index_users_repositories_issues.


  



  [ GitHub ]


  

  


# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 59



alias index_organizations_repositories_issues index_users_repositories_issues


  








  

    #index_repository(repo)  ⇒ Sawyer:Resource 
  



  

    
Queue a ::Octokit::Repository to be indexed


  





  
Parameters:


    
  
  • 
    repo
    (String, Hash, Repository)
—    
    A GitHub repository
    

    
  
    • 



Returns:


    
  
  • 
    (Sawyer:Resource)
—    
    Result of the queuing containing :message
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 22



def index_repository(repo)
  queue_index Repository.new repo
end


  








  

    #index_repository_code(repo)  ⇒ Sawyer:Resource 
  



  

    
Queue a repository's code to be indexed


  





  
Parameters:


    
  
  • 
    repo
    (String, Hash, Repository)
—    
    A GitHub repository
    

    
  
    • 



Returns:


    
  
  • 
    (Sawyer:Resource)
—    
    Result of the queuing containing :message
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 38



def index_repository_code(repo)
  queue_index "#{Repository.new repo}/code"
end


  








  

    #index_repository_issues(repo)  ⇒ Sawyer:Resource 
  



  

    
Queue a repository's Issues to be indexed


  





  
Parameters:


    
  
  • 
    repo
    (String, Hash, Repository)
—    
    A GitHub repository
    

    
  
    • 



Returns:


    
  
  • 
    (Sawyer:Resource)
—    
    Result of the queuing containing :message
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 30



def index_repository_issues(repo)
  queue_index "#{Repository.new repo}/issues"
end


  








  

    #index_user(user)  ⇒ Sawyer:Resource 
    Also known as: #index_organization
  



  

    
Queue a ::Octokit::User or ::Octokit::Organization to be indexed


  





  
Parameters:


    
  
  • 
    user
    (String)
—    
    A GitHub Enterprise user or organization
    

    
  
    • 



Returns:


    
  
  • 
    (Sawyer:Resource)
—    
    Result of the queuing containing :message
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 13



def index_user(user)
  queue_index user
end


  








  

    #index_users_repositories(user)  ⇒ Sawyer:Resource 
    Also known as: #index_organizations_repositories
  



  

    
Queue a user's or organization's repositories to be indexed


  





  
Parameters:


    
  
  • 
    user
    (String)
—    
    A GitHub Enterprise user or organization
    

    
  
    • 



Returns:


    
  
  • 
    (Sawyer:Resource)
—    
    Result of the queuing containing :message
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 46



def index_users_repositories(user)
  queue_index "#{user}/*"
end


  








  

    #index_users_repositories_code(user)  ⇒ Sawyer:Resource 
    Also known as: #index_organizations_repositories_code
  



  

    
Queue an index of all the code contained in all of a user's or
organization's repositories


  





  
Parameters:


    
  
  • 
    user
    (String)
—    
    A GitHub Enterprise user or organization
    

    
  
    • 



Returns:


    
  
  • 
    (Sawyer:Resource)
—    
    Result of the queuing containing :message
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 66



def index_users_repositories_code(user)
  queue_index "#{user}/*/code"
end


  








  

    #index_users_repositories_issues(user)  ⇒ Sawyer:Resource 
    Also known as: #index_organizations_repositories_issues
  



  

    
Queue an index of all the issues across all of a user's or
organization's repositories


  





  
Parameters:


    
  
  • 
    user
    (String)
—    
    A GitHub Enterprise user or organization
    

    
  
    • 



Returns:


    
  
  • 
    (Sawyer:Resource)
—    
    Result of the queuing containing :message
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 56



def index_users_repositories_issues(user)
  queue_index "#{user}/*/issues"
end


  








  

    #queue_index(target)  ⇒ Sawyer:Resource  (private)
  

  

    This method is for internal use only.
  



  

    
  





  
Parameters:


    
  
  • 
    target
    (String)
—    
    Target to index
    

    
  
    • 



Returns:


    
  
  • 
    (Sawyer:Resource)
—    
    Result of the queuing containing :message
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/octokit/enterprise_admin_client/search_indexing.rb', line 77



def queue_index(target)
  post 'staff/indexing_jobs', target: target
end