Package com.google.cloud.compute.v1

Class InterconnectAttachmentsClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @Generated("by gapic-generator-java")
public class InterconnectAttachmentsClient
extends Object
implements com.google.api.gax.core.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.

    • Constructor Detail

      • InterconnectAttachmentsClient

        protected InterconnectAttachmentsClient​(InterconnectAttachmentsSettings settings)
                                 throws IOException
        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.
        Throws:
        IOException

    • Method Detail

      • create

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

      • aggregatedList

        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);
   }
 }
        Parameters:
        project - Project ID for this request.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • aggregatedList

        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);
   }
 }
        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

      • aggregatedListPagedCallable

        public final com.google.api.gax.rpc.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);
   }
 }

      • aggregatedListCallable

        public final com.google.api.gax.rpc.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;
     }
   }
 }

      • deleteAsync

        public final com.google.api.gax.longrunning.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:
        project - Project ID for this request.
        region - Name of the region for this request.
        interconnectAttachment - Name of the interconnect attachment to delete.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • deleteAsync

        @BetaApi("The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.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();
 }
        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

      • deleteOperationCallable

        public final com.google.api.gax.rpc.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();
 }

      • deleteCallable

        public final com.google.api.gax.rpc.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();
 }

      • get

        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:
        project - Project ID for this request.
        region - Name of the region for this request.
        interconnectAttachment - Name of the interconnect attachment to return.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • get

        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);
 }
        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

      • getCallable

        public final com.google.api.gax.rpc.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();
 }

      • insertAsync

        public final com.google.api.gax.longrunning.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:
        project - Project ID for this request.
        region - Name of the region for this request.
        interconnectAttachmentResource - The body resource for this request
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • insertAsync

        @BetaApi("The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.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();
 }
        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

      • insertOperationCallable

        public final com.google.api.gax.rpc.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();
 }

      • insertCallable

        public final com.google.api.gax.rpc.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();
 }

      • list

        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:
        project - Project ID for this request.
        region - Name of the region for this request.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • list

        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);
   }
 }
        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

      • listPagedCallable

        public final com.google.api.gax.rpc.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);
   }
 }

      • listCallable

        public final com.google.api.gax.rpc.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;
     }
   }
 }

      • patchAsync

        public final com.google.api.gax.longrunning.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:
        project - Project ID for this request.
        region - Name of the region scoping this request.
        interconnectAttachment - Name of the interconnect attachment to patch.
        interconnectAttachmentResource - The body resource for this request
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • patchAsync

        @BetaApi("The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.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();
 }
        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

      • patchOperationCallable

        public final com.google.api.gax.rpc.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();
 }

      • patchCallable

        public final com.google.api.gax.rpc.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();
 }

      • setLabelsAsync

        public final com.google.api.gax.longrunning.OperationFuture<Operation,​Operation> setLabelsAsync​(String project,
                                                                                                      String region,
                                                                                                      String resource,
                                                                                                      RegionSetLabelsRequest regionSetLabelsRequestResource)
        Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.

        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 resource = "resource-341064690";
   RegionSetLabelsRequest regionSetLabelsRequestResource =
       RegionSetLabelsRequest.newBuilder().build();
   Operation response =
       interconnectAttachmentsClient
           .setLabelsAsync(project, region, resource, regionSetLabelsRequestResource)
           .get();
 }
        Parameters:
        project - Project ID for this request.
        region - The region for this request.
        resource - Name or id of the resource for this request.
        regionSetLabelsRequestResource - The body resource for this request
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • setLabelsAsync

        @BetaApi("The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<Operation,​Operation> setLabelsAsync​(SetLabelsInterconnectAttachmentRequest request)
        Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.

        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()) {
   SetLabelsInterconnectAttachmentRequest request =
       SetLabelsInterconnectAttachmentRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .build();
   Operation response = interconnectAttachmentsClient.setLabelsAsync(request).get();
 }
        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

      • setLabelsOperationCallable

        public final com.google.api.gax.rpc.OperationCallable<SetLabelsInterconnectAttachmentRequest,​Operation,​Operation> setLabelsOperationCallable()
        Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.

        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()) {
   SetLabelsInterconnectAttachmentRequest request =
       SetLabelsInterconnectAttachmentRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .build();
   OperationFuture<Operation, Operation> future =
       interconnectAttachmentsClient.setLabelsOperationCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • setLabelsCallable

        public final com.google.api.gax.rpc.UnaryCallable<SetLabelsInterconnectAttachmentRequest,​Operation> setLabelsCallable()
        Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation.

        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()) {
   SetLabelsInterconnectAttachmentRequest request =
       SetLabelsInterconnectAttachmentRequest.newBuilder()
           .setProject("project-309310695")
           .setRegion("region-934795532")
           .setRegionSetLabelsRequestResource(RegionSetLabelsRequest.newBuilder().build())
           .setRequestId("requestId693933066")
           .setResource("resource-341064690")
           .build();
   ApiFuture<Operation> future =
       interconnectAttachmentsClient.setLabelsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

      • 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