AcceleratorTypeClient (Google Cloud 0.119.0-alpha API)

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

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class AcceleratorTypeClient
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 (AcceleratorTypeClient acceleratorTypeClient = AcceleratorTypeClient.create()) {
   ProjectZoneAcceleratorTypeName acceleratorType = ProjectZoneAcceleratorTypeName.of("[PROJECT]", "[ZONE]", "[ACCELERATOR_TYPE]");
   AcceleratorType response = acceleratorTypeClient.getAcceleratorType(acceleratorType);
 }
 
 
```
Note: close() needs to be called on the acceleratorTypeClient 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 AcceleratorTypeSettings to create(). For example:
To customize credentials:
```
 
 AcceleratorTypeSettings acceleratorTypeSettings =
     AcceleratorTypeSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AcceleratorTypeClient acceleratorTypeClient =
     AcceleratorTypeClient.create(acceleratorTypeSettings);
 
 
```
To customize the endpoint:
```
 
 AcceleratorTypeSettings acceleratorTypeSettings =
     AcceleratorTypeSettings.newBuilder().setEndpoint(myEndpoint).build();
 AcceleratorTypeClient acceleratorTypeClient =
     AcceleratorTypeClient.create(acceleratorTypeSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`AcceleratorTypeClient.AggregatedListAcceleratorTypesFixedSizeCollection`
`static class`	`AcceleratorTypeClient.AggregatedListAcceleratorTypesPage`
`static class`	`AcceleratorTypeClient.AggregatedListAcceleratorTypesPagedResponse`
`static class`	`AcceleratorTypeClient.ListAcceleratorTypesFixedSizeCollection`
`static class`	`AcceleratorTypeClient.ListAcceleratorTypesPage`
`static class`	`AcceleratorTypeClient.ListAcceleratorTypesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AcceleratorTypeClient(AcceleratorTypeSettings settings)` Constructs an instance of AcceleratorTypeClient, using the given settings.
`protected`	`AcceleratorTypeClient(AcceleratorTypeStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AcceleratorTypeClient.AggregatedListAcceleratorTypesPagedResponse`	`aggregatedListAcceleratorTypes(AggregatedListAcceleratorTypesHttpRequest request)` Retrieves an aggregated list of accelerator types.
`AcceleratorTypeClient.AggregatedListAcceleratorTypesPagedResponse`	`aggregatedListAcceleratorTypes(ProjectName project)` Retrieves an aggregated list of accelerator types.
`AcceleratorTypeClient.AggregatedListAcceleratorTypesPagedResponse`	`aggregatedListAcceleratorTypes(String project)` Retrieves an aggregated list of accelerator types.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListAcceleratorTypesHttpRequest,AcceleratorTypeAggregatedList>`	`aggregatedListAcceleratorTypesCallable()` Retrieves an aggregated list of accelerator types.
`com.google.api.gax.rpc.UnaryCallable<AggregatedListAcceleratorTypesHttpRequest,AcceleratorTypeClient.AggregatedListAcceleratorTypesPagedResponse>`	`aggregatedListAcceleratorTypesPagedCallable()` Retrieves an aggregated list of accelerator types.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static AcceleratorTypeClient`	`create()` Constructs an instance of AcceleratorTypeClient with default settings.
`static AcceleratorTypeClient`	`create(AcceleratorTypeSettings settings)` Constructs an instance of AcceleratorTypeClient, using the given settings.
`static AcceleratorTypeClient`	`create(AcceleratorTypeStub stub)` Constructs an instance of AcceleratorTypeClient, using the given stub for making calls.
`AcceleratorType`	`getAcceleratorType(GetAcceleratorTypeHttpRequest request)` Returns the specified accelerator type.
`AcceleratorType`	`getAcceleratorType(ProjectZoneAcceleratorTypeName acceleratorType)` Returns the specified accelerator type.
`AcceleratorType`	`getAcceleratorType(String acceleratorType)` Returns the specified accelerator type.
`com.google.api.gax.rpc.UnaryCallable<GetAcceleratorTypeHttpRequest,AcceleratorType>`	`getAcceleratorTypeCallable()` Returns the specified accelerator type.
`AcceleratorTypeSettings`	`getSettings()`
`AcceleratorTypeStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`AcceleratorTypeClient.ListAcceleratorTypesPagedResponse`	`listAcceleratorTypes(ListAcceleratorTypesHttpRequest request)` Retrieves a list of accelerator types available to the specified project.
`AcceleratorTypeClient.ListAcceleratorTypesPagedResponse`	`listAcceleratorTypes(ProjectZoneName zone)` Retrieves a list of accelerator types available to the specified project.
`AcceleratorTypeClient.ListAcceleratorTypesPagedResponse`	`listAcceleratorTypes(String zone)` Retrieves a list of accelerator types available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListAcceleratorTypesHttpRequest,AcceleratorTypeList>`	`listAcceleratorTypesCallable()` Retrieves a list of accelerator types available to the specified project.
`com.google.api.gax.rpc.UnaryCallable<ListAcceleratorTypesHttpRequest,AcceleratorTypeClient.ListAcceleratorTypesPagedResponse>`	`listAcceleratorTypesPagedCallable()` Retrieves a list of accelerator types available to the specified project.
`void`	`shutdown()`
`void`	`shutdownNow()`

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

Constructor Detail
- AcceleratorTypeClient
```
protected AcceleratorTypeClient(AcceleratorTypeSettings settings)
                         throws IOException
```
  Constructs an instance of AcceleratorTypeClient, 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
- AcceleratorTypeClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected AcceleratorTypeClient(AcceleratorTypeStub stub)
```

Method Detail

create

public static final AcceleratorTypeClient create()
                                          throws IOException

Constructs an instance of AcceleratorTypeClient with default settings.

Throws:: IOException

create
```
public static final AcceleratorTypeClient create(AcceleratorTypeSettings settings)
                                          throws IOException
```
Constructs an instance of AcceleratorTypeClient, 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 AcceleratorTypeClient create(AcceleratorTypeStub stub)

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

getSettings

public final AcceleratorTypeSettings getSettings()

getStub

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

aggregatedListAcceleratorTypes

@BetaApi
public final AcceleratorTypeClient.AggregatedListAcceleratorTypesPagedResponse aggregatedListAcceleratorTypes(ProjectName project)

Retrieves an aggregated list of accelerator types.

Sample code:


 try (AcceleratorTypeClient acceleratorTypeClient = AcceleratorTypeClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (AcceleratorTypesScopedList element : acceleratorTypeClient.aggregatedListAcceleratorTypes(project).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: project - Project ID for this request.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

aggregatedListAcceleratorTypes

@BetaApi
public final AcceleratorTypeClient.AggregatedListAcceleratorTypesPagedResponse aggregatedListAcceleratorTypes(String project)

Retrieves an aggregated list of accelerator types.

Sample code:


 try (AcceleratorTypeClient acceleratorTypeClient = AcceleratorTypeClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (AcceleratorTypesScopedList element : acceleratorTypeClient.aggregatedListAcceleratorTypes(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: project - Project ID for this request.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

aggregatedListAcceleratorTypes

@BetaApi
public final AcceleratorTypeClient.AggregatedListAcceleratorTypesPagedResponse aggregatedListAcceleratorTypes(AggregatedListAcceleratorTypesHttpRequest request)

Retrieves an aggregated list of accelerator types.

Sample code:


 try (AcceleratorTypeClient acceleratorTypeClient = AcceleratorTypeClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListAcceleratorTypesHttpRequest request = AggregatedListAcceleratorTypesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (AcceleratorTypesScopedList element : acceleratorTypeClient.aggregatedListAcceleratorTypes(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

aggregatedListAcceleratorTypesPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListAcceleratorTypesHttpRequest,AcceleratorTypeClient.AggregatedListAcceleratorTypesPagedResponse> aggregatedListAcceleratorTypesPagedCallable()

Retrieves an aggregated list of accelerator types.

Sample code:


 try (AcceleratorTypeClient acceleratorTypeClient = AcceleratorTypeClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListAcceleratorTypesHttpRequest request = AggregatedListAcceleratorTypesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<AggregatedListAcceleratorTypesPagedResponse> future = acceleratorTypeClient.aggregatedListAcceleratorTypesPagedCallable().futureCall(request);
   // Do something
   for (AcceleratorTypesScopedList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

aggregatedListAcceleratorTypesCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListAcceleratorTypesHttpRequest,AcceleratorTypeAggregatedList> aggregatedListAcceleratorTypesCallable()

Retrieves an aggregated list of accelerator types.

Sample code:


 try (AcceleratorTypeClient acceleratorTypeClient = AcceleratorTypeClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListAcceleratorTypesHttpRequest request = AggregatedListAcceleratorTypesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     AcceleratorTypeAggregatedList response = acceleratorTypeClient.aggregatedListAcceleratorTypesCallable().call(request);
     for (AcceleratorTypesScopedList element : response.getItemsMap()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

getAcceleratorType

@BetaApi
public final AcceleratorType getAcceleratorType(ProjectZoneAcceleratorTypeName acceleratorType)

Returns the specified accelerator type.

Sample code:


 try (AcceleratorTypeClient acceleratorTypeClient = AcceleratorTypeClient.create()) {
   ProjectZoneAcceleratorTypeName acceleratorType = ProjectZoneAcceleratorTypeName.of("[PROJECT]", "[ZONE]", "[ACCELERATOR_TYPE]");
   AcceleratorType response = acceleratorTypeClient.getAcceleratorType(acceleratorType);
 }

Parameters:: acceleratorType - Name of the accelerator type to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getAcceleratorType

@BetaApi
public final AcceleratorType getAcceleratorType(String acceleratorType)

Returns the specified accelerator type.

Sample code:


 try (AcceleratorTypeClient acceleratorTypeClient = AcceleratorTypeClient.create()) {
   ProjectZoneAcceleratorTypeName acceleratorType = ProjectZoneAcceleratorTypeName.of("[PROJECT]", "[ZONE]", "[ACCELERATOR_TYPE]");
   AcceleratorType response = acceleratorTypeClient.getAcceleratorType(acceleratorType.toString());
 }

Parameters:: acceleratorType - Name of the accelerator type to return.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getAcceleratorType

@BetaApi
public final AcceleratorType getAcceleratorType(GetAcceleratorTypeHttpRequest request)

Returns the specified accelerator type.

Sample code:


 try (AcceleratorTypeClient acceleratorTypeClient = AcceleratorTypeClient.create()) {
   String formattedAcceleratorType = ProjectZoneAcceleratorTypeName.format("[PROJECT]", "[ZONE]", "[ACCELERATOR_TYPE]");
   GetAcceleratorTypeHttpRequest request = GetAcceleratorTypeHttpRequest.newBuilder()
     .setAcceleratorType(formattedAcceleratorType)
     .build();
   AcceleratorType response = acceleratorTypeClient.getAcceleratorType(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

getAcceleratorTypeCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetAcceleratorTypeHttpRequest,AcceleratorType> getAcceleratorTypeCallable()

Returns the specified accelerator type.

Sample code:


 try (AcceleratorTypeClient acceleratorTypeClient = AcceleratorTypeClient.create()) {
   String formattedAcceleratorType = ProjectZoneAcceleratorTypeName.format("[PROJECT]", "[ZONE]", "[ACCELERATOR_TYPE]");
   GetAcceleratorTypeHttpRequest request = GetAcceleratorTypeHttpRequest.newBuilder()
     .setAcceleratorType(formattedAcceleratorType)
     .build();
   ApiFuture<AcceleratorType> future = acceleratorTypeClient.getAcceleratorTypeCallable().futureCall(request);
   // Do something
   AcceleratorType response = future.get();
 }