Class InterconnectAttachmentsClient (1.12.1)

Version 1.12.1

• 1.65.0 (latest)
• 1.64.0
• 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 InterconnectAttachmentsClient implements BackgroundResource

Service Description: The InterconnectAttachments 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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String interconnectAttachment = "interconnectAttachment1869250641";
   InterconnectAttachment response =
       interconnectAttachmentsClient.get(project, region, interconnectAttachment);
 }
 

Note: close() needs to be called on the InterconnectAttachmentsClient 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 InterconnectAttachmentsSettings 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
 InterconnectAttachmentsSettings interconnectAttachmentsSettings =
     InterconnectAttachmentsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create(interconnectAttachmentsSettings);
 

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
 InterconnectAttachmentsSettings interconnectAttachmentsSettings =
     InterconnectAttachmentsSettings.newBuilder().setEndpoint(myEndpoint).build();
 InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create(interconnectAttachmentsSettings);
 

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

Inheritance

java.lang.Object > InterconnectAttachmentsClient

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

Constructs an instance of InterconnectAttachmentsClient with default settings.

Returns

Type	Description
InterconnectAttachmentsClient

Exceptions

Type	Description
IOException

create(InterconnectAttachmentsSettings settings)

public static final InterconnectAttachmentsClient create(InterconnectAttachmentsSettings settings)

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

Returns

Type	Description
InterconnectAttachmentsClient

Exceptions

Type	Description
IOException

create(InterconnectAttachmentsStub stub)

public static final InterconnectAttachmentsClient create(InterconnectAttachmentsStub stub)

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

Parameter

Name	Description
stub	InterconnectAttachmentsStub

Returns

Type	Description
InterconnectAttachmentsClient

Constructors

InterconnectAttachmentsClient(InterconnectAttachmentsSettings settings)

protected InterconnectAttachmentsClient(InterconnectAttachmentsSettings settings)

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

InterconnectAttachmentsClient(InterconnectAttachmentsStub stub)

protected InterconnectAttachmentsClient(InterconnectAttachmentsStub stub)

Parameter

Name	Description
stub	InterconnectAttachmentsStub

Methods

aggregatedList(AggregatedListInterconnectAttachmentsRequest request)

public final InterconnectAttachmentsClient.AggregatedListPagedResponse aggregatedList(AggregatedListInterconnectAttachmentsRequest request)

Retrieves an aggregated list of interconnect attachments.

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   AggregatedListInterconnectAttachmentsRequest request =
       AggregatedListInterconnectAttachmentsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   for (Map.Entry<String, InterconnectAttachmentsScopedList> element :
       interconnectAttachmentsClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
InterconnectAttachmentsClient.AggregatedListPagedResponse

aggregatedList(String project)

public final InterconnectAttachmentsClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of interconnect attachments.

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, InterconnectAttachmentsScopedList> element :
       interconnectAttachmentsClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
project	String Project ID for this request.

Returns

Type	Description
InterconnectAttachmentsClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListInterconnectAttachmentsRequest,InterconnectAttachmentAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of interconnect attachments.

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   AggregatedListInterconnectAttachmentsRequest request =
       AggregatedListInterconnectAttachmentsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     InterconnectAttachmentAggregatedList response =
         interconnectAttachmentsClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, InterconnectAttachmentsScopedList> 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<AggregatedListInterconnectAttachmentsRequest,InterconnectAttachmentAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListInterconnectAttachmentsRequest,InterconnectAttachmentsClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of interconnect attachments.

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   AggregatedListInterconnectAttachmentsRequest request =
       AggregatedListInterconnectAttachmentsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<Map.Entry<String, InterconnectAttachmentsScopedList>> future =
       interconnectAttachmentsClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, InterconnectAttachmentsScopedList> element :
       future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<AggregatedListInterconnectAttachmentsRequest,AggregatedListPagedResponse>

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

deleteAsync(DeleteInterconnectAttachmentRequest request)

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

Deletes the specified interconnect attachment.

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   DeleteInterconnectAttachmentRequest request =
       DeleteInterconnectAttachmentRequest.newBuilder()
           .setInterconnectAttachment("interconnectAttachment1869250641")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = interconnectAttachmentsClient.deleteAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteAsync(String project, String region, String interconnectAttachment)

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

Deletes the specified interconnect attachment.

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String interconnectAttachment = "interconnectAttachment1869250641";
   Operation response =
       interconnectAttachmentsClient.deleteAsync(project, region, interconnectAttachment).get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
interconnectAttachment	String Name of the interconnect attachment to delete.

Returns

Type	Description
OperationFuture<Operation,Operation>

deleteCallable()

public final UnaryCallable<DeleteInterconnectAttachmentRequest,Operation> deleteCallable()

Deletes the specified interconnect attachment.

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   DeleteInterconnectAttachmentRequest request =
       DeleteInterconnectAttachmentRequest.newBuilder()
           .setInterconnectAttachment("interconnectAttachment1869250641")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       interconnectAttachmentsClient.deleteCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteInterconnectAttachmentRequest,Operation>

deleteOperationCallable()

public final OperationCallable<DeleteInterconnectAttachmentRequest,Operation,Operation> deleteOperationCallable()

Deletes the specified interconnect attachment.

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   DeleteInterconnectAttachmentRequest request =
       DeleteInterconnectAttachmentRequest.newBuilder()
           .setInterconnectAttachment("interconnectAttachment1869250641")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       interconnectAttachmentsClient.deleteOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<DeleteInterconnectAttachmentRequest,Operation,Operation>

get(GetInterconnectAttachmentRequest request)

public final InterconnectAttachment get(GetInterconnectAttachmentRequest request)

Returns the specified interconnect attachment.

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   GetInterconnectAttachmentRequest request =
       GetInterconnectAttachmentRequest.newBuilder()
           .setInterconnectAttachment("interconnectAttachment1869250641")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   InterconnectAttachment response = interconnectAttachmentsClient.get(request);
 }
 

Parameter

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

Returns

Type	Description
InterconnectAttachment

get(String project, String region, String interconnectAttachment)

public final InterconnectAttachment get(String project, String region, String interconnectAttachment)

Returns the specified interconnect attachment.

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String interconnectAttachment = "interconnectAttachment1869250641";
   InterconnectAttachment response =
       interconnectAttachmentsClient.get(project, region, interconnectAttachment);
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
interconnectAttachment	String Name of the interconnect attachment to return.

Returns

Type	Description
InterconnectAttachment

getCallable()

public final UnaryCallable<GetInterconnectAttachmentRequest,InterconnectAttachment> getCallable()

Returns the specified interconnect attachment.

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   GetInterconnectAttachmentRequest request =
       GetInterconnectAttachmentRequest.newBuilder()
           .setInterconnectAttachment("interconnectAttachment1869250641")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .build();
   ApiFuture<InterconnectAttachment> future =
       interconnectAttachmentsClient.getCallable().futureCall(request);
   // Do something.
   InterconnectAttachment response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetInterconnectAttachmentRequest,InterconnectAttachment>

getSettings()

public final InterconnectAttachmentsSettings getSettings()

Returns

Type	Description
InterconnectAttachmentsSettings

getStub()

public InterconnectAttachmentsStub getStub()

Returns

Type	Description
InterconnectAttachmentsStub

insertAsync(InsertInterconnectAttachmentRequest request)

public final OperationFuture<Operation,Operation> insertAsync(InsertInterconnectAttachmentRequest request)

Creates an InterconnectAttachment in the specified project using the data included in the 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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   InsertInterconnectAttachmentRequest request =
       InsertInterconnectAttachmentRequest.newBuilder()
           .setInterconnectAttachmentResource(InterconnectAttachment.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   Operation response = interconnectAttachmentsClient.insertAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

insertAsync(String project, String region, InterconnectAttachment interconnectAttachmentResource)

public final OperationFuture<Operation,Operation> insertAsync(String project, String region, InterconnectAttachment interconnectAttachmentResource)

Creates an InterconnectAttachment in the specified project using the data included in the 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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   InterconnectAttachment interconnectAttachmentResource =
       InterconnectAttachment.newBuilder().build();
   Operation response =
       interconnectAttachmentsClient
           .insertAsync(project, region, interconnectAttachmentResource)
           .get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.
interconnectAttachmentResource	InterconnectAttachment The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

insertCallable()

public final UnaryCallable<InsertInterconnectAttachmentRequest,Operation> insertCallable()

Creates an InterconnectAttachment in the specified project using the data included in the 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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   InsertInterconnectAttachmentRequest request =
       InsertInterconnectAttachmentRequest.newBuilder()
           .setInterconnectAttachmentResource(InterconnectAttachment.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   ApiFuture<Operation> future =
       interconnectAttachmentsClient.insertCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<InsertInterconnectAttachmentRequest,Operation>

insertOperationCallable()

public final OperationCallable<InsertInterconnectAttachmentRequest,Operation,Operation> insertOperationCallable()

Creates an InterconnectAttachment in the specified project using the data included in the 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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   InsertInterconnectAttachmentRequest request =
       InsertInterconnectAttachmentRequest.newBuilder()
           .setInterconnectAttachmentResource(InterconnectAttachment.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .setValidateOnly(true)
           .build();
   OperationFuture<Operation, Operation> future =
       interconnectAttachmentsClient.insertOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<InsertInterconnectAttachmentRequest,Operation,Operation>

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

list(ListInterconnectAttachmentsRequest request)

public final InterconnectAttachmentsClient.ListPagedResponse list(ListInterconnectAttachmentsRequest request)

Retrieves the list of interconnect attachments contained within the specified region.

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   ListInterconnectAttachmentsRequest request =
       ListInterconnectAttachmentsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   for (InterconnectAttachment element :
       interconnectAttachmentsClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
InterconnectAttachmentsClient.ListPagedResponse

list(String project, String region)

public final InterconnectAttachmentsClient.ListPagedResponse list(String project, String region)

Retrieves the list of interconnect attachments contained within the specified region.

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   for (InterconnectAttachment element :
       interconnectAttachmentsClient.list(project, region).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region for this request.

Returns

Type	Description
InterconnectAttachmentsClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListInterconnectAttachmentsRequest,InterconnectAttachmentList> listCallable()

Retrieves the list of interconnect attachments contained within the specified region.

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   ListInterconnectAttachmentsRequest request =
       ListInterconnectAttachmentsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   while (true) {
     InterconnectAttachmentList response =
         interconnectAttachmentsClient.listCallable().call(request);
     for (InterconnectAttachment 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<ListInterconnectAttachmentsRequest,InterconnectAttachmentList>

listPagedCallable()

public final UnaryCallable<ListInterconnectAttachmentsRequest,InterconnectAttachmentsClient.ListPagedResponse> listPagedCallable()

Retrieves the list of interconnect attachments contained within the specified region.

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   ListInterconnectAttachmentsRequest request =
       ListInterconnectAttachmentsRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setReturnPartialSuccess(true)
           .build();
   ApiFuture<InterconnectAttachment> future =
       interconnectAttachmentsClient.listPagedCallable().futureCall(request);
   // Do something.
   for (InterconnectAttachment element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListInterconnectAttachmentsRequest,ListPagedResponse>

patchAsync(PatchInterconnectAttachmentRequest request)

public final OperationFuture<Operation,Operation> patchAsync(PatchInterconnectAttachmentRequest request)

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

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   PatchInterconnectAttachmentRequest request =
       PatchInterconnectAttachmentRequest.newBuilder()
           .setInterconnectAttachment("interconnectAttachment1869250641")
           .setInterconnectAttachmentResource(InterconnectAttachment.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   Operation response = interconnectAttachmentsClient.patchAsync(request).get();
 }
 

Parameter

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

Returns

Type	Description
OperationFuture<Operation,Operation>

patchAsync(String project, String region, String interconnectAttachment, InterconnectAttachment interconnectAttachmentResource)

public final OperationFuture<Operation,Operation> patchAsync(String project, String region, String interconnectAttachment, InterconnectAttachment interconnectAttachmentResource)

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

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   String project = "project-309310695";
   String region = "region-934795532";
   String interconnectAttachment = "interconnectAttachment1869250641";
   InterconnectAttachment interconnectAttachmentResource =
       InterconnectAttachment.newBuilder().build();
   Operation response =
       interconnectAttachmentsClient
           .patchAsync(project, region, interconnectAttachment, interconnectAttachmentResource)
           .get();
 }
 

Parameters

Name	Description
project	String Project ID for this request.
region	String Name of the region scoping this request.
interconnectAttachment	String Name of the interconnect attachment to patch.
interconnectAttachmentResource	InterconnectAttachment The body resource for this request

Returns

Type	Description
OperationFuture<Operation,Operation>

patchCallable()

public final UnaryCallable<PatchInterconnectAttachmentRequest,Operation> patchCallable()

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

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   PatchInterconnectAttachmentRequest request =
       PatchInterconnectAttachmentRequest.newBuilder()
           .setInterconnectAttachment("interconnectAttachment1869250641")
           .setInterconnectAttachmentResource(InterconnectAttachment.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future =
       interconnectAttachmentsClient.patchCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<PatchInterconnectAttachmentRequest,Operation>

patchOperationCallable()

public final OperationCallable<PatchInterconnectAttachmentRequest,Operation,Operation> patchOperationCallable()

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

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 (InterconnectAttachmentsClient interconnectAttachmentsClient =
     InterconnectAttachmentsClient.create()) {
   PatchInterconnectAttachmentRequest request =
       PatchInterconnectAttachmentRequest.newBuilder()
           .setInterconnectAttachment("interconnectAttachment1869250641")
           .setInterconnectAttachmentResource(InterconnectAttachment.newBuilder().build())
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Operation, Operation> future =
       interconnectAttachmentsClient.patchOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
OperationCallable<PatchInterconnectAttachmentRequest,Operation,Operation>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()