Class: Google::Cloud::Profiler::V2::ProfilerService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/profiler/v2/profiler_service/rest/client.rb

Overview

REST client for the ProfilerService service.

Manage the collection of continuous profiling data provided by profiling agents running in the cloud or by an offline provider of profiling data.

General guidelines:

  • Profiles for a single deployment must be created in ascending time order.
  • Profiles can be created in either online or offline mode, see below.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#profile_path, #project_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new ProfilerService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Profiler::V2::ProfilerService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Profiler::V2::ProfilerService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the ProfilerService client.

Yield Parameters:



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/google/cloud/profiler/v2/profiler_service/rest/client.rb', line 127

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @profiler_service_stub = ::Google::Cloud::Profiler::V2::ProfilerService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the ProfilerService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all ProfilerService clients
::Google::Cloud::Profiler::V2::ProfilerService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/google/cloud/profiler/v2/profiler_service/rest/client.rb', line 63

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Profiler", "V2"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_profile.timeout = 3610.0

    default_config.rpcs.create_offline_profile.timeout = 30.0

    default_config.rpcs.update_profile.timeout = 30.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the ProfilerService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



106
107
108
109
 
# File 'lib/google/cloud/profiler/v2/profiler_service/rest/client.rb', line 106

def configure
  yield @config if block_given?
  @config
end

#create_offline_profile(request, options = nil) ⇒ ::Google::Cloud::Profiler::V2::Profile #create_offline_profile(parent: nil, profile: nil) ⇒ ::Google::Cloud::Profiler::V2::Profile

CreateOfflineProfile creates a new profile resource in the offline mode. The client provides the profile to create along with the profile bytes, the server records it.

Examples:

Basic example

require "google/cloud/profiler/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Profiler::V2::ProfilerService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Profiler::V2::CreateOfflineProfileRequest.new

# Call the create_offline_profile method.
result = client.create_offline_profile request

# The returned object is of type Google::Cloud::Profiler::V2::Profile.
p result

Overloads:

  • #create_offline_profile(request, options = nil) ⇒ ::Google::Cloud::Profiler::V2::Profile

    Pass arguments to create_offline_profile via a request object, either of type CreateOfflineProfileRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Profiler::V2::CreateOfflineProfileRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_offline_profile(parent: nil, profile: nil) ⇒ ::Google::Cloud::Profiler::V2::Profile

    Pass arguments to create_offline_profile via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Parent project to create the profile in.

    • profile (::Google::Cloud::Profiler::V2::Profile, ::Hash) (defaults to: nil) —

      Contents of the profile to create.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/google/cloud/profiler/v2/profiler_service/rest/client.rb', line 295

def create_offline_profile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Profiler::V2::CreateOfflineProfileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_offline_profile.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Profiler::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_offline_profile.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_offline_profile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @profiler_service_stub.create_offline_profile request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_profile(request, options = nil) ⇒ ::Google::Cloud::Profiler::V2::Profile #create_profile(parent: nil, deployment: nil, profile_type: nil) ⇒ ::Google::Cloud::Profiler::V2::Profile

CreateProfile creates a new profile resource in the online mode.

The server ensures that the new profiles are created at a constant rate per deployment, so the creation request may hang for some time until the next profile session is available.

The request may fail with ABORTED error if the creation is not available within ~1m, the response will indicate the duration of the backoff the client should take before attempting creating a profile again. The backoff duration is returned in google.rpc.RetryInfo extension on the response status. To a gRPC client, the extension will be return as a binary-serialized proto in the trailing metadata item named "google.rpc.retryinfo-bin".

Examples:

Basic example

require "google/cloud/profiler/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Profiler::V2::ProfilerService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Profiler::V2::CreateProfileRequest.new

# Call the create_profile method.
result = client.create_profile request

# The returned object is of type Google::Cloud::Profiler::V2::Profile.
p result

Overloads:

  • #create_profile(request, options = nil) ⇒ ::Google::Cloud::Profiler::V2::Profile

    Pass arguments to create_profile via a request object, either of type CreateProfileRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Profiler::V2::CreateProfileRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_profile(parent: nil, deployment: nil, profile_type: nil) ⇒ ::Google::Cloud::Profiler::V2::Profile

    Pass arguments to create_profile via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/google/cloud/profiler/v2/profiler_service/rest/client.rb', line 213

def create_profile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Profiler::V2::CreateProfileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_profile.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Profiler::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_profile.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_profile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @profiler_service_stub.create_profile request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_profile(request, options = nil) ⇒ ::Google::Cloud::Profiler::V2::Profile #update_profile(profile: nil, update_mask: nil) ⇒ ::Google::Cloud::Profiler::V2::Profile

UpdateProfile updates the profile bytes and labels on the profile resource created in the online mode. Updating the bytes for profiles created in the offline mode is currently not supported: the profile content must be provided at the time of the profile creation.

Examples:

Basic example

require "google/cloud/profiler/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Profiler::V2::ProfilerService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Profiler::V2::UpdateProfileRequest.new

# Call the update_profile method.
result = client.update_profile request

# The returned object is of type Google::Cloud::Profiler::V2::Profile.
p result

Overloads:

  • #update_profile(request, options = nil) ⇒ ::Google::Cloud::Profiler::V2::Profile

    Pass arguments to update_profile via a request object, either of type UpdateProfileRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Profiler::V2::UpdateProfileRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_profile(profile: nil, update_mask: nil) ⇒ ::Google::Cloud::Profiler::V2::Profile

    Pass arguments to update_profile via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • profile (::Google::Cloud::Profiler::V2::Profile, ::Hash) (defaults to: nil) —

      Profile to update.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Field mask used to specify the fields to be overwritten. Currently only profile_bytes and labels fields are supported by UpdateProfile, so only those fields can be specified in the mask. When no mask is provided, all fields are overwritten.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
 
# File 'lib/google/cloud/profiler/v2/profiler_service/rest/client.rb', line 381

def update_profile request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Profiler::V2::UpdateProfileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_profile.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Profiler::V2::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_profile.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_profile.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @profiler_service_stub.update_profile request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end