Class InterconnectRemoteLocationsClient (1.33.0)

public class InterconnectRemoteLocationsClient implements BackgroundResource

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

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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

Implements

BackgroundResource

Static Methods

create()

public static final InterconnectRemoteLocationsClient create()

Constructs an instance of InterconnectRemoteLocationsClient with default settings.

Returns
TypeDescription
InterconnectRemoteLocationsClient
Exceptions
TypeDescription
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
NameDescription
settingsInterconnectRemoteLocationsSettings
Returns
TypeDescription
InterconnectRemoteLocationsClient
Exceptions
TypeDescription
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
NameDescription
stubInterconnectRemoteLocationsStub
Returns
TypeDescription
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
NameDescription
settingsInterconnectRemoteLocationsSettings

InterconnectRemoteLocationsClient(InterconnectRemoteLocationsStub stub)

protected InterconnectRemoteLocationsClient(InterconnectRemoteLocationsStub stub)
Parameter
NameDescription
stubInterconnectRemoteLocationsStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
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
NameDescription
requestGetInterconnectRemoteLocationRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
projectString

Project ID for this request.

interconnectRemoteLocationString

Name of the interconnect remote location to return.

Returns
TypeDescription
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
TypeDescription
UnaryCallable<GetInterconnectRemoteLocationRequest,InterconnectRemoteLocation>

getSettings()

public final InterconnectRemoteLocationsSettings getSettings()
Returns
TypeDescription
InterconnectRemoteLocationsSettings

getStub()

public InterconnectRemoteLocationsStub getStub()
Returns
TypeDescription
InterconnectRemoteLocationsStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
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
NameDescription
requestListInterconnectRemoteLocationsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
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
NameDescription
projectString

Project ID for this request.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
UnaryCallable<ListInterconnectRemoteLocationsRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()