com.google.cloud.compute.v1

Class InterconnectLocationClient

java.lang.Object

com.google.cloud.compute.v1.InterconnectLocationClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class InterconnectLocationClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Creates and runs virtual machines on Google Cloud Platform.

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:

 
 try (InterconnectLocationClient interconnectLocationClient = InterconnectLocationClient.create()) {
   ProjectGlobalInterconnectLocationName interconnectLocation = ProjectGlobalInterconnectLocationName.of("[PROJECT]", "[INTERCONNECT_LOCATION]");
   InterconnectLocation response = interconnectLocationClient.getInterconnectLocation(interconnectLocation);
 }
 
 

Note: close() needs to be called on the interconnectLocationClient 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 InterconnectLocationSettings to create(). For example:

To customize credentials:

 
 InterconnectLocationSettings interconnectLocationSettings =
     InterconnectLocationSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 InterconnectLocationClient interconnectLocationClient =
     InterconnectLocationClient.create(interconnectLocationSettings);
 
 

To customize the endpoint:

 
 InterconnectLocationSettings interconnectLocationSettings =
     InterconnectLocationSettings.newBuilder().setEndpoint(myEndpoint).build();
 InterconnectLocationClient interconnectLocationClient =
     InterconnectLocationClient.create(interconnectLocationSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InterconnectLocationClient.ListInterconnectLocationsFixedSizeCollection
static class	InterconnectLocationClient.ListInterconnectLocationsPage
static class	InterconnectLocationClient.ListInterconnectLocationsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InterconnectLocationClient(InterconnectLocationSettings settings) Constructs an instance of InterconnectLocationClient, using the given settings.
protected	InterconnectLocationClient(InterconnectLocationStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static InterconnectLocationClient	create() Constructs an instance of InterconnectLocationClient with default settings.
static InterconnectLocationClient	create(InterconnectLocationSettings settings) Constructs an instance of InterconnectLocationClient, using the given settings.
static InterconnectLocationClient	create(InterconnectLocationStub stub) Constructs an instance of InterconnectLocationClient, using the given stub for making calls.
InterconnectLocation	getInterconnectLocation(GetInterconnectLocationHttpRequest request) Returns the details for the specified interconnect location.
InterconnectLocation	getInterconnectLocation(ProjectGlobalInterconnectLocationName interconnectLocation) Returns the details for the specified interconnect location.
InterconnectLocation	getInterconnectLocation(String interconnectLocation) Returns the details for the specified interconnect location.
com.google.api.gax.rpc.UnaryCallable<GetInterconnectLocationHttpRequest,InterconnectLocation>	getInterconnectLocationCallable() Returns the details for the specified interconnect location.
InterconnectLocationSettings	getSettings()
InterconnectLocationStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
InterconnectLocationClient.ListInterconnectLocationsPagedResponse	listInterconnectLocations(ListInterconnectLocationsHttpRequest request) Retrieves the list of interconnect locations available to the specified project.
InterconnectLocationClient.ListInterconnectLocationsPagedResponse	listInterconnectLocations(ProjectName project) Retrieves the list of interconnect locations available to the specified project.
InterconnectLocationClient.ListInterconnectLocationsPagedResponse	listInterconnectLocations(String project) Retrieves the list of interconnect locations available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListInterconnectLocationsHttpRequest,InterconnectLocationList>	listInterconnectLocationsCallable() Retrieves the list of interconnect locations available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListInterconnectLocationsHttpRequest,InterconnectLocationClient.ListInterconnectLocationsPagedResponse>	listInterconnectLocationsPagedCallable() Retrieves the list of interconnect locations available to the specified project.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InterconnectLocationClient

protected InterconnectLocationClient(InterconnectLocationSettings settings)
                              throws IOException

Constructs an instance of InterconnectLocationClient, 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.

Throws:

IOException

InterconnectLocationClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected InterconnectLocationClient(InterconnectLocationStub stub)

Method Detail

create

public static final InterconnectLocationClient create()
                                               throws IOException

Constructs an instance of InterconnectLocationClient with default settings.

Throws:

IOException

create

public static final InterconnectLocationClient create(InterconnectLocationSettings settings)
                                               throws IOException

Constructs an instance of InterconnectLocationClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final InterconnectLocationClient create(InterconnectLocationStub stub)

Constructs an instance of InterconnectLocationClient, using the given stub for making calls. This is for advanced usage - prefer to use InterconnectLocationSettings}.

getSettings

public final InterconnectLocationSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public InterconnectLocationStub getStub()

getInterconnectLocation

@BetaApi
public final InterconnectLocation getInterconnectLocation(ProjectGlobalInterconnectLocationName interconnectLocation)

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

Sample code:

 try (InterconnectLocationClient interconnectLocationClient = InterconnectLocationClient.create()) {
   ProjectGlobalInterconnectLocationName interconnectLocation = ProjectGlobalInterconnectLocationName.of("[PROJECT]", "[INTERCONNECT_LOCATION]");
   InterconnectLocation response = interconnectLocationClient.getInterconnectLocation(interconnectLocation);
 }
 

Parameters:

interconnectLocation - Name of the interconnect location to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getInterconnectLocation

@BetaApi
public final InterconnectLocation getInterconnectLocation(String interconnectLocation)

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

Sample code:

 try (InterconnectLocationClient interconnectLocationClient = InterconnectLocationClient.create()) {
   ProjectGlobalInterconnectLocationName interconnectLocation = ProjectGlobalInterconnectLocationName.of("[PROJECT]", "[INTERCONNECT_LOCATION]");
   InterconnectLocation response = interconnectLocationClient.getInterconnectLocation(interconnectLocation.toString());
 }
 

Parameters:

interconnectLocation - Name of the interconnect location to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getInterconnectLocation

@BetaApi
public final InterconnectLocation getInterconnectLocation(GetInterconnectLocationHttpRequest request)

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

Sample code:

 try (InterconnectLocationClient interconnectLocationClient = InterconnectLocationClient.create()) {
   String formattedInterconnectLocation = ProjectGlobalInterconnectLocationName.format("[PROJECT]", "[INTERCONNECT_LOCATION]");
   GetInterconnectLocationHttpRequest request = GetInterconnectLocationHttpRequest.newBuilder()
     .setInterconnectLocation(formattedInterconnectLocation)
     .build();
   InterconnectLocation response = interconnectLocationClient.getInterconnectLocation(request);
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getInterconnectLocationCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetInterconnectLocationHttpRequest,InterconnectLocation> getInterconnectLocationCallable()

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

Sample code:

 try (InterconnectLocationClient interconnectLocationClient = InterconnectLocationClient.create()) {
   String formattedInterconnectLocation = ProjectGlobalInterconnectLocationName.format("[PROJECT]", "[INTERCONNECT_LOCATION]");
   GetInterconnectLocationHttpRequest request = GetInterconnectLocationHttpRequest.newBuilder()
     .setInterconnectLocation(formattedInterconnectLocation)
     .build();
   ApiFuture<InterconnectLocation> future = interconnectLocationClient.getInterconnectLocationCallable().futureCall(request);
   // Do something
   InterconnectLocation response = future.get();
 }
 

listInterconnectLocations

@BetaApi
public final InterconnectLocationClient.ListInterconnectLocationsPagedResponse listInterconnectLocations(ProjectName project)

Retrieves the list of interconnect locations available to the specified project.

Sample code:

 try (InterconnectLocationClient interconnectLocationClient = InterconnectLocationClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (InterconnectLocation element : interconnectLocationClient.listInterconnectLocations(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listInterconnectLocations

@BetaApi
public final InterconnectLocationClient.ListInterconnectLocationsPagedResponse listInterconnectLocations(String project)

Retrieves the list of interconnect locations available to the specified project.

Sample code:

 try (InterconnectLocationClient interconnectLocationClient = InterconnectLocationClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (InterconnectLocation element : interconnectLocationClient.listInterconnectLocations(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listInterconnectLocations

@BetaApi
public final InterconnectLocationClient.ListInterconnectLocationsPagedResponse listInterconnectLocations(ListInterconnectLocationsHttpRequest request)

Retrieves the list of interconnect locations available to the specified project.

Sample code:

 try (InterconnectLocationClient interconnectLocationClient = InterconnectLocationClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListInterconnectLocationsHttpRequest request = ListInterconnectLocationsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (InterconnectLocation element : interconnectLocationClient.listInterconnectLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listInterconnectLocationsPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListInterconnectLocationsHttpRequest,InterconnectLocationClient.ListInterconnectLocationsPagedResponse> listInterconnectLocationsPagedCallable()

Retrieves the list of interconnect locations available to the specified project.

Sample code:

 try (InterconnectLocationClient interconnectLocationClient = InterconnectLocationClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListInterconnectLocationsHttpRequest request = ListInterconnectLocationsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListInterconnectLocationsPagedResponse> future = interconnectLocationClient.listInterconnectLocationsPagedCallable().futureCall(request);
   // Do something
   for (InterconnectLocation element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listInterconnectLocationsCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListInterconnectLocationsHttpRequest,InterconnectLocationList> listInterconnectLocationsCallable()

Retrieves the list of interconnect locations available to the specified project.

Sample code:

 try (InterconnectLocationClient interconnectLocationClient = InterconnectLocationClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListInterconnectLocationsHttpRequest request = ListInterconnectLocationsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     InterconnectLocationList response = interconnectLocationClient.listInterconnectLocationsCallable().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;
     }
   }
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException