Class InterconnectLocationsClient (1.24.0)

Version 1.24.0

• 1.64.0 (latest)
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public class InterconnectLocationsClient implements BackgroundResource

Service Description: The InterconnectLocations 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 (InterconnectLocationsClient interconnectLocationsClient =
     InterconnectLocationsClient.create()) {
   String project = "project-309310695";
   String interconnectLocation = "interconnectLocation220117603";
   InterconnectLocation response =
       interconnectLocationsClient.get(project, interconnectLocation);
 }
 

Note: close() needs to be called on the InterconnectLocationsClient 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 InterconnectLocationsSettings 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
 InterconnectLocationsSettings interconnectLocationsSettings =
     InterconnectLocationsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 InterconnectLocationsClient interconnectLocationsClient =
     InterconnectLocationsClient.create(interconnectLocationsSettings);
 

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
 InterconnectLocationsSettings interconnectLocationsSettings =
     InterconnectLocationsSettings.newBuilder().setEndpoint(myEndpoint).build();
 InterconnectLocationsClient interconnectLocationsClient =
     InterconnectLocationsClient.create(interconnectLocationsSettings);
 

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

Inheritance

java.lang.Object > InterconnectLocationsClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final InterconnectLocationsClient create()

Constructs an instance of InterconnectLocationsClient with default settings.

Returns
Type	Description
InterconnectLocationsClient

Exceptions
Type	Description
IOException

create(InterconnectLocationsSettings settings)

public static final InterconnectLocationsClient create(InterconnectLocationsSettings settings)

Constructs an instance of InterconnectLocationsClient, 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	InterconnectLocationsSettings

Returns
Type	Description
InterconnectLocationsClient

Exceptions
Type	Description
IOException

create(InterconnectLocationsStub stub)

public static final InterconnectLocationsClient create(InterconnectLocationsStub stub)

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

Parameter
Name	Description
stub	InterconnectLocationsStub

Returns
Type	Description
InterconnectLocationsClient

Constructors

InterconnectLocationsClient(InterconnectLocationsSettings settings)

protected InterconnectLocationsClient(InterconnectLocationsSettings settings)

Constructs an instance of InterconnectLocationsClient, 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	InterconnectLocationsSettings

InterconnectLocationsClient(InterconnectLocationsStub stub)

protected InterconnectLocationsClient(InterconnectLocationsStub stub)

Parameter
Name	Description
stub	InterconnectLocationsStub

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

public final InterconnectLocation get(GetInterconnectLocationRequest request)

Returns the details for the specified interconnect location. Gets a list of available interconnect 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 (InterconnectLocationsClient interconnectLocationsClient =
     InterconnectLocationsClient.create()) {
   GetInterconnectLocationRequest request =
       GetInterconnectLocationRequest.newBuilder()
           .setInterconnectLocation("interconnectLocation220117603")
           .setProject("project-309310695")
           .build();
   InterconnectLocation response = interconnectLocationsClient.get(request);
 }
 

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

Returns
Type	Description
InterconnectLocation

get(String project, String interconnectLocation)

public final InterconnectLocation get(String project, String interconnectLocation)

Returns the details for the specified interconnect location. Gets a list of available interconnect 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 (InterconnectLocationsClient interconnectLocationsClient =
     InterconnectLocationsClient.create()) {
   String project = "project-309310695";
   String interconnectLocation = "interconnectLocation220117603";
   InterconnectLocation response =
       interconnectLocationsClient.get(project, interconnectLocation);
 }
 

Parameters
Name	Description
project	String Project ID for this request.
interconnectLocation	String Name of the interconnect location to return.

Returns
Type	Description
InterconnectLocation

getCallable()

public final UnaryCallable<GetInterconnectLocationRequest,InterconnectLocation> getCallable()

Returns the details for the specified interconnect location. Gets a list of available interconnect 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 (InterconnectLocationsClient interconnectLocationsClient =
     InterconnectLocationsClient.create()) {
   GetInterconnectLocationRequest request =
       GetInterconnectLocationRequest.newBuilder()
           .setInterconnectLocation("interconnectLocation220117603")
           .setProject("project-309310695")
           .build();
   ApiFuture<InterconnectLocation> future =
       interconnectLocationsClient.getCallable().futureCall(request);
   // Do something.
   InterconnectLocation response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<GetInterconnectLocationRequest,InterconnectLocation>

getSettings()

public final InterconnectLocationsSettings getSettings()

Returns
Type	Description
InterconnectLocationsSettings

getStub()

public InterconnectLocationsStub getStub()

Returns
Type	Description
InterconnectLocationsStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

list(ListInterconnectLocationsRequest request)

public final InterconnectLocationsClient.ListPagedResponse list(ListInterconnectLocationsRequest request)

Retrieves the list of interconnect 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 (InterconnectLocationsClient interconnectLocationsClient =
     InterconnectLocationsClient.create()) {
   ListInterconnectLocationsRequest request =
       ListInterconnectLocationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (InterconnectLocation element : interconnectLocationsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

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

Returns
Type	Description
InterconnectLocationsClient.ListPagedResponse

list(String project)

public final InterconnectLocationsClient.ListPagedResponse list(String project)

Retrieves the list of interconnect 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 (InterconnectLocationsClient interconnectLocationsClient =
     InterconnectLocationsClient.create()) {
   String project = "project-309310695";
   for (InterconnectLocation element : interconnectLocationsClient.list(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter
Name	Description
project	String Project ID for this request.

Returns
Type	Description
InterconnectLocationsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListInterconnectLocationsRequest,InterconnectLocationList> listCallable()

Retrieves the list of interconnect 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 (InterconnectLocationsClient interconnectLocationsClient =
     InterconnectLocationsClient.create()) {
   ListInterconnectLocationsRequest request =
       ListInterconnectLocationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     InterconnectLocationList response =
         interconnectLocationsClient.listCallable().call(request);
     for (InterconnectLocation 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<ListInterconnectLocationsRequest,InterconnectLocationList>

listPagedCallable()

public final UnaryCallable<ListInterconnectLocationsRequest,InterconnectLocationsClient.ListPagedResponse> listPagedCallable()

Retrieves the list of interconnect 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 (InterconnectLocationsClient interconnectLocationsClient =
     InterconnectLocationsClient.create()) {
   ListInterconnectLocationsRequest request =
       ListInterconnectLocationsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<InterconnectLocation> future =
       interconnectLocationsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (InterconnectLocation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns
Type	Description
UnaryCallable<ListInterconnectLocationsRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()