Class InterconnectGroupsClient (1.88.0)

GitHub RepositoryProduct Reference

Service Description: The InterconnectGroups 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 (InterconnectGroupsClient interconnectGroupsClient = InterconnectGroupsClient.create()) {
   String project = "project-309310695";
   String interconnectGroup = "interconnectGroup2103544465";
   InterconnectGroup response = interconnectGroupsClient.get(project, interconnectGroup);
 }

Note: close() needs to be called on the InterconnectGroupsClient 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

CreateMembers

Create Interconnects with redundancy by creating them in a specified interconnect group.

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

  • createMembersAsync(CreateMembersInterconnectGroupRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • createMembersAsync(String project, String interconnectGroup, InterconnectGroupsCreateMembersRequest interconnectGroupsCreateMembersRequestResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createMembersOperationCallable()

  • createMembersCallable()

Delete

Deletes the specified InterconnectGroup in the given scope

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

  • deleteAsync(DeleteInterconnectGroupRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • deleteAsync(String project, String interconnectGroup)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteOperationCallable()

  • deleteCallable()

Get

Returns the specified InterconnectGroup resource in the given scope.

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

  • get(GetInterconnectGroupRequest 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 interconnectGroup)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getCallable()

GetIamPolicy

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

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

  • getIamPolicy(GetIamPolicyInterconnectGroupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getIamPolicy(String project, String resource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getIamPolicyCallable()

GetOperationalStatus

Returns the interconnectStatuses for the specified InterconnectGroup.

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

  • getOperationalStatus(GetOperationalStatusInterconnectGroupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getOperationalStatus(String project, String interconnectGroup)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getOperationalStatusCallable()

Insert

Creates a InterconnectGroup in the specified project in the given scope using the parameters that are included in the request.

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

  • insertAsync(InsertInterconnectGroupRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • insertAsync(String project, InterconnectGroup interconnectGroupResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • insertOperationCallable()

  • insertCallable()

List

Lists the InterconnectGroups for a project in the given scope.

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

  • list(ListInterconnectGroupsRequest 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()

Patch

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

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

  • patchAsync(PatchInterconnectGroupRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • patchAsync(String project, String interconnectGroup, InterconnectGroup interconnectGroupResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • patchOperationCallable()

  • patchCallable()

SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

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

  • setIamPolicy(SetIamPolicyInterconnectGroupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • setIamPolicy(String project, String resource, GlobalSetPolicyRequest globalSetPolicyRequestResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setIamPolicyCallable()

TestIamPermissions

Returns permissions that a caller has on the specified resource.

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

  • testIamPermissions(TestIamPermissionsInterconnectGroupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • testIamPermissions(String project, String resource, TestPermissionsRequest testPermissionsRequestResource)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • testIamPermissionsCallable()

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 InterconnectGroupsSettings 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
 InterconnectGroupsSettings interconnectGroupsSettings =
     InterconnectGroupsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 InterconnectGroupsClient interconnectGroupsClient =
     InterconnectGroupsClient.create(interconnectGroupsSettings);

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
 InterconnectGroupsSettings interconnectGroupsSettings =
     InterconnectGroupsSettings.newBuilder().setEndpoint(myEndpoint).build();
 InterconnectGroupsClient interconnectGroupsClient =
     InterconnectGroupsClient.create(interconnectGroupsSettings);

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

Inheritance

java.lang.Object > InterconnectGroupsClient

Static Methods

create()

public static final InterconnectGroupsClient create()

Constructs an instance of InterconnectGroupsClient with default settings.

Returns
Type Description
InterconnectGroupsClient
Exceptions
Type Description
IOException

create(InterconnectGroupsSettings settings)

public static final InterconnectGroupsClient create(InterconnectGroupsSettings settings)

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

create(InterconnectGroupsStub stub)

public static final InterconnectGroupsClient create(InterconnectGroupsStub stub)

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

Parameter
Name Description
stub InterconnectGroupsStub
Returns
Type Description
InterconnectGroupsClient

Constructors

InterconnectGroupsClient(InterconnectGroupsSettings settings)

protected InterconnectGroupsClient(InterconnectGroupsSettings settings)

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

InterconnectGroupsClient(InterconnectGroupsStub stub)

protected InterconnectGroupsClient(InterconnectGroupsStub stub)
Parameter
Name Description
stub InterconnectGroupsStub

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

createMembersAsync(CreateMembersInterconnectGroupRequest request)

public final OperationFuture<Operation,Operation> createMembersAsync(CreateMembersInterconnectGroupRequest request)

Create Interconnects with redundancy by creating them in a specified interconnect group.

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 (InterconnectGroupsClient interconnectGroupsClient = InterconnectGroupsClient.create()) {
   CreateMembersInterconnectGroupRequest request =
       CreateMembersInterconnectGroupRequest.newBuilder()
           .setInterconnectGroup("interconnectGroup2103544465")
           .setInterconnectGroupsCreateMembersRequestResource(
               InterconnectGroupsCreateMembersRequest.newBuilder().build())
           .setProject("project-309310695")
           .build();
   Operation response = interconnectGroupsClient.createMembersAsync(request).get();
 }
Parameter
Name Description
request CreateMembersInterconnectGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

createMembersAsync(String project, String interconnectGroup, InterconnectGroupsCreateMembersRequest interconnectGroupsCreateMembersRequestResource)

public final OperationFuture<Operation,Operation> createMembersAsync(String project, String interconnectGroup, InterconnectGroupsCreateMembersRequest interconnectGroupsCreateMembersRequestResource)

Create Interconnects with redundancy by creating them in a specified interconnect group.

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 (InterconnectGroupsClient interconnectGroupsClient = InterconnectGroupsClient.create()) {
   String project = "project-309310695";
   String interconnectGroup = "interconnectGroup2103544465";
   InterconnectGroupsCreateMembersRequest interconnectGroupsCreateMembersRequestResource =
       InterconnectGroupsCreateMembersRequest.newBuilder().build();
   Operation response =
       interconnectGroupsClient
           .createMembersAsync(
               project, interconnectGroup, interconnectGroupsCreateMembersRequestResource)
           .get();
 }
Parameters
Name Description
project String

Project ID for this request.
interconnectGroup String

Name of the group resource to create members for.
interconnectGroupsCreateMembersRequestResource InterconnectGroupsCreateMembersRequest

The body resource for this request
Returns
Type Description
OperationFuture<Operation,Operation>

createMembersCallable()

public final UnaryCallable<CreateMembersInterconnectGroupRequest,Operation> createMembersCallable()

Create Interconnects with redundancy by creating them in a specified interconnect group.

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 (InterconnectGroupsClient interconnectGroupsClient = InterconnectGroupsClient.create()) {
   CreateMembersInterconnectGroupRequest request =
       CreateMembersInterconnectGroupRequest.newBuilder()
           .setInterconnectGroup("interconnectGroup2103544465")
           .setInterconnectGroupsCreateMembersRequestResource(
               InterconnectGroupsCreateMembersRequest.newBuilder().build())
           .setProject("project-309310695")
           .build();
   ApiFuture<Operation> future =
       interconnectGroupsClient.createMembersCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateMembersInterconnectGroupRequest,Operation>

createMembersOperationCallable()

public final OperationCallable<CreateMembersInterconnectGroupRequest,Operation,Operation> createMembersOperationCallable()

Create Interconnects with redundancy by creating them in a specified interconnect group.

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 (InterconnectGroupsClient interconnectGroupsClient = InterconnectGroupsClient.create()) {
   CreateMembersInterconnectGroupRequest request =
       CreateMembersInterconnectGroupRequest.newBuilder()
           .setInterconnectGroup("interconnectGroup2103544465")
           .setInterconnectGroupsCreateMembersRequestResource(
               InterconnectGroupsCreateMembersRequest.newBuilder().build())
           .setProject("project-309310695")
           .build();
   OperationFuture<Operation, Operation> future =
       interconnectGroupsClient.createMembersOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
OperationCallable<CreateMembersInterconnectGroupRequest,Operation,Operation>

deleteAsync(DeleteInterconnectGroupRequest request)

public final OperationFuture<Operation,Operation> deleteAsync(DeleteInterconnectGroupRequest request)

Deletes the specified InterconnectGroup in the given scope

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 (InterconnectGroupsClient interconnectGroupsClient = InterconnectGroupsClient.create()) {
   DeleteInterconnectGroupRequest request =
       DeleteInterconnectGroupRequest.newBuilder()
           .setInterconnectGroup("interconnectGroup2103544465")
           .setProject("project-309310695")
           .setRequestId("requestId693933066")
           .build();
   Operation response = interconnectGroupsClient.deleteAsync(request).get();
 }
Parameter
Name Description
request DeleteInterconnectGroupRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String interconnectGroup)

public final OperationFuture<Operation,Operation> deleteAsync(String project, String interconnectGroup)

Deletes the specified InterconnectGroup in the given scope

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 (InterconnectGroupsClient interconnectGroupsClient = InterconnectGroupsClient.create()) {
   String project = "project-309310695";
   String interconnectGroup = "interconnectGroup2103544465";
   Operation response = interconnectGroupsClient.deleteAsync(project, interconnectGroup).get();
 }
Parameters
Name Description
project String

Project ID for this request.
interconnectGroup String

Name of the InterconnectGroup resource to delete.
Returns
Type Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteInterconnectGroupRequest,Operation> deleteCallable()

Deletes the specified InterconnectGroup in the given scope

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 (InterconnectGroupsClient interconnectGroupsClient = InterconnectGroupsClient.