module Octokit::EnterpriseAdminClient::SearchIndexing

Methods for the Enterprise Search Indexing API

@see developer.github.com/v3/enterprise-admin/search_indexing/

Public Instance Methods

index_organization(user)
Alias for: index_user
index_organizations_repositories(user)
index_organizations_repositories_code(user)
index_organizations_repositories_issues(user)
index_repository(repo) click to toggle source

Queue a Repository to be indexed

@param repo [String, Hash, Repository] A GitHub repository @return [Sawyer:Resource] Result of the queuing containing `:message`

# 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) click to toggle source

Queue a repository's code to be indexed

@param repo [String, Hash, Repository] A GitHub repository @return [Sawyer:Resource] Result of the queuing containing `:message`

# 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) click to toggle source

Queue a repository's Issues to be indexed

@param repo [String, Hash, Repository] A GitHub repository @return [Sawyer:Resource] Result of the queuing containing `:message`

# 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) click to toggle source

Queue a User or Organization to be indexed

@param user [String] A GitHub Enterprise user or organization @return [Sawyer:Resource] Result of the queuing containing `:message`

# File lib/octokit/enterprise_admin_client/search_indexing.rb, line 13
def index_user(user)
  queue_index user
end
Also aliased as: index_organization
index_users_repositories(user) click to toggle source

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

@param user [String] A GitHub Enterprise user or organization @return [Sawyer:Resource] Result of the queuing containing `:message`

# 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) click to toggle source

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

@param user [String] A GitHub Enterprise user or organization @return [Sawyer:Resource] Result of the queuing containing `:message`

# 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) click to toggle source

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

@param user [String] A GitHub Enterprise user or organization @return [Sawyer:Resource] Result of the queuing containing `:message`

# File lib/octokit/enterprise_admin_client/search_indexing.rb, line 56
def index_users_repositories_issues(user)
  queue_index "#{user}/*/issues"
end

Private Instance Methods

queue_index(target) click to toggle source

@private Queue a target for indexing

@param target [String] Target to index @return [Sawyer:Resource] Result of the queuing containing `:message`

# File lib/octokit/enterprise_admin_client/search_indexing.rb, line 77
def queue_index(target)
  post "staff/indexing_jobs", :target => target
end