Class ExportServiceClient (2.41.0)

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

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 (ExportServiceClient exportServiceClient = ExportServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (Profile element : exportServiceClient.listProfiles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Methods
Method	Description	Method Variants
ListProfiles	Lists profiles which have been collected so far and for which the caller has permission to view.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listProfiles(ListProfilesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listProfiles(ProjectName parent) listProfiles(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listProfilesPagedCallable() listProfilesCallable()

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 ExportServiceSettings 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
 ExportServiceSettings exportServiceSettings =
     ExportServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ExportServiceClient exportServiceClient = ExportServiceClient.create(exportServiceSettings);

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
 ExportServiceSettings exportServiceSettings =
     ExportServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ExportServiceClient exportServiceClient = ExportServiceClient.create(exportServiceSettings);

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
 ExportServiceSettings exportServiceSettings =
     ExportServiceSettings.newHttpJsonBuilder().build();
 ExportServiceClient exportServiceClient = ExportServiceClient.create(exportServiceSettings);

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

Inheritance

java.lang.Object > ExportServiceClient

Static Methods

create()

public static final ExportServiceClient create()

Constructs an instance of ExportServiceClient with default settings.

Returns
Type	Description
`ExportServiceClient`

Exceptions
Type	Description
`IOException`

create(ExportServiceSettings settings)

public static final ExportServiceClient create(ExportServiceSettings settings)

Constructs an instance of ExportServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
`settings`	`ExportServiceSettings`

Returns
Type	Description
`ExportServiceClient`

Exceptions
Type	Description
`IOException`

create(ExportServiceStub stub)

public static final ExportServiceClient create(ExportServiceStub stub)

Constructs an instance of ExportServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ExportServiceSettings).

Parameter
Name	Description
`stub`	`ExportServiceStub`

Returns
Type	Description
`ExportServiceClient`

Constructors

ExportServiceClient(ExportServiceSettings settings)

protected ExportServiceClient(ExportServiceSettings settings)

Constructs an instance of ExportServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
`settings`	`ExportServiceSettings`

ExportServiceClient(ExportServiceStub stub)

protected ExportServiceClient(ExportServiceStub stub)

Parameter
Name	Description
`stub`	`ExportServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

getSettings()

public final ExportServiceSettings getSettings()

Returns
Type	Description
`ExportServiceSettings`

getStub()

public ExportServiceStub getStub()

Returns
Type	Description
`ExportServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listProfiles(ListProfilesRequest request)

public final ExportServiceClient.ListProfilesPagedResponse listProfiles(ListProfilesRequest request)

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

Sample code:


 // 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 (ExportServiceClient exportServiceClient = ExportServiceClient.create()) {
   ListProfilesRequest request =
       ListProfilesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Profile element : exportServiceClient.listProfiles(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListProfilesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`ExportServiceClient.ListProfilesPagedResponse`

listProfiles(ProjectName parent)

public final ExportServiceClient.ListProfilesPagedResponse listProfiles(ProjectName parent)

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

Sample code:


 // 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 (ExportServiceClient exportServiceClient = ExportServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (Profile element : exportServiceClient.listProfiles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`ProjectName` Required. The parent, which owns this collection of profiles. Format: projects/{user_project_id}

Returns
Type	Description
`ExportServiceClient.ListProfilesPagedResponse`

listProfiles(String parent)

public final ExportServiceClient.ListProfilesPagedResponse listProfiles(String parent)

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

Sample code:


 // 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 (ExportServiceClient exportServiceClient = ExportServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (Profile element : exportServiceClient.listProfiles(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of profiles. Format: projects/{user_project_id}

Returns
Type	Description
`ExportServiceClient.ListProfilesPagedResponse`

listProfilesCallable()

public final UnaryCallable<ListProfilesRequest,ListProfilesResponse> listProfilesCallable()

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

Sample code:


 // 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 (ExportServiceClient exportServiceClient = ExportServiceClient.create()) {
   ListProfilesRequest request =
       ListProfilesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListProfilesResponse response = exportServiceClient.listProfilesCallable().call(request);
     for (Profile element : response.getProfilesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListProfilesRequest,ListProfilesResponse>`

listProfilesPagedCallable()

public final UnaryCallable<ListProfilesRequest,ExportServiceClient.ListProfilesPagedResponse> listProfilesPagedCallable()

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

Sample code:


 // 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 (ExportServiceClient exportServiceClient = ExportServiceClient.create()) {
   ListProfilesRequest request =
       ListProfilesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Profile> future =
       exportServiceClient.listProfilesPagedCallable().futureCall(request);
   // Do something.
   for (Profile element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListProfilesRequest,ListProfilesPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()