Class NetworkProfilesClient (1.65.0)

GitHub RepositoryProduct Reference

Service Description: The NetworkProfiles API.

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 (NetworkProfilesClient networkProfilesClient = NetworkProfilesClient.create()) {
   String project = "project-309310695";
   String networkProfile = "networkProfile-2013096037";
   NetworkProfile response = networkProfilesClient.get(project, networkProfile);
 }

Note: close() needs to be called on the NetworkProfilesClient 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

Get

Returns the specified network profile.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • get(GetNetworkProfileRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • get(String project, String networkProfile)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getCallable()

List

Retrieves a list of network profiles available to the specified project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • list(ListNetworkProfilesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • list(String project)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPagedCallable()

  • listCallable()

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 NetworkProfilesSettings 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
 NetworkProfilesSettings networkProfilesSettings =
     NetworkProfilesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 NetworkProfilesClient networkProfilesClient =
     NetworkProfilesClient.create(networkProfilesSettings);

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
 NetworkProfilesSettings networkProfilesSettings =
     NetworkProfilesSettings.newBuilder().setEndpoint(myEndpoint).build();
 NetworkProfilesClient networkProfilesClient =
     NetworkProfilesClient.create(networkProfilesSettings);

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

Inheritance

java.lang.Object > NetworkProfilesClient

Static Methods

create()

public static final NetworkProfilesClient create()

Constructs an instance of NetworkProfilesClient with default settings.

Returns
Type Description
NetworkProfilesClient
Exceptions
Type Description
IOException

create(NetworkProfilesSettings settings)

public static final NetworkProfilesClient create(NetworkProfilesSettings settings)

Constructs an instance of NetworkProfilesClient, 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 NetworkProfilesSettings
Returns
Type Description
NetworkProfilesClient
Exceptions
Type Description
IOException

create(NetworkProfilesStub stub)

public static final NetworkProfilesClient create(NetworkProfilesStub stub)

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

Parameter
Name Description
stub NetworkProfilesStub
Returns
Type Description
NetworkProfilesClient

Constructors

NetworkProfilesClient(NetworkProfilesSettings settings)

protected NetworkProfilesClient(NetworkProfilesSettings settings)

Constructs an instance of NetworkProfilesClient, 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 NetworkProfilesSettings

NetworkProfilesClient(NetworkProfilesStub stub)

protected NetworkProfilesClient(NetworkProfilesStub stub)
Parameter
Name Description
stub NetworkProfilesStub

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()

get(GetNetworkProfileRequest request)

public final NetworkProfile get(GetNetworkProfileRequest request)

Returns the specified network profile.

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 (NetworkProfilesClient networkProfilesClient = NetworkProfilesClient.create()) {
   GetNetworkProfileRequest request =
       GetNetworkProfileRequest.newBuilder()
           .setNetworkProfile("networkProfile-2013096037")
           .setProject("project-309310695")
           .build();
   NetworkProfile response = networkProfilesClient.get(request);
 }
Parameter
Name Description
request GetNetworkProfileRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
NetworkProfile

get(String project, String networkProfile)

public final NetworkProfile get(String project, String networkProfile)

Returns the specified network profile.

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 (NetworkProfilesClient networkProfilesClient = NetworkProfilesClient.create()) {
   String project = "project-309310695";
   String networkProfile = "networkProfile-2013096037";
   NetworkProfile response = networkProfilesClient.get(project, networkProfile);
 }
Parameters
Name Description
project String

Project ID for this request.
networkProfile String

Name of the network profile to return.
Returns
Type Description
NetworkProfile

getCallable()

public final UnaryCallable<GetNetworkProfileRequest,NetworkProfile> getCallable()

Returns the specified network profile.

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 (NetworkProfilesClient networkProfilesClient = NetworkProfilesClient.create()) {
   GetNetworkProfileRequest request =
       GetNetworkProfileRequest.newBuilder()
           .setNetworkProfile("networkProfile-2013096037")
           .setProject("project-309310695")
           .build();
   ApiFuture<NetworkProfile> future = networkProfilesClient.getCallable().futureCall(request);
   // Do something.
   NetworkProfile response = future.get();
 }
Returns
Type Description
UnaryCallable<GetNetworkProfileRequest,NetworkProfile>

getSettings()

public final NetworkProfilesSettings getSettings()
Returns
Type Description
NetworkProfilesSettings

getStub()

public NetworkProfilesStub getStub()
Returns
Type Description
NetworkProfilesStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListNetworkProfilesRequest request)

public final NetworkProfilesClient.ListPagedResponse list(ListNetworkProfilesRequest request)

Retrieves a list of network profiles available to the specified project.

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 (NetworkProfilesClient networkProfilesClient = NetworkProfilesClient.create()) {
   ListNetworkProfilesRequest request =
       ListNetworkProfilesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (NetworkProfile element : networkProfilesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListNetworkProfilesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
NetworkProfilesClient.ListPagedResponse

list(String project)

public final NetworkProfilesClient.ListPagedResponse list(String project)

Retrieves a list of network profiles available to the specified project.

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 (NetworkProfilesClient networkProfilesClient = NetworkProfilesClient.create()) {
   String project = "project-309310695";
   for (NetworkProfile element : networkProfilesClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Project ID for this request.
Returns
Type Description
NetworkProfilesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListNetworkProfilesRequest,NetworkProfilesListResponse> listCallable()

Retrieves a list of network profiles available to the specified project.

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 (NetworkProfilesClient networkProfilesClient = NetworkProfilesClient.create()) {
   ListNetworkProfilesRequest request =
       ListNetworkProfilesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     NetworkProfilesListResponse response = networkProfilesClient.listCallable().call(request);
     for (NetworkProfile element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListNetworkProfilesRequest,NetworkProfilesListResponse>

listPagedCallable()

public final UnaryCallable<ListNetworkProfilesRequest,NetworkProfilesClient.ListPagedResponse> listPagedCallable()

Retrieves a list of network profiles available to the specified project.

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 (NetworkProfilesClient networkProfilesClient = NetworkProfilesClient.create()) {
   ListNetworkProfilesRequest request =
       ListNetworkProfilesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<NetworkProfile> future =
       networkProfilesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (NetworkProfile element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListNetworkProfilesRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()