Module: Google::Developers::DeveloperKnowledge

Defined in:
lib/google/developers/developer_knowledge.rb,
lib/google/developers/developer_knowledge/version.rb

Constant Summary collapse

VERSION = 
"0.1.0"

Class Method Summary collapse

Class Method Details

.developer_knowledge(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for DeveloperKnowledge.

By default, this returns an instance of Google::Developers::DeveloperKnowledge::V1::DeveloperKnowledge::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the DeveloperKnowledge service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the DeveloperKnowledge service. You can determine whether the method will succeed by calling developer_knowledge_available?.

About DeveloperKnowledge

The Developer Knowledge API provides programmatic access to Google's public developer documentation, enabling you to integrate this knowledge base into your own applications and workflows.

The API is designed to be the canonical source for machine-readable access to Google's developer documentation.

A typical use case is to first use DeveloperKnowledge.SearchDocumentChunks to find relevant page URIs based on a query, and then use DeveloperKnowledge.GetDocument or DeveloperKnowledge.BatchGetDocuments to fetch the full content of the top results.

All document content is provided in Markdown format.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/google/developers/developer_knowledge.rb', line 72

def self.developer_knowledge version: :v1, transport: :grpc, &block
  require "google/developers/developer_knowledge/#{version.to_s.downcase}"

  package_name = Google::Developers::DeveloperKnowledge
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Developers::DeveloperKnowledge.const_get(package_name).const_get(:DeveloperKnowledge)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.developer_knowledge_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the DeveloperKnowledge service is supported by the current client. If true, you can retrieve a client object by calling developer_knowledge. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the DeveloperKnowledge service, or if the versioned client gem needs an update to support the DeveloperKnowledge service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/google/developers/developer_knowledge.rb', line 96

def self.developer_knowledge_available? version: :v1, transport: :grpc
  require "google/developers/developer_knowledge/#{version.to_s.downcase}"
  package_name = Google::Developers::DeveloperKnowledge
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Developers::DeveloperKnowledge.const_get package_name
  return false unless service_module.const_defined? :DeveloperKnowledge
  service_module = service_module.const_get :DeveloperKnowledge
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end