NetworkProfilesClient (Google Compute Engine 1.78.0 API)

java.lang.Object
- com.google.cloud.compute.v1.NetworkProfilesClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class NetworkProfilesClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`NetworkProfilesClient.ListFixedSizeCollection`
`static class`	`NetworkProfilesClient.ListPage`
`static class`	`NetworkProfilesClient.ListPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`NetworkProfilesClient(NetworkProfilesSettings settings)` Constructs an instance of NetworkProfilesClient, using the given settings.
`protected`	`NetworkProfilesClient(NetworkProfilesStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static NetworkProfilesClient`	`create()` Constructs an instance of NetworkProfilesClient with default settings.
`static NetworkProfilesClient`	`create(NetworkProfilesSettings settings)` Constructs an instance of NetworkProfilesClient, using the given settings.
`static NetworkProfilesClient`	`create(NetworkProfilesStub stub)` Constructs an instance of NetworkProfilesClient, using the given stub for making calls.
`NetworkProfile`	`get(GetNetworkProfileRequest request)` Returns the specified network profile.
`NetworkProfile`	`get(String project, String networkProfile)` Returns the specified network profile.
`com.google.api.gax.rpc.UnaryCallable<GetNetworkProfileRequest,NetworkProfile>`	`getCallable()` Returns the specified network profile.
`NetworkProfilesSettings`	`getSettings()`
`NetworkProfilesStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`NetworkProfilesClient.ListPagedResponse`	`list(ListNetworkProfilesRequest request)` Retrieves a list of network profiles available to the specified project.
`NetworkProfilesClient.ListPagedResponse`	`list(String project)` Retrieves a list of network profiles available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListNetworkProfilesRequest,NetworkProfilesListResponse>`	`listCallable()` Retrieves a list of network profiles available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListNetworkProfilesRequest,NetworkProfilesClient.ListPagedResponse>`	`listPagedCallable()` Retrieves a list of network profiles available to the specified project.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- NetworkProfilesClient
```
protected NetworkProfilesClient(NetworkProfilesSettings settings)
                         throws IOException
```
  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.
  
  Throws:
  
  IOException
- NetworkProfilesClient
```
protected NetworkProfilesClient(NetworkProfilesStub stub)
```

Method Detail

create

public static final NetworkProfilesClient create()
                                          throws IOException

Constructs an instance of NetworkProfilesClient with default settings.

Throws:: IOException

create
```
public static final NetworkProfilesClient create(NetworkProfilesSettings settings)
                                          throws IOException
```
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.

Throws:

IOException

create
```
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).

getSettings

public final NetworkProfilesSettings getSettings()

getStub
```
public NetworkProfilesStub getStub()
```

get

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:: project - Project ID for this request.; networkProfile - Name of the network profile to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

get

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);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getCallable

public final com.google.api.gax.rpc.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();
 }

list

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);
   }
 }

Parameters:: project - Project ID for this request.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

list

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);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listPagedCallable

public final com.google.api.gax.rpc.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);
   }
 }

listCallable

public final com.google.api.gax.rpc.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;
     }
   }
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class NetworkProfilesClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NetworkProfilesClient

NetworkProfilesClient

Method Detail

create

create

create

getSettings

getStub

get

get

getCallable

list

list

listPagedCallable

listCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination