Class AcceleratorTypesClient (1.16.0)

Version 1.16.0

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

Service Description: Services

The AcceleratorTypes 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 (AcceleratorTypesClient acceleratorTypesClient = AcceleratorTypesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String acceleratorType = "acceleratorType-82462651";
   AcceleratorType response = acceleratorTypesClient.get(project, zone, acceleratorType);
 }
 

Note: close() needs to be called on the AcceleratorTypesClient 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 AcceleratorTypesSettings 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
 AcceleratorTypesSettings acceleratorTypesSettings =
     AcceleratorTypesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AcceleratorTypesClient acceleratorTypesClient =
     AcceleratorTypesClient.create(acceleratorTypesSettings);
 

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
 AcceleratorTypesSettings acceleratorTypesSettings =
     AcceleratorTypesSettings.newBuilder().setEndpoint(myEndpoint).build();
 AcceleratorTypesClient acceleratorTypesClient =
     AcceleratorTypesClient.create(acceleratorTypesSettings);
 

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

Inheritance

java.lang.Object > AcceleratorTypesClient

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

Constructs an instance of AcceleratorTypesClient with default settings.

Returns

Type	Description
AcceleratorTypesClient

Exceptions

Type	Description
IOException

create(AcceleratorTypesSettings settings)

public static final AcceleratorTypesClient create(AcceleratorTypesSettings settings)

Constructs an instance of AcceleratorTypesClient, 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	AcceleratorTypesSettings

Returns

Type	Description
AcceleratorTypesClient

Exceptions

Type	Description
IOException

create(AcceleratorTypesStub stub)

public static final AcceleratorTypesClient create(AcceleratorTypesStub stub)

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

Parameter

Name	Description
stub	AcceleratorTypesStub

Returns

Type	Description
AcceleratorTypesClient

Constructors

AcceleratorTypesClient(AcceleratorTypesSettings settings)

protected AcceleratorTypesClient(AcceleratorTypesSettings settings)

Constructs an instance of AcceleratorTypesClient, 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	AcceleratorTypesSettings

AcceleratorTypesClient(AcceleratorTypesStub stub)

protected AcceleratorTypesClient(AcceleratorTypesStub stub)

Parameter

Name	Description
stub	AcceleratorTypesStub

Methods

aggregatedList(AggregatedListAcceleratorTypesRequest request)

public final AcceleratorTypesClient.AggregatedListPagedResponse aggregatedList(AggregatedListAcceleratorTypesRequest request)

Retrieves an aggregated list of accelerator types.

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

Parameter

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

Returns

Type	Description
AcceleratorTypesClient.AggregatedListPagedResponse

aggregatedList(String project)

public final AcceleratorTypesClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of accelerator types.

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

Parameter

Name	Description
project	String Project ID for this request.

Returns

Type	Description
AcceleratorTypesClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListAcceleratorTypesRequest,AcceleratorTypeAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of accelerator types.

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

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListAcceleratorTypesRequest,AcceleratorTypesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of accelerator types.

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

Returns

Type	Description
UnaryCallable<AggregatedListAcceleratorTypesRequest,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()

get(GetAcceleratorTypeRequest request)

public final AcceleratorType get(GetAcceleratorTypeRequest request)

Returns the specified accelerator type.

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 (AcceleratorTypesClient acceleratorTypesClient = AcceleratorTypesClient.create()) {
   GetAcceleratorTypeRequest request =
       GetAcceleratorTypeRequest.newBuilder()
           .setAcceleratorType("acceleratorType-82462651")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   AcceleratorType response = acceleratorTypesClient.get(request);
 }
 

Parameter

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

Returns

Type	Description
AcceleratorType

get(String project, String zone, String acceleratorType)

public final AcceleratorType get(String project, String zone, String acceleratorType)

Returns the specified accelerator type.

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 (AcceleratorTypesClient acceleratorTypesClient = AcceleratorTypesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String acceleratorType = "acceleratorType-82462651";
   AcceleratorType response = acceleratorTypesClient.get(project, zone, acceleratorType);
 }
 

Parameters

Name	Description
project	String Project ID for this request.
zone	String The name of the zone for this request.
acceleratorType	String Name of the accelerator type to return.

Returns

Type	Description
AcceleratorType

getCallable()

public final UnaryCallable<GetAcceleratorTypeRequest,AcceleratorType> getCallable()

Returns the specified accelerator type.

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 (AcceleratorTypesClient acceleratorTypesClient = AcceleratorTypesClient.create()) {
   GetAcceleratorTypeRequest request =
       GetAcceleratorTypeRequest.newBuilder()
           .setAcceleratorType("acceleratorType-82462651")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ApiFuture<AcceleratorType> future = acceleratorTypesClient.getCallable().futureCall(request);
   // Do something.
   AcceleratorType response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetAcceleratorTypeRequest,AcceleratorType>

getSettings()

public final AcceleratorTypesSettings getSettings()

Returns

Type	Description
AcceleratorTypesSettings

getStub()

public AcceleratorTypesStub getStub()

Returns

Type	Description
AcceleratorTypesStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

list(ListAcceleratorTypesRequest request)

public final AcceleratorTypesClient.ListPagedResponse list(ListAcceleratorTypesRequest request)

Retrieves a list of accelerator types that are available to the specified project.

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 (AcceleratorTypesClient acceleratorTypesClient = AcceleratorTypesClient.create()) {
   ListAcceleratorTypesRequest request =
       ListAcceleratorTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   for (AcceleratorType element : acceleratorTypesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

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

Returns

Type	Description
AcceleratorTypesClient.ListPagedResponse

list(String project, String zone)

public final AcceleratorTypesClient.ListPagedResponse list(String project, String zone)

Retrieves a list of accelerator types that are available to the specified project.

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 (AcceleratorTypesClient acceleratorTypesClient = AcceleratorTypesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   for (AcceleratorType element : acceleratorTypesClient.list(project, zone).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters

Name	Description
project	String Project ID for this request.
zone	String The name of the zone for this request.

Returns

Type	Description
AcceleratorTypesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListAcceleratorTypesRequest,AcceleratorTypeList> listCallable()

Retrieves a list of accelerator types that are available to the specified project.

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 (AcceleratorTypesClient acceleratorTypesClient = AcceleratorTypesClient.create()) {
   ListAcceleratorTypesRequest request =
       ListAcceleratorTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   while (true) {
     AcceleratorTypeList response = acceleratorTypesClient.listCallable().call(request);
     for (AcceleratorType 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<ListAcceleratorTypesRequest,AcceleratorTypeList>

listPagedCallable()

public final UnaryCallable<ListAcceleratorTypesRequest,AcceleratorTypesClient.ListPagedResponse> listPagedCallable()

Retrieves a list of accelerator types that are available to the specified project.

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 (AcceleratorTypesClient acceleratorTypesClient = AcceleratorTypesClient.create()) {
   ListAcceleratorTypesRequest request =
       ListAcceleratorTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   ApiFuture<AcceleratorType> future =
       acceleratorTypesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (AcceleratorType element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListAcceleratorTypesRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()