Class InterconnectRemoteLocationsClient (1.65.0)

GitHub RepositoryProduct Reference

Service Description: The InterconnectRemoteLocations 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 (InterconnectRemoteLocationsClient interconnectRemoteLocationsClient =
     InterconnectRemoteLocationsClient.create()) {
   String project = "project-309310695";
   String interconnectRemoteLocation = "interconnectRemoteLocation-993839543";
   InterconnectRemoteLocation response =
       interconnectRemoteLocationsClient.get(project, interconnectRemoteLocation);
 }

Note: close() needs to be called on the InterconnectRemoteLocationsClient 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 details for the specified interconnect remote location. Gets a list of available interconnect remote locations by making a list() request.

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

  • get(GetInterconnectRemoteLocationRequest 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 interconnectRemoteLocation)

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 the list of interconnect remote locations available to the specified project.

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

  • list(ListInterconnectRemoteLocationsRequest 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 InterconnectRemoteLocationsSettings 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
 InterconnectRemoteLocationsSettings interconnectRemoteLocationsSettings =
     InterconnectRemoteLocationsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 InterconnectRemoteLocationsClient interconnectRemoteLocationsClient =
     InterconnectRemoteLocationsClient.create(interconnectRemoteLocationsSettings);

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
 InterconnectRemoteLocationsSettings interconnectRemoteLocationsSettings =
     InterconnectRemoteLocationsSettings.newBuilder().setEndpoint(myEndpoint).build();
 InterconnectRemoteLocationsClient interconnectRemoteLocationsClient =
     InterconnectRemoteLocationsClient.create(interconnectRemoteLocationsSettings);

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

Inheritance

java.lang.Object > InterconnectRemoteLocationsClient

Static Methods

create()

public static final InterconnectRemoteLocationsClient create()

Constructs an instance of InterconnectRemoteLocationsClient with default settings.

Returns
Type Description
InterconnectRemoteLocationsClient
Exceptions
Type Description
IOException

create(InterconnectRemoteLocationsSettings settings)

public static final InterconnectRemoteLocationsClient create(InterconnectRemoteLocationsSettings settings)

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

create(InterconnectRemoteLocationsStub stub)

public static final InterconnectRemoteLocationsClient create(InterconnectRemoteLocationsStub stub)

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

Parameter
Name Description
stub InterconnectRemoteLocationsStub
Returns
Type Description
InterconnectRemoteLocationsClient

Constructors

InterconnectRemoteLocationsClient(InterconnectRemoteLocationsSettings settings)

protected InterconnectRemoteLocationsClient(InterconnectRemoteLocationsSettings settings)

Constructs an instance of InterconnectRemoteLocationsClient, 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 InterconnectRemoteLocationsSettings

InterconnectRemoteLocationsClient(InterconnectRemoteLocationsStub stub)

protected InterconnectRemoteLocationsClient(InterconnectRemoteLocationsStub stub)
Parameter
Name Description
stub InterconnectRemoteLocationsStub

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

public final InterconnectRemoteLocation get(GetInterconnectRemoteLocationRequest request)

Returns the details for the specified interconnect remote location. Gets a list of available interconnect remote locations by making a list() request.

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 (InterconnectRemoteLocationsClient interconnectRemoteLocationsClient =
     InterconnectRemoteLocationsClient.create()) {
   GetInterconnectRemoteLocationRequest request =
       GetInterconnectRemoteLocationRequest.newBuilder()
           .setInterconnectRemoteLocation("interconnectRemoteLocation-993839543")
           .setProject("project-309310695")
           .build();
   InterconnectRemoteLocation response = interconnectRemoteLocationsClient.get(request);
 }
Parameter
Name Description
request GetInterconnectRemoteLocationRequest

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

get(String project, String interconnectRemoteLocation)

public final InterconnectRemoteLocation get(String project, String interconnectRemoteLocation)

Returns the details for the specified interconnect remote location. Gets a list of available interconnect remote locations by making a list() request.

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 (InterconnectRemoteLocationsClient interconnectRemoteLocationsClient =
     InterconnectRemoteLocationsClient.create()) {
   String project = "project-309310695";
   String interconnectRemoteLocation = "interconnectRemoteLocation-993839543";
   InterconnectRemoteLocation response =
       interconnectRemoteLocationsClient.get(project, interconnectRemoteLocation);
 }
Parameters
Name Description
project String

Project ID for this request.
interconnectRemoteLocation String

Name of the interconnect remote location to return.
Returns
Type Description
InterconnectRemoteLocation

getCallable()

public final UnaryCallable<GetInterconnectRemoteLocationRequest,InterconnectRemoteLocation> getCallable()

Returns the details for the specified interconnect remote location. Gets a list of available interconnect remote locations by making a list() request.

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 (InterconnectRemoteLocationsClient interconnectRemoteLocationsClient =
     InterconnectRemoteLocationsClient.create()) {
   GetInterconnectRemoteLocationRequest request =
       GetInterconnectRemoteLocationRequest.newBuilder()
           .setInterconnectRemoteLocation("interconnectRemoteLocation-993839543")
           .setProject("project-309310695")
           .build();
   ApiFuture<InterconnectRemoteLocation> future =
       interconnectRemoteLocationsClient.getCallable().futureCall(request);
   // Do something.
   InterconnectRemoteLocation response = future.get();
 }
Returns
Type Description
UnaryCallable<GetInterconnectRemoteLocationRequest,InterconnectRemoteLocation>

getSettings()

public final InterconnectRemoteLocationsSettings getSettings()
Returns
Type Description
InterconnectRemoteLocationsSettings

getStub()

public InterconnectRemoteLocationsStub getStub()
Returns
Type Description
InterconnectRemoteLocationsStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListInterconnectRemoteLocationsRequest request)

public final InterconnectRemoteLocationsClient.ListPagedResponse list(ListInterconnectRemoteLocationsRequest request)

Retrieves the list of interconnect remote locations 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 (InterconnectRemoteLocationsClient interconnectRemoteLocationsClient =
     InterconnectRemoteLocationsClient.create()) {
   ListInterconnectRemoteLocationsRequest request =
       ListInterconnectRemoteLocationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (InterconnectRemoteLocation element :
       interconnectRemoteLocationsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListInterconnectRemoteLocationsRequest

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

list(String project)

public final InterconnectRemoteLocationsClient.ListPagedResponse list(String project)

Retrieves the list of interconnect remote locations 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 (InterconnectRemoteLocationsClient interconnectRemoteLocationsClient =
     InterconnectRemoteLocationsClient.create()) {
   String project = "project-309310695";
   for (InterconnectRemoteLocation element :
       interconnectRemoteLocationsClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

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

listCallable()

public final UnaryCallable<ListInterconnectRemoteLocationsRequest,InterconnectRemoteLocationList> listCallable()

Retrieves the list of interconnect remote locations 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 (InterconnectRemoteLocationsClient interconnectRemoteLocationsClient =
     InterconnectRemoteLocationsClient.create()) {
   ListInterconnectRemoteLocationsRequest request =
       ListInterconnectRemoteLocationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     InterconnectRemoteLocationList response =
         interconnectRemoteLocationsClient.listCallable().call(request);
     for (InterconnectRemoteLocation 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<ListInterconnectRemoteLocationsRequest,InterconnectRemoteLocationList>

listPagedCallable()

public final UnaryCallable<ListInterconnectRemoteLocationsRequest,InterconnectRemoteLocationsClient.ListPagedResponse> listPagedCallable()

Retrieves the list of interconnect remote locations 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 (InterconnectRemoteLocationsClient interconnectRemoteLocationsClient =
     InterconnectRemoteLocationsClient.create()) {
   ListInterconnectRemoteLocationsRequest request =
       ListInterconnectRemoteLocationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<InterconnectRemoteLocation> future =
       interconnectRemoteLocationsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (InterconnectRemoteLocation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListInterconnectRemoteLocationsRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()