Package com.google.devtools.cloudprofiler.v2 (2.3.5)

CreateOfflineProfileRequest describes a profile resource offline creation request. Profile field must be set.

Protobuf type google.devtools.cloudprofiler.v2.CreateOfflineProfileRequest

CreateOfflineProfileRequest describes a profile resource offline creation request. Profile field must be set.

Protobuf type google.devtools.cloudprofiler.v2.CreateOfflineProfileRequest

CreateProfileRequest describes a profile resource online creation request. The deployment field must be populated. The profile_type specifies the list of profile types supported by the agent. The creation call will hang until a profile of one of these types needs to be collected.

Protobuf type google.devtools.cloudprofiler.v2.CreateProfileRequest

CreateProfileRequest describes a profile resource online creation request. The deployment field must be populated. The profile_type specifies the list of profile types supported by the agent. The creation call will hang until a profile of one of these types needs to be collected.

Protobuf type google.devtools.cloudprofiler.v2.CreateProfileRequest

Deployment contains the deployment identification information.

Protobuf type google.devtools.cloudprofiler.v2.Deployment

Deployment contains the deployment identification information.

Protobuf type google.devtools.cloudprofiler.v2.Deployment

Profile resource.

Protobuf type google.devtools.cloudprofiler.v2.Profile

Profile resource.

Protobuf type google.devtools.cloudprofiler.v2.Profile

Service Description: 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.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ProfilerServiceClient profilerServiceClient = ProfilerServiceClient.create()) {
   CreateProfileRequest request =
       CreateProfileRequest.newBuilder()
           .setParent("parent-995424086")
           .setDeployment(Deployment.newBuilder().build())
           .addAllProfileType(new ArrayList<ProfileType>())
           .build();
   Profile response = profilerServiceClient.createProfile(request);
 }
 

Note: close() needs to be called on the ProfilerServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ProfilerServiceSettings to create(). For example:

To customize credentials:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ProfilerServiceSettings profilerServiceSettings =
     ProfilerServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ProfilerServiceClient profilerServiceClient =
     ProfilerServiceClient.create(profilerServiceSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ProfilerServiceSettings profilerServiceSettings =
     ProfilerServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ProfilerServiceClient profilerServiceClient =
     ProfilerServiceClient.create(profilerServiceSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ProfilerServiceSettings profilerServiceSettings =
     ProfilerServiceSettings.newBuilder()
         .setTransportChannelProvider(
             ProfilerServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 ProfilerServiceClient profilerServiceClient =
     ProfilerServiceClient.create(profilerServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

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.

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.

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.

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.

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.

Settings class to configure an instance of ProfilerServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (cloudprofiler.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createProfile to 30 seconds:

 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ProfilerServiceSettings.Builder profilerServiceSettingsBuilder =
     ProfilerServiceSettings.newBuilder();
 profilerServiceSettingsBuilder
     .createProfileSettings()
     .setRetrySettings(
         profilerServiceSettingsBuilder.createProfileSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ProfilerServiceSettings profilerServiceSettings = profilerServiceSettingsBuilder.build();
 

Builder for ProfilerServiceSettings.

UpdateProfileRequest contains the profile to update.

Protobuf type google.devtools.cloudprofiler.v2.UpdateProfileRequest

UpdateProfileRequest contains the profile to update.

Protobuf type google.devtools.cloudprofiler.v2.UpdateProfileRequest

ProfileType is type of profiling data. NOTE: the enumeration member names are used (in lowercase) as unique string identifiers of profile types, so they must not be renamed.

Protobuf enum google.devtools.cloudprofiler.v2.ProfileType