com.google.cloud.compute.v1

Class InterconnectClient

java.lang.Object

com.google.cloud.compute.v1.InterconnectClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator")
 @BetaApi
public class InterconnectClient
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 (InterconnectClient interconnectClient = InterconnectClient.create()) {
   ProjectGlobalInterconnectName interconnect = ProjectGlobalInterconnectName.of("[PROJECT]", "[INTERCONNECT]");
   Operation response = interconnectClient.deleteInterconnect(interconnect);
 }
 
 

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

To customize credentials:

 
 InterconnectSettings interconnectSettings =
     InterconnectSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 InterconnectClient interconnectClient =
     InterconnectClient.create(interconnectSettings);
 
 

To customize the endpoint:

 
 InterconnectSettings interconnectSettings =
     InterconnectSettings.newBuilder().setEndpoint(myEndpoint).build();
 InterconnectClient interconnectClient =
     InterconnectClient.create(interconnectSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InterconnectClient.ListInterconnectsFixedSizeCollection
static class	InterconnectClient.ListInterconnectsPage
static class	InterconnectClient.ListInterconnectsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InterconnectClient(InterconnectSettings settings) Constructs an instance of InterconnectClient, using the given settings.
protected	InterconnectClient(InterconnectStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static InterconnectClient	create() Constructs an instance of InterconnectClient with default settings.
static InterconnectClient	create(InterconnectSettings settings) Constructs an instance of InterconnectClient, using the given settings.
static InterconnectClient	create(InterconnectStub stub) Constructs an instance of InterconnectClient, using the given stub for making calls.
Operation	deleteInterconnect(DeleteInterconnectHttpRequest request) Deletes the specified interconnect.
Operation	deleteInterconnect(ProjectGlobalInterconnectName interconnect) Deletes the specified interconnect.
Operation	deleteInterconnect(String interconnect) Deletes the specified interconnect.
com.google.api.gax.rpc.UnaryCallable<DeleteInterconnectHttpRequest,Operation>	deleteInterconnectCallable() Deletes the specified interconnect.
InterconnectsGetDiagnosticsResponse	getDiagnosticsInterconnect(GetDiagnosticsInterconnectHttpRequest request) Returns the interconnectDiagnostics for the specified interconnect.
InterconnectsGetDiagnosticsResponse	getDiagnosticsInterconnect(ProjectGlobalInterconnectName interconnect) Returns the interconnectDiagnostics for the specified interconnect.
InterconnectsGetDiagnosticsResponse	getDiagnosticsInterconnect(String interconnect) Returns the interconnectDiagnostics for the specified interconnect.
com.google.api.gax.rpc.UnaryCallable<GetDiagnosticsInterconnectHttpRequest,InterconnectsGetDiagnosticsResponse>	getDiagnosticsInterconnectCallable() Returns the interconnectDiagnostics for the specified interconnect.
Interconnect	getInterconnect(GetInterconnectHttpRequest request) Returns the specified interconnect.
Interconnect	getInterconnect(ProjectGlobalInterconnectName interconnect) Returns the specified interconnect.
Interconnect	getInterconnect(String interconnect) Returns the specified interconnect.
com.google.api.gax.rpc.UnaryCallable<GetInterconnectHttpRequest,Interconnect>	getInterconnectCallable() Returns the specified interconnect.
InterconnectSettings	getSettings()
InterconnectStub	getStub()
Operation	insertInterconnect(InsertInterconnectHttpRequest request) Creates a Interconnect in the specified project using the data included in the request.
Operation	insertInterconnect(ProjectName project, Interconnect interconnectResource) Creates a Interconnect in the specified project using the data included in the request.
Operation	insertInterconnect(String project, Interconnect interconnectResource) Creates a Interconnect in the specified project using the data included in the request.
com.google.api.gax.rpc.UnaryCallable<InsertInterconnectHttpRequest,Operation>	insertInterconnectCallable() Creates a Interconnect in the specified project using the data included in the request.
boolean	isShutdown()
boolean	isTerminated()
InterconnectClient.ListInterconnectsPagedResponse	listInterconnects(ListInterconnectsHttpRequest request) Retrieves the list of interconnect available to the specified project.
InterconnectClient.ListInterconnectsPagedResponse	listInterconnects(ProjectName project) Retrieves the list of interconnect available to the specified project.
InterconnectClient.ListInterconnectsPagedResponse	listInterconnects(String project) Retrieves the list of interconnect available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListInterconnectsHttpRequest,InterconnectList>	listInterconnectsCallable() Retrieves the list of interconnect available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListInterconnectsHttpRequest,InterconnectClient.ListInterconnectsPagedResponse>	listInterconnectsPagedCallable() Retrieves the list of interconnect available to the specified project.
Operation	patchInterconnect(PatchInterconnectHttpRequest request) Updates the specified interconnect with the data included in the request.
Operation	patchInterconnect(ProjectGlobalInterconnectName interconnect, Interconnect interconnectResource, List<String> fieldMask) Updates the specified interconnect with the data included in the request.
Operation	patchInterconnect(String interconnect, Interconnect interconnectResource, List<String> fieldMask) Updates the specified interconnect with the data included in the request.
com.google.api.gax.rpc.UnaryCallable<PatchInterconnectHttpRequest,Operation>	patchInterconnectCallable() Updates the specified interconnect with the data included in the request.
void	shutdown()
void	shutdownNow()

Methods inherited from class java.lang.Object

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

Constructor Detail

InterconnectClient

protected InterconnectClient(InterconnectSettings settings)
                      throws IOException

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

InterconnectClient

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

Method Detail

create

public static final InterconnectClient create()
                                       throws IOException

Constructs an instance of InterconnectClient with default settings.

Throws:

IOException

create

public static final InterconnectClient create(InterconnectSettings settings)
                                       throws IOException

Constructs an instance of InterconnectClient, 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 InterconnectClient create(InterconnectStub stub)

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

getSettings

public final InterconnectSettings getSettings()

getStub

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

deleteInterconnect

@BetaApi
public final Operation deleteInterconnect(ProjectGlobalInterconnectName interconnect)

Deletes the specified interconnect.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   ProjectGlobalInterconnectName interconnect = ProjectGlobalInterconnectName.of("[PROJECT]", "[INTERCONNECT]");
   Operation response = interconnectClient.deleteInterconnect(interconnect);
 }
 

Parameters:

interconnect - Name of the interconnect to delete.

Throws:

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

deleteInterconnect

@BetaApi
public final Operation deleteInterconnect(String interconnect)

Deletes the specified interconnect.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   ProjectGlobalInterconnectName interconnect = ProjectGlobalInterconnectName.of("[PROJECT]", "[INTERCONNECT]");
   Operation response = interconnectClient.deleteInterconnect(interconnect.toString());
 }
 

Parameters:

interconnect - Name of the interconnect to delete.

Throws:

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

deleteInterconnect

@BetaApi
public final Operation deleteInterconnect(DeleteInterconnectHttpRequest request)

Deletes the specified interconnect.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   String formattedInterconnect = ProjectGlobalInterconnectName.format("[PROJECT]", "[INTERCONNECT]");
   DeleteInterconnectHttpRequest request = DeleteInterconnectHttpRequest.newBuilder()
     .setInterconnect(formattedInterconnect)
     .build();
   Operation response = interconnectClient.deleteInterconnect(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

deleteInterconnectCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<DeleteInterconnectHttpRequest,Operation> deleteInterconnectCallable()

Deletes the specified interconnect.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   String formattedInterconnect = ProjectGlobalInterconnectName.format("[PROJECT]", "[INTERCONNECT]");
   DeleteInterconnectHttpRequest request = DeleteInterconnectHttpRequest.newBuilder()
     .setInterconnect(formattedInterconnect)
     .build();
   ApiFuture<Operation> future = interconnectClient.deleteInterconnectCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

getInterconnect

@BetaApi
public final Interconnect getInterconnect(ProjectGlobalInterconnectName interconnect)

Returns the specified interconnect. Get a list of available interconnects by making a list() request.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   ProjectGlobalInterconnectName interconnect = ProjectGlobalInterconnectName.of("[PROJECT]", "[INTERCONNECT]");
   Interconnect response = interconnectClient.getInterconnect(interconnect);
 }
 

Parameters:

interconnect - Name of the interconnect to return.

Throws:

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

getInterconnect

@BetaApi
public final Interconnect getInterconnect(String interconnect)

Returns the specified interconnect. Get a list of available interconnects by making a list() request.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   ProjectGlobalInterconnectName interconnect = ProjectGlobalInterconnectName.of("[PROJECT]", "[INTERCONNECT]");
   Interconnect response = interconnectClient.getInterconnect(interconnect.toString());
 }
 

Parameters:

interconnect - Name of the interconnect to return.

Throws:

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

getInterconnect

@BetaApi
public final Interconnect getInterconnect(GetInterconnectHttpRequest request)

Returns the specified interconnect. Get a list of available interconnects by making a list() request.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   String formattedInterconnect = ProjectGlobalInterconnectName.format("[PROJECT]", "[INTERCONNECT]");
   GetInterconnectHttpRequest request = GetInterconnectHttpRequest.newBuilder()
     .setInterconnect(formattedInterconnect)
     .build();
   Interconnect response = interconnectClient.getInterconnect(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

getInterconnectCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetInterconnectHttpRequest,Interconnect> getInterconnectCallable()

Returns the specified interconnect. Get a list of available interconnects by making a list() request.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   String formattedInterconnect = ProjectGlobalInterconnectName.format("[PROJECT]", "[INTERCONNECT]");
   GetInterconnectHttpRequest request = GetInterconnectHttpRequest.newBuilder()
     .setInterconnect(formattedInterconnect)
     .build();
   ApiFuture<Interconnect> future = interconnectClient.getInterconnectCallable().futureCall(request);
   // Do something
   Interconnect response = future.get();
 }
 

getDiagnosticsInterconnect

@BetaApi
public final InterconnectsGetDiagnosticsResponse getDiagnosticsInterconnect(ProjectGlobalInterconnectName interconnect)

Returns the interconnectDiagnostics for the specified interconnect.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   ProjectGlobalInterconnectName interconnect = ProjectGlobalInterconnectName.of("[PROJECT]", "[INTERCONNECT]");
   InterconnectsGetDiagnosticsResponse response = interconnectClient.getDiagnosticsInterconnect(interconnect);
 }
 

Parameters:

interconnect - Name of the interconnect resource to query.

Throws:

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

getDiagnosticsInterconnect

@BetaApi
public final InterconnectsGetDiagnosticsResponse getDiagnosticsInterconnect(String interconnect)

Returns the interconnectDiagnostics for the specified interconnect.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   ProjectGlobalInterconnectName interconnect = ProjectGlobalInterconnectName.of("[PROJECT]", "[INTERCONNECT]");
   InterconnectsGetDiagnosticsResponse response = interconnectClient.getDiagnosticsInterconnect(interconnect.toString());
 }
 

Parameters:

interconnect - Name of the interconnect resource to query.

Throws:

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

getDiagnosticsInterconnect

@BetaApi
public final InterconnectsGetDiagnosticsResponse getDiagnosticsInterconnect(GetDiagnosticsInterconnectHttpRequest request)

Returns the interconnectDiagnostics for the specified interconnect.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   String formattedInterconnect = ProjectGlobalInterconnectName.format("[PROJECT]", "[INTERCONNECT]");
   GetDiagnosticsInterconnectHttpRequest request = GetDiagnosticsInterconnectHttpRequest.newBuilder()
     .setInterconnect(formattedInterconnect)
     .build();
   InterconnectsGetDiagnosticsResponse response = interconnectClient.getDiagnosticsInterconnect(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

getDiagnosticsInterconnectCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetDiagnosticsInterconnectHttpRequest,InterconnectsGetDiagnosticsResponse> getDiagnosticsInterconnectCallable()

Returns the interconnectDiagnostics for the specified interconnect.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   String formattedInterconnect = ProjectGlobalInterconnectName.format("[PROJECT]", "[INTERCONNECT]");
   GetDiagnosticsInterconnectHttpRequest request = GetDiagnosticsInterconnectHttpRequest.newBuilder()
     .setInterconnect(formattedInterconnect)
     .build();
   ApiFuture<InterconnectsGetDiagnosticsResponse> future = interconnectClient.getDiagnosticsInterconnectCallable().futureCall(request);
   // Do something
   InterconnectsGetDiagnosticsResponse response = future.get();
 }
 

insertInterconnect

@BetaApi
public final Operation insertInterconnect(ProjectName project,
                                                   Interconnect interconnectResource)

Creates a Interconnect in the specified project using the data included in the request.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   Interconnect interconnectResource = Interconnect.newBuilder().build();
   Operation response = interconnectClient.insertInterconnect(project, interconnectResource);
 }
 

Parameters:

project - Project ID for this request.

interconnectResource - Represents an Interconnect resource.

An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==)

Throws:

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

insertInterconnect

@BetaApi
public final Operation insertInterconnect(String project,
                                                   Interconnect interconnectResource)

Creates a Interconnect in the specified project using the data included in the request.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   Interconnect interconnectResource = Interconnect.newBuilder().build();
   Operation response = interconnectClient.insertInterconnect(project.toString(), interconnectResource);
 }
 

Parameters:

project - Project ID for this request.

interconnectResource - Represents an Interconnect resource.

An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==)

Throws:

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

insertInterconnect

@BetaApi
public final Operation insertInterconnect(InsertInterconnectHttpRequest request)

Creates a Interconnect in the specified project using the data included in the request.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   Interconnect interconnectResource = Interconnect.newBuilder().build();
   InsertInterconnectHttpRequest request = InsertInterconnectHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setInterconnectResource(interconnectResource)
     .build();
   Operation response = interconnectClient.insertInterconnect(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

insertInterconnectCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<InsertInterconnectHttpRequest,Operation> insertInterconnectCallable()

Creates a Interconnect in the specified project using the data included in the request.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   Interconnect interconnectResource = Interconnect.newBuilder().build();
   InsertInterconnectHttpRequest request = InsertInterconnectHttpRequest.newBuilder()
     .setProject(formattedProject)
     .setInterconnectResource(interconnectResource)
     .build();
   ApiFuture<Operation> future = interconnectClient.insertInterconnectCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

listInterconnects

@BetaApi
public final InterconnectClient.ListInterconnectsPagedResponse listInterconnects(ProjectName project)

Retrieves the list of interconnect available to the specified project.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (Interconnect element : interconnectClient.listInterconnects(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

listInterconnects

@BetaApi
public final InterconnectClient.ListInterconnectsPagedResponse listInterconnects(String project)

Retrieves the list of interconnect available to the specified project.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (Interconnect element : interconnectClient.listInterconnects(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

listInterconnects

@BetaApi
public final InterconnectClient.ListInterconnectsPagedResponse listInterconnects(ListInterconnectsHttpRequest request)

Retrieves the list of interconnect available to the specified project.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListInterconnectsHttpRequest request = ListInterconnectsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (Interconnect element : interconnectClient.listInterconnects(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

listInterconnectsPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListInterconnectsHttpRequest,InterconnectClient.ListInterconnectsPagedResponse> listInterconnectsPagedCallable()

Retrieves the list of interconnect available to the specified project.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListInterconnectsHttpRequest request = ListInterconnectsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<ListInterconnectsPagedResponse> future = interconnectClient.listInterconnectsPagedCallable().futureCall(request);
   // Do something
   for (Interconnect element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listInterconnectsCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListInterconnectsHttpRequest,InterconnectList> listInterconnectsCallable()

Retrieves the list of interconnect available to the specified project.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   ListInterconnectsHttpRequest request = ListInterconnectsHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     InterconnectList response = interconnectClient.listInterconnectsCallable().call(request);
     for (Interconnect element : response.getItemsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

patchInterconnect

@BetaApi
public final Operation patchInterconnect(ProjectGlobalInterconnectName interconnect,
                                                  Interconnect interconnectResource,
                                                  List<String> fieldMask)

Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   ProjectGlobalInterconnectName interconnect = ProjectGlobalInterconnectName.of("[PROJECT]", "[INTERCONNECT]");
   Interconnect interconnectResource = Interconnect.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = interconnectClient.patchInterconnect(interconnect, interconnectResource, fieldMask);
 }
 

Parameters:

interconnect - Name of the interconnect to update.

interconnectResource - Represents an Interconnect resource.

An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==)

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

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

patchInterconnect

@BetaApi
public final Operation patchInterconnect(String interconnect,
                                                  Interconnect interconnectResource,
                                                  List<String> fieldMask)

Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   ProjectGlobalInterconnectName interconnect = ProjectGlobalInterconnectName.of("[PROJECT]", "[INTERCONNECT]");
   Interconnect interconnectResource = Interconnect.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   Operation response = interconnectClient.patchInterconnect(interconnect.toString(), interconnectResource, fieldMask);
 }
 

Parameters:

interconnect - Name of the interconnect to update.

interconnectResource - Represents an Interconnect resource.

An Interconnect resource is a dedicated connection between the GCP network and your on-premises network. For more information, read the Dedicated Interconnect Overview. (== resource_for v1.interconnects ==) (== resource_for beta.interconnects ==)

fieldMask - The fields that should be serialized (even if they have empty values). If the containing message object has a non-null fieldmask, then all the fields in the field mask (and only those fields in the field mask) will be serialized. If the containing object does not have a fieldmask, then only non-empty fields will be serialized.

Throws:

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

patchInterconnect

@BetaApi
public final Operation patchInterconnect(PatchInterconnectHttpRequest request)

Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   String formattedInterconnect = ProjectGlobalInterconnectName.format("[PROJECT]", "[INTERCONNECT]");
   Interconnect interconnectResource = Interconnect.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchInterconnectHttpRequest request = PatchInterconnectHttpRequest.newBuilder()
     .setInterconnect(formattedInterconnect)
     .setInterconnectResource(interconnectResource)
     .addAllFieldMask(fieldMask)
     .build();
   Operation response = interconnectClient.patchInterconnect(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

patchInterconnectCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<PatchInterconnectHttpRequest,Operation> patchInterconnectCallable()

Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.

Sample code:

 try (InterconnectClient interconnectClient = InterconnectClient.create()) {
   String formattedInterconnect = ProjectGlobalInterconnectName.format("[PROJECT]", "[INTERCONNECT]");
   Interconnect interconnectResource = Interconnect.newBuilder().build();
   List<String> fieldMask = new ArrayList<>();
   PatchInterconnectHttpRequest request = PatchInterconnectHttpRequest.newBuilder()
     .setInterconnect(formattedInterconnect)
     .setInterconnectResource(interconnectResource)
     .addAllFieldMask(fieldMask)
     .build();
   ApiFuture<Operation> future = interconnectClient.patchInterconnectCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }
 

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