Class BandwidthGroupServiceClient (0.27.0)

Service Description: Provides methods for handling BandwidthGroup 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 (BandwidthGroupServiceClient bandwidthGroupServiceClient =
     BandwidthGroupServiceClient.create()) {
   BandwidthGroupName name = BandwidthGroupName.of("[NETWORK_CODE]", "[BANDWIDTH_GROUP]");
   BandwidthGroup response = bandwidthGroupServiceClient.getBandwidthGroup(name);
 }

Note: close() needs to be called on the BandwidthGroupServiceClient 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
GetBandwidthGroup	API to retrieve a `BandwidthGroup` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getBandwidthGroup(GetBandwidthGroupRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getBandwidthGroup(BandwidthGroupName name) getBandwidthGroup(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. getBandwidthGroupCallable()
ListBandwidthGroups	API to retrieve a list of `BandwidthGroup` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listBandwidthGroups(ListBandwidthGroupsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listBandwidthGroups(NetworkName parent) listBandwidthGroups(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. listBandwidthGroupsPagedCallable() listBandwidthGroupsCallable()

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 BandwidthGroupServiceSettings 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
 BandwidthGroupServiceSettings bandwidthGroupServiceSettings =
     BandwidthGroupServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 BandwidthGroupServiceClient bandwidthGroupServiceClient =
     BandwidthGroupServiceClient.create(bandwidthGroupServiceSettings);

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
 BandwidthGroupServiceSettings bandwidthGroupServiceSettings =
     BandwidthGroupServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 BandwidthGroupServiceClient bandwidthGroupServiceClient =
     BandwidthGroupServiceClient.create(bandwidthGroupServiceSettings);

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

Inheritance

java.lang.Object > BandwidthGroupServiceClient

Static Methods

create()

public static final BandwidthGroupServiceClient create()

Constructs an instance of BandwidthGroupServiceClient with default settings.

Returns
Type	Description
`BandwidthGroupServiceClient`

Exceptions
Type	Description
`IOException`

create(BandwidthGroupServiceSettings settings)

public static final BandwidthGroupServiceClient create(BandwidthGroupServiceSettings settings)

Constructs an instance of BandwidthGroupServiceClient, 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`	`BandwidthGroupServiceSettings`

Returns
Type	Description
`BandwidthGroupServiceClient`

Exceptions
Type	Description
`IOException`

create(BandwidthGroupServiceStub stub)

public static final BandwidthGroupServiceClient create(BandwidthGroupServiceStub stub)

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

Parameter
Name	Description
`stub`	`BandwidthGroupServiceStub`

Returns
Type	Description
`BandwidthGroupServiceClient`

Constructors

BandwidthGroupServiceClient(BandwidthGroupServiceSettings settings)

protected BandwidthGroupServiceClient(BandwidthGroupServiceSettings settings)

Constructs an instance of BandwidthGroupServiceClient, 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`	`BandwidthGroupServiceSettings`

BandwidthGroupServiceClient(BandwidthGroupServiceStub stub)

protected BandwidthGroupServiceClient(BandwidthGroupServiceStub stub)

Parameter
Name	Description
`stub`	`BandwidthGroupServiceStub`

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

getBandwidthGroup(BandwidthGroupName name)

public final BandwidthGroup getBandwidthGroup(BandwidthGroupName name)

API to retrieve a BandwidthGroup 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 (BandwidthGroupServiceClient bandwidthGroupServiceClient =
     BandwidthGroupServiceClient.create()) {
   BandwidthGroupName name = BandwidthGroupName.of("[NETWORK_CODE]", "[BANDWIDTH_GROUP]");
   BandwidthGroup response = bandwidthGroupServiceClient.getBandwidthGroup(name);
 }

Parameter
Name	Description
`name`	`BandwidthGroupName` Required. The resource name of the BandwidthGroup. Format: `networks/{network_code}/bandwidthGroups/{bandwidth_group_id}`

Returns
Type	Description
`BandwidthGroup`

getBandwidthGroup(GetBandwidthGroupRequest request)

public final BandwidthGroup getBandwidthGroup(GetBandwidthGroupRequest request)

API to retrieve a BandwidthGroup 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 (BandwidthGroupServiceClient bandwidthGroupServiceClient =
     BandwidthGroupServiceClient.create()) {
   GetBandwidthGroupRequest request =
       GetBandwidthGroupRequest.newBuilder()
           .setName(BandwidthGroupName.of("[NETWORK_CODE]", "[BANDWIDTH_GROUP]").toString())
           .build();
   BandwidthGroup response = bandwidthGroupServiceClient.getBandwidthGroup(request);
 }

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

Returns
Type	Description
`BandwidthGroup`

getBandwidthGroup(String name)

public final BandwidthGroup getBandwidthGroup(String name)

API to retrieve a BandwidthGroup 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 (BandwidthGroupServiceClient bandwidthGroupServiceClient =
     BandwidthGroupServiceClient.create()) {
   String name = BandwidthGroupName.of("[NETWORK_CODE]", "[BANDWIDTH_GROUP]").toString();
   BandwidthGroup response = bandwidthGroupServiceClient.getBandwidthGroup(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the BandwidthGroup. Format: `networks/{network_code}/bandwidthGroups/{bandwidth_group_id}`

Returns
Type	Description
`BandwidthGroup`

getBandwidthGroupCallable()

public final UnaryCallable<GetBandwidthGroupRequest,BandwidthGroup> getBandwidthGroupCallable()

API to retrieve a BandwidthGroup 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 (BandwidthGroupServiceClient bandwidthGroupServiceClient =
     BandwidthGroupServiceClient.create()) {
   GetBandwidthGroupRequest request =
       GetBandwidthGroupRequest.newBuilder()
           .setName(BandwidthGroupName.of("[NETWORK_CODE]", "[BANDWIDTH_GROUP]").toString())
           .build();
   ApiFuture<BandwidthGroup> future =
       bandwidthGroupServiceClient.getBandwidthGroupCallable().futureCall(request);
   // Do something.
   BandwidthGroup response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetBandwidthGroupRequest,BandwidthGroup>`

getSettings()

public final BandwidthGroupServiceSettings getSettings()

Returns
Type	Description
`BandwidthGroupServiceSettings`

getStub()

public BandwidthGroupServiceStub getStub()

Returns
Type	Description
`BandwidthGroupServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listBandwidthGroups(ListBandwidthGroupsRequest request)

public final BandwidthGroupServiceClient.ListBandwidthGroupsPagedResponse listBandwidthGroups(ListBandwidthGroupsRequest request)

API to retrieve a list of BandwidthGroup objects.

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 (BandwidthGroupServiceClient bandwidthGroupServiceClient =
     BandwidthGroupServiceClient.create()) {
   ListBandwidthGroupsRequest request =
       ListBandwidthGroupsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   for (BandwidthGroup element :
       bandwidthGroupServiceClient.listBandwidthGroups(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

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

Returns
Type	Description
`BandwidthGroupServiceClient.ListBandwidthGroupsPagedResponse`

listBandwidthGroups(NetworkName parent)

public final BandwidthGroupServiceClient.ListBandwidthGroupsPagedResponse listBandwidthGroups(NetworkName parent)

API to retrieve a list of BandwidthGroup objects.

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 (BandwidthGroupServiceClient bandwidthGroupServiceClient =
     BandwidthGroupServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   for (BandwidthGroup element :
       bandwidthGroupServiceClient.listBandwidthGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`NetworkName` Required. The parent, which owns this collection of BandwidthGroups. Format: `networks/{network_code}`

Returns
Type	Description
`BandwidthGroupServiceClient.ListBandwidthGroupsPagedResponse`

listBandwidthGroups(String parent)

public final BandwidthGroupServiceClient.ListBandwidthGroupsPagedResponse listBandwidthGroups(String parent)

API to retrieve a list of BandwidthGroup objects.

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 (BandwidthGroupServiceClient bandwidthGroupServiceClient =
     BandwidthGroupServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   for (BandwidthGroup element :
       bandwidthGroupServiceClient.listBandwidthGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of BandwidthGroups. Format: `networks/{network_code}`

Returns
Type	Description
`BandwidthGroupServiceClient.ListBandwidthGroupsPagedResponse`

listBandwidthGroupsCallable()

public final UnaryCallable<ListBandwidthGroupsRequest,ListBandwidthGroupsResponse> listBandwidthGroupsCallable()

API to retrieve a list of BandwidthGroup objects.

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 (BandwidthGroupServiceClient bandwidthGroupServiceClient =
     BandwidthGroupServiceClient.create()) {
   ListBandwidthGroupsRequest request =
       ListBandwidthGroupsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   while (true) {
     ListBandwidthGroupsResponse response =
         bandwidthGroupServiceClient.listBandwidthGroupsCallable().call(request);
     for (BandwidthGroup element : response.getBandwidthGroupsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListBandwidthGroupsRequest,ListBandwidthGroupsResponse>`

listBandwidthGroupsPagedCallable()

public final UnaryCallable<ListBandwidthGroupsRequest,BandwidthGroupServiceClient.ListBandwidthGroupsPagedResponse> listBandwidthGroupsPagedCallable()

API to retrieve a list of BandwidthGroup objects.

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 (BandwidthGroupServiceClient bandwidthGroupServiceClient =
     BandwidthGroupServiceClient.create()) {
   ListBandwidthGroupsRequest request =
       ListBandwidthGroupsRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   ApiFuture<BandwidthGroup> future =
       bandwidthGroupServiceClient.listBandwidthGroupsPagedCallable().futureCall(request);
   // Do something.
   for (BandwidthGroup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListBandwidthGroupsRequest,ListBandwidthGroupsPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

Class BandwidthGroupServiceClient (0.27.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Static Methods

create()

create(BandwidthGroupServiceSettings settings)

create(BandwidthGroupServiceStub stub)

Constructors

BandwidthGroupServiceClient(BandwidthGroupServiceSettings settings)

BandwidthGroupServiceClient(BandwidthGroupServiceStub stub)

Methods

awaitTermination(long duration, TimeUnit unit)

close()

getBandwidthGroup(BandwidthGroupName name)

getBandwidthGroup(GetBandwidthGroupRequest request)

getBandwidthGroup(String name)

getBandwidthGroupCallable()

getSettings()

getStub()

isShutdown()

isTerminated()

listBandwidthGroups(ListBandwidthGroupsRequest request)

listBandwidthGroups(NetworkName parent)

listBandwidthGroups(String parent)

listBandwidthGroupsCallable()

listBandwidthGroupsPagedCallable()

shutdown()

shutdownNow()

Class BandwidthGroupServiceClient (0.27.0)