Class: Google::Apis::CloudtraceV2beta1::CloudTraceService

Inherits:
Google::Apis::Core::BaseService show all
Defined in:
generated/google/apis/cloudtrace_v2beta1/service.rb

Overview

Stackdriver Trace API

Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API. This library is used to interact with the Trace API directly. If you are looking to instrument your application for Stackdriver Trace, we recommend using OpenCensus.

Examples:

require 'google/apis/cloudtrace_v2beta1'

Cloudtrace = Google::Apis::CloudtraceV2beta1 # Alias the module
service = Cloudtrace::CloudTraceService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Google::Apis::Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Google::Apis::Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Google::Apis::Core::Logging

#logger

Constructor Details

#initializeCloudTraceService


49
50
51
52
# File 'generated/google/apis/cloudtrace_v2beta1/service.rb', line 49

def initialize
  super('https://cloudtrace.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString


42
43
44
# File 'generated/google/apis/cloudtrace_v2beta1/service.rb', line 42

def key
  @key
end

#quota_userString


47
48
49
# File 'generated/google/apis/cloudtrace_v2beta1/service.rb', line 47

def quota_user
  @quota_user
end

Instance Method Details

#create_project_trace_sink(parent, trace_sink_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtraceV2beta1::TraceSink

Creates a sink that exports trace spans to a destination. The export of newly-ingested traces begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export traces only from the resource owning the sink (the 'parent').

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


81
82
83
84
85
86
87
88
89
90
91
# File 'generated/google/apis/cloudtrace_v2beta1/service.rb', line 81

def create_project_trace_sink(parent, trace_sink_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v2beta1/{+parent}/traceSinks', options)
  command.request_representation = Google::Apis::CloudtraceV2beta1::TraceSink::Representation
  command.request_object = trace_sink_object
  command.response_representation = Google::Apis::CloudtraceV2beta1::TraceSink::Representation
  command.response_class = Google::Apis::CloudtraceV2beta1::TraceSink
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_trace_sink(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtraceV2beta1::Empty

Deletes a sink.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


116
117
118
119
120
121
122
123
124
# File 'generated/google/apis/cloudtrace_v2beta1/service.rb', line 116

def delete_project_trace_sink(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::CloudtraceV2beta1::Empty::Representation
  command.response_class = Google::Apis::CloudtraceV2beta1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_trace_sink(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtraceV2beta1::TraceSink

Get a trace sink by name under the parent resource (GCP project).

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


148
149
150
151
152
153
154
155
156
# File 'generated/google/apis/cloudtrace_v2beta1/service.rb', line 148

def get_project_trace_sink(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+name}', options)
  command.response_representation = Google::Apis::CloudtraceV2beta1::TraceSink::Representation
  command.response_class = Google::Apis::CloudtraceV2beta1::TraceSink
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_trace_sinks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtraceV2beta1::ListTraceSinksResponse

List all sinks for the parent resource (GCP project).

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


189
190
191
192
193
194
195
196
197
198
199
# File 'generated/google/apis/cloudtrace_v2beta1/service.rb', line 189

def list_project_trace_sinks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v2beta1/{+parent}/traceSinks', options)
  command.response_representation = Google::Apis::CloudtraceV2beta1::ListTraceSinksResponse::Representation
  command.response_class = Google::Apis::CloudtraceV2beta1::ListTraceSinksResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_trace_sink(name, trace_sink_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudtraceV2beta1::TraceSink

Updates a sink. This method updates fields in the existing sink according to the provided update mask. The sink's name cannot be changed nor any output-only fields (e.g. the writer_identity).

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


236
237
238
239
240
241
242
243
244
245
246
247
# File 'generated/google/apis/cloudtrace_v2beta1/service.rb', line 236

def patch_project_trace_sink(name, trace_sink_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v2beta1/{+name}', options)
  command.request_representation = Google::Apis::CloudtraceV2beta1::TraceSink::Representation
  command.request_object = trace_sink_object
  command.response_representation = Google::Apis::CloudtraceV2beta1::TraceSink::Representation
  command.response_class = Google::Apis::CloudtraceV2beta1::TraceSink
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end