InterconnectAttachmentClient (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.InterconnectAttachmentClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class InterconnectAttachmentClient
extends Object
implements com.google.api.gax.core.BackgroundResource
```
Service Description: Creates and runs virtual machines on Google Cloud Platform.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
```
 
 try (InterconnectAttachmentClient interconnectAttachmentClient = InterconnectAttachmentClient.create()) {
   ProjectRegionInterconnectAttachmentName interconnectAttachment = ProjectRegionInterconnectAttachmentName.of("[PROJECT]", "[REGION]", "[INTERCONNECT_ATTACHMENT]");
   Operation response = interconnectAttachmentClient.deleteInterconnectAttachment(interconnectAttachment);
 }
 
 
```
Note: close() needs to be called on the interconnectAttachmentClient 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 InterconnectAttachmentSettings to create(). For example:
To customize credentials:
```
 
 InterconnectAttachmentSettings interconnectAttachmentSettings =
     InterconnectAttachmentSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 InterconnectAttachmentClient interconnectAttachmentClient =
     InterconnectAttachmentClient.create(interconnectAttachmentSettings);
 
 
```
To customize the endpoint:
```
 
 InterconnectAttachmentSettings interconnectAttachmentSettings =
     InterconnectAttachmentSettings.newBuilder().setEndpoint(myEndpoint).build();
 InterconnectAttachmentClient interconnectAttachmentClient =
     InterconnectAttachmentClient.create(interconnectAttachmentSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`InterconnectAttachmentClient.AggregatedListInterconnectAttachmentsFixedSizeCollection`
`static class`	`InterconnectAttachmentClient.AggregatedListInterconnectAttachmentsPage`
`static class`	`InterconnectAttachmentClient.AggregatedListInterconnectAttachmentsPagedResponse`
`static class`	`InterconnectAttachmentClient.ListInterconnectAttachmentsFixedSizeCollection`
`static class`	`InterconnectAttachmentClient.ListInterconnectAttachmentsPage`
`static class`	`InterconnectAttachmentClient.ListInterconnectAttachmentsPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`InterconnectAttachmentClient(InterconnectAttachmentSettings settings)` Constructs an instance of InterconnectAttachmentClient, using the given settings.
`protected`	`InterconnectAttachmentClient(InterconnectAttachmentStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InterconnectAttachmentClient.AggregatedListInterconnectAttachmentsPagedResponse`	`aggregatedListInterconnectAttachments(AggregatedListInterconnectAttachmentsHttpRequest request)` Retrieves an aggregated list of interconnect attachments.
`InterconnectAttachmentClient.AggregatedListInterconnectAttachmentsPagedResponse`	`aggregatedListInterconnectAttachments(ProjectName project)` Retrieves an aggregated list of interconnect attachments.
`InterconnectAttachmentClient.AggregatedListInterconnectAttachmentsPagedResponse`	`aggregatedListInterconnectAttachments(String project)` Retrieves an aggregated list of interconnect attachments.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListInterconnectAttachmentsHttpRequest,InterconnectAttachmentAggregatedList>`	`aggregatedListInterconnectAttachmentsCallable()` Retrieves an aggregated list of interconnect attachments.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListInterconnectAttachmentsHttpRequest,InterconnectAttachmentClient.AggregatedListInterconnectAttachmentsPagedResponse>`	`aggregatedListInterconnectAttachmentsPagedCallable()` Retrieves an aggregated list of interconnect attachments.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static InterconnectAttachmentClient`	`create()` Constructs an instance of InterconnectAttachmentClient with default settings.
`static InterconnectAttachmentClient`	`create(InterconnectAttachmentSettings settings)` Constructs an instance of InterconnectAttachmentClient, using the given settings.
`static InterconnectAttachmentClient`	`create(InterconnectAttachmentStub stub)` Constructs an instance of InterconnectAttachmentClient, using the given stub for making calls.
`Operation`	`deleteInterconnectAttachment(DeleteInterconnectAttachmentHttpRequest request)` Deletes the specified interconnect attachment.
`Operation`	`deleteInterconnectAttachment(ProjectRegionInterconnectAttachmentName interconnectAttachment)` Deletes the specified interconnect attachment.
`Operation`	`deleteInterconnectAttachment(String interconnectAttachment)` Deletes the specified interconnect attachment.
`com.google.api.gax.rpc.UnaryCallable<DeleteInterconnectAttachmentHttpRequest,Operation>`	`deleteInterconnectAttachmentCallable()` Deletes the specified interconnect attachment.
`InterconnectAttachment`	`getInterconnectAttachment(GetInterconnectAttachmentHttpRequest request)` Returns the specified interconnect attachment.
`InterconnectAttachment`	`getInterconnectAttachment(ProjectRegionInterconnectAttachmentName interconnectAttachment)` Returns the specified interconnect attachment.
`InterconnectAttachment`	`getInterconnectAttachment(String interconnectAttachment)` Returns the specified interconnect attachment.
`com.google.api.gax.rpc.UnaryCallable<GetInterconnectAttachmentHttpRequest,InterconnectAttachment>`	`getInterconnectAttachmentCallable()` Returns the specified interconnect attachment.
`InterconnectAttachmentSettings`	`getSettings()`
`InterconnectAttachmentStub`	`getStub()`
`Operation`	`insertInterconnectAttachment(InsertInterconnectAttachmentHttpRequest request)` Creates an InterconnectAttachment in the specified project using the data included in the request.
`Operation`	`insertInterconnectAttachment(ProjectRegionName region, InterconnectAttachment interconnectAttachmentResource)` Creates an InterconnectAttachment in the specified project using the data included in the request.
`Operation`	`insertInterconnectAttachment(String region, InterconnectAttachment interconnectAttachmentResource)` Creates an InterconnectAttachment in the specified project using the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<InsertInterconnectAttachmentHttpRequest,Operation>`	`insertInterconnectAttachmentCallable()` Creates an InterconnectAttachment in the specified project using the data included in the request.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`InterconnectAttachmentClient.ListInterconnectAttachmentsPagedResponse`	`listInterconnectAttachments(ListInterconnectAttachmentsHttpRequest request)` Retrieves the list of interconnect attachments contained within the specified region.
`InterconnectAttachmentClient.ListInterconnectAttachmentsPagedResponse`	`listInterconnectAttachments(ProjectRegionName region)` Retrieves the list of interconnect attachments contained within the specified region.
`InterconnectAttachmentClient.ListInterconnectAttachmentsPagedResponse`	`listInterconnectAttachments(String region)` Retrieves the list of interconnect attachments contained within the specified region.
`com.google.api.gax.rpc.UnaryCallable<ListInterconnectAttachmentsHttpRequest,InterconnectAttachmentList>`	`listInterconnectAttachmentsCallable()` Retrieves the list of interconnect attachments contained within the specified region.
`com.google.api.gax.rpc.UnaryCallable<ListInterconnectAttachmentsHttpRequest,InterconnectAttachmentClient.ListInterconnectAttachmentsPagedResponse>`	`listInterconnectAttachmentsPagedCallable()` Retrieves the list of interconnect attachments contained within the specified region.
`Operation`	`patchInterconnectAttachment(PatchInterconnectAttachmentHttpRequest request)` Updates the specified interconnect attachment with the data included in the request.
`Operation`	`patchInterconnectAttachment(ProjectRegionInterconnectAttachmentName interconnectAttachment, InterconnectAttachment interconnectAttachmentResource, List<String> fieldMask)` Updates the specified interconnect attachment with the data included in the request.
`Operation`	`patchInterconnectAttachment(String interconnectAttachment, InterconnectAttachment interconnectAttachmentResource, List<String> fieldMask)` Updates the specified interconnect attachment with the data included in the request.
`com.google.api.gax.rpc.UnaryCallable<PatchInterconnectAttachmentHttpRequest,Operation>`	`patchInterconnectAttachmentCallable()` Updates the specified interconnect attachment with the data included in the request.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InterconnectAttachmentClient
```
protected InterconnectAttachmentClient(InterconnectAttachmentSettings settings)
                                throws IOException
```
Constructs an instance of InterconnectAttachmentClient, 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

InterconnectAttachmentClient

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

Method Detail

create

public static final InterconnectAttachmentClient create()
                                                 throws IOException

Constructs an instance of InterconnectAttachmentClient with default settings.

Throws:: IOException

create
```
public static final InterconnectAttachmentClient create(InterconnectAttachmentSettings settings)
                                                 throws IOException
```
Constructs an instance of InterconnectAttachmentClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

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

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

getSettings

public final InterconnectAttachmentSettings getSettings()