module Google::Cloud

Public Class Methods

trace(project_id = nil, credentials = nil, scope: nil, timeout: nil) click to toggle source

Creates a new object for connecting to the Stackdriver Trace service. Each call creates a new connection.

For more information on connecting to Google Cloud see the {file:AUTHENTICATION.md Authentication Guide}.

@param [String] project_id Project identifier for the Stackdriver Trace

service you are connecting to. If not present, the default project for
the credentials is used.

@param [String, Hash, Google::Auth::Credentials] credentials The path to

the keyfile as a String, the contents of the keyfile as a Hash, or a
Google::Auth::Credentials object. (See {Trace::Credentials})

@param [String, Array<String>] scope The OAuth 2.0 scopes controlling the

set of resources and operations that the connection can access. See
[Using OAuth 2.0 to Access Google
APIs](https://developers.google.com/identity/protocols/OAuth2).

The default scope is:

* `https://www.googleapis.com/auth/cloud-platform`

@param [Integer] timeout Default timeout to use in requests. Optional.

@return [Google::Cloud::Trace::Project]

@example

require "google/cloud"

trace_client = Google::Cloud.trace

traces = trace_client.list_traces Time.now - 3600, Time.now
traces.each do |trace|
  puts "Retrieved trace ID: #{trace.trace_id}"
end
# File lib/google-cloud-trace.rb, line 101
def self.trace project_id = nil,
               credentials = nil,
               scope: nil,
               timeout: nil
  require "google/cloud/trace"
  Google::Cloud::Trace.new project_id: project_id,
                           credentials: credentials,
                           scope: scope,
                           timeout: timeout
end

Public Instance Methods

trace(scope: nil, timeout: nil) click to toggle source

Creates a new object for connecting to the Stackdriver Trace service. Each call creates a new connection.

For more information on connecting to Google Cloud see the {file:AUTHENTICATION.md Authentication Guide}.

@param [String, Array<String>] scope The OAuth 2.0 scopes controlling the

set of resources and operations that the connection can access. See
[Using OAuth 2.0 to Access Google
APIs](https://developers.google.com/identity/protocols/OAuth2).

The default scope is:

* `https://www.googleapis.com/auth/cloud-platform`

@param [Integer] timeout Default timeout to use in requests. Optional.

@return [Google::Cloud::Trace::Project]

@example

require "google/cloud"

gcloud = Google::Cloud.new
trace_client = gcloud.trace

traces = trace_client.list_traces Time.now - 3600, Time.now
traces.each do |trace|
  puts "Retrieved trace ID: #{trace.trace_id}"
end
# File lib/google-cloud-trace.rb, line 60
def trace scope: nil, timeout: nil
  Google::Cloud.trace @project, @keyfile, scope: scope,
                                          timeout: (timeout || @timeout)
end