Class NetworkServiceClient (0.11.0)

Version 0.11.0

• 0.12.0 (latest)
• 0.11.0
• 0.10.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

GitHub Repository

Product Reference

Service Description: Provides methods for handling Network objects.

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 (NetworkServiceClient networkServiceClient = NetworkServiceClient.create()) {
   NetworkName name = NetworkName.of("[NETWORK_CODE]");
   Network response = networkServiceClient.getNetwork(name);
 }
 

Note: close() needs to be called on the NetworkServiceClient 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
GetNetwork	API to retrieve a Network object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getNetwork(GetNetworkRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getNetwork(NetworkName name) getNetwork(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getNetworkCallable()
ListNetworks	API to retrieve all the networks the current user has access to.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listNetworks(ListNetworksRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listNetworksCallable()

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 NetworkServiceSettings 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
 NetworkServiceSettings networkServiceSettings =
     NetworkServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 NetworkServiceClient networkServiceClient = NetworkServiceClient.create(networkServiceSettings);
 

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
 NetworkServiceSettings networkServiceSettings =
     NetworkServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 NetworkServiceClient networkServiceClient = NetworkServiceClient.create(networkServiceSettings);
 

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

Inheritance

java.lang.Object > NetworkServiceClient

Static Methods

create()

public static final NetworkServiceClient create()

Constructs an instance of NetworkServiceClient with default settings.

Returns
Type	Description
NetworkServiceClient

Exceptions
Type	Description
IOException

create(NetworkServiceSettings settings)

public static final NetworkServiceClient create(NetworkServiceSettings settings)

Constructs an instance of NetworkServiceClient, 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	NetworkServiceSettings

Returns
Type	Description
NetworkServiceClient

Exceptions
Type	Description
IOException

create(NetworkServiceStub stub)

public static final NetworkServiceClient create(NetworkServiceStub stub)

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

Parameter
Name	Description
stub	NetworkServiceStub

Returns
Type	Description
NetworkServiceClient

Constructors

NetworkServiceClient(NetworkServiceSettings settings)

protected NetworkServiceClient(NetworkServiceSettings settings)

Constructs an instance of NetworkServiceClient, 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	NetworkServiceSettings

NetworkServiceClient(NetworkServiceStub stub)

protected NetworkServiceClient(NetworkServiceStub stub)

Parameter
Name	Description
stub	NetworkServiceStub

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

getNetwork(GetNetworkRequest request)

public final Network getNetwork(GetNetworkRequest request)

API to retrieve a Network object.

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 (NetworkServiceClient networkServiceClient = NetworkServiceClient.create()) {
   GetNetworkRequest request =
       GetNetworkRequest.newBuilder()
           .setName(NetworkName.of("[NETWORK_CODE]").toString())
           .build();
   Network response = networkServiceClient.getNetwork(request);
 }
 

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

Returns
Type	Description
Network

getNetwork(NetworkName name)

public final Network getNetwork(NetworkName name)

API to retrieve a Network object.

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 (NetworkServiceClient networkServiceClient = NetworkServiceClient.create()) {
   NetworkName name = NetworkName.of("[NETWORK_CODE]");
   Network response = networkServiceClient.getNetwork(name);
 }
 

Parameter
Name	Description
name	NetworkName Required. Resource name of Network. Format: networks/{network_code}

Returns
Type	Description
Network

getNetwork(String name)

public final Network getNetwork(String name)

API to retrieve a Network object.

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 (NetworkServiceClient networkServiceClient = NetworkServiceClient.create()) {
   String name = NetworkName.of("[NETWORK_CODE]").toString();
   Network response = networkServiceClient.getNetwork(name);
 }
 

Parameter
Name	Description
name	String Required. Resource name of Network. Format: networks/{network_code}

Returns
Type	Description
Network

getNetworkCallable()

public final UnaryCallable<GetNetworkRequest,Network> getNetworkCallable()

API to retrieve a Network object.

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 (NetworkServiceClient networkServiceClient = NetworkServiceClient.create()) {
   GetNetworkRequest request =
       GetNetworkRequest.newBuilder()
           .setName(NetworkName.of("[NETWORK_CODE]").toString())
           .build();
   ApiFuture<Network> future = networkServiceClient.getNetworkCallable().futureCall(request);
   // Do something.
   Network response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetNetworkRequest,Network>

getSettings()

public final NetworkServiceSettings getSettings()

Returns
Type	Description
NetworkServiceSettings

getStub()

public NetworkServiceStub getStub()

Returns
Type	Description
NetworkServiceStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

listNetworks(ListNetworksRequest request)

public final ListNetworksResponse listNetworks(ListNetworksRequest request)

API to retrieve all the networks the current user has access to.

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 (NetworkServiceClient networkServiceClient = NetworkServiceClient.create()) {
   ListNetworksRequest request = ListNetworksRequest.newBuilder().build();
   ListNetworksResponse response = networkServiceClient.listNetworks(request);
 }
 

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

Returns
Type	Description
ListNetworksResponse

listNetworksCallable()

public final UnaryCallable<ListNetworksRequest,ListNetworksResponse> listNetworksCallable()

API to retrieve all the networks the current user has access to.

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 (NetworkServiceClient networkServiceClient = NetworkServiceClient.create()) {
   ListNetworksRequest request = ListNetworksRequest.newBuilder().build();
   ApiFuture<ListNetworksResponse> future =
       networkServiceClient.listNetworksCallable().futureCall(request);
   // Do something.
   ListNetworksResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<ListNetworksRequest,ListNetworksResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()