Cloud Profiler V2 API - Class Google::Cloud::Profiler::V2::ExportService::Client (v0.8.0)

Reference documentation and code samples for the Cloud Profiler V2 API class Google::Cloud::Profiler::V2::ExportService::Client.

Client for the ExportService service.

Service allows existing Cloud Profiler customers to export their profile data out of Google Cloud.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the ExportService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all ExportService clients
::Google::Cloud::Profiler::V2::ExportService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the ExportService 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#initialize

def initialize() { |config| ... } -> Client

Create a new ExportService client object.

Yields
  • (config) — Configure the ExportService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Profiler::V2::ExportService::Client.new

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

#list_profiles

def list_profiles(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Profiler::V2::Profile>
def list_profiles(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Profiler::V2::Profile>

Lists profiles which have been collected so far and for which the caller has permission to view.

Overloads 
def list_profiles(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Profiler::V2::Profile>
Pass arguments to list_profiles via a request object, either of type ListProfilesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Profiler::V2::ListProfilesRequest, ::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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_profiles(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Profiler::V2::Profile>
Pass arguments to list_profiles 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) — Required. The parent, which owns this collection of profiles. Format: projects/{user_project_id}
  • page_size (::Integer) — The maximum number of items to return. Default page_size is 1000. Max limit is 10000.
  • page_token (::String) — The token to continue pagination and get profiles from a particular page. When paginating, all other parameters provided to ListProfiles must match the call that provided the page token.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/profiler/v2"

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

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

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Profiler::V2::Profile.
  p item
end