Class MachineTypesClient (1.63.0)

GitHub RepositoryProduct Reference

Service Description: The MachineTypes 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 (MachineTypesClient machineTypesClient = MachineTypesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String machineType = "machineType-218117087";
   MachineType response = machineTypesClient.get(project, zone, machineType);
 }

Note: close() needs to be called on the MachineTypesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

AggregatedList

Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • aggregatedList(AggregatedListMachineTypesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • aggregatedList(String project)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • aggregatedListPagedCallable()

  • aggregatedListCallable()

Get

Returns the specified machine type.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • get(GetMachineTypeRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • get(String project, String zone, String machineType)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getCallable()

List

Retrieves a list of machine types available to the specified project.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • list(ListMachineTypesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • list(String project, String zone)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listPagedCallable()

  • listCallable()

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 MachineTypesSettings 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
 MachineTypesSettings machineTypesSettings =
     MachineTypesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MachineTypesClient machineTypesClient = MachineTypesClient.create(machineTypesSettings);

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
 MachineTypesSettings machineTypesSettings =
     MachineTypesSettings.newBuilder().setEndpoint(myEndpoint).build();
 MachineTypesClient machineTypesClient = MachineTypesClient.create(machineTypesSettings);

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

Inheritance

java.lang.Object > MachineTypesClient

Static Methods

create()

public static final MachineTypesClient create()

Constructs an instance of MachineTypesClient with default settings.

Returns
Type Description
MachineTypesClient
Exceptions
Type Description
IOException

create(MachineTypesSettings settings)

public static final MachineTypesClient create(MachineTypesSettings settings)

Constructs an instance of MachineTypesClient, 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 MachineTypesSettings
Returns
Type Description
MachineTypesClient
Exceptions
Type Description
IOException

create(MachineTypesStub stub)

public static final MachineTypesClient create(MachineTypesStub stub)

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

Parameter
Name Description
stub MachineTypesStub
Returns
Type Description
MachineTypesClient

Constructors

MachineTypesClient(MachineTypesSettings settings)

protected MachineTypesClient(MachineTypesSettings settings)

Constructs an instance of MachineTypesClient, 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 MachineTypesSettings

MachineTypesClient(MachineTypesStub stub)

protected MachineTypesClient(MachineTypesStub stub)
Parameter
Name Description
stub MachineTypesStub

Methods

aggregatedList(AggregatedListMachineTypesRequest request)

public final MachineTypesClient.AggregatedListPagedResponse aggregatedList(AggregatedListMachineTypesRequest request)

Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (MachineTypesClient machineTypesClient = MachineTypesClient.create()) {
   AggregatedListMachineTypesRequest request =
       AggregatedListMachineTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   for (Map.Entry<String, MachineTypesScopedList> element :
       machineTypesClient.aggregatedList(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request AggregatedListMachineTypesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
MachineTypesClient.AggregatedListPagedResponse

aggregatedList(String project)

public final MachineTypesClient.AggregatedListPagedResponse aggregatedList(String project)

Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (MachineTypesClient machineTypesClient = MachineTypesClient.create()) {
   String project = "project-309310695";
   for (Map.Entry<String, MachineTypesScopedList> element :
       machineTypesClient.aggregatedList(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
project String

Project ID for this request.
Returns
Type Description
MachineTypesClient.AggregatedListPagedResponse

aggregatedListCallable()

public final UnaryCallable<AggregatedListMachineTypesRequest,MachineTypeAggregatedList> aggregatedListCallable()

Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (MachineTypesClient machineTypesClient = MachineTypesClient.create()) {
   AggregatedListMachineTypesRequest request =
       AggregatedListMachineTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   while (true) {
     MachineTypeAggregatedList response =
         machineTypesClient.aggregatedListCallable().call(request);
     for (Map.Entry<String, MachineTypesScopedList> 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<AggregatedListMachineTypesRequest,MachineTypeAggregatedList>

aggregatedListPagedCallable()

public final UnaryCallable<AggregatedListMachineTypesRequest,MachineTypesClient.AggregatedListPagedResponse> aggregatedListPagedCallable()

Retrieves an aggregated list of machine types. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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 (MachineTypesClient machineTypesClient = MachineTypesClient.create()) {
   AggregatedListMachineTypesRequest request =
       AggregatedListMachineTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setIncludeAllScopes(true)
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setServiceProjectNumber(-1293855239)
           .build();
   ApiFuture<Map.Entry<String, MachineTypesScopedList>> future =
       machineTypesClient.aggregatedListPagedCallable().futureCall(request);
   // Do something.
   for (Map.Entry<String, MachineTypesScopedList> element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<AggregatedListMachineTypesRequest,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(GetMachineTypeRequest request)

public final MachineType get(GetMachineTypeRequest request)

Returns the specified machine 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 (MachineTypesClient machineTypesClient = MachineTypesClient.create()) {
   GetMachineTypeRequest request =
       GetMachineTypeRequest.newBuilder()
           .setMachineType("machineType-218117087")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   MachineType response = machineTypesClient.get(request);
 }
Parameter
Name Description
request GetMachineTypeRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
MachineType

get(String project, String zone, String machineType)

public final MachineType get(String project, String zone, String machineType)

Returns the specified machine 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 (MachineTypesClient machineTypesClient = MachineTypesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   String machineType = "machineType-218117087";
   MachineType response = machineTypesClient.get(project, zone, machineType);
 }
Parameters
Name Description
project String

Project ID for this request.
zone String

The name of the zone for this request.
machineType String

Name of the machine type to return.
Returns
Type Description
MachineType

getCallable()

public final UnaryCallable<GetMachineTypeRequest,MachineType> getCallable()

Returns the specified machine 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 (MachineTypesClient machineTypesClient = MachineTypesClient.create()) {
   GetMachineTypeRequest request =
       GetMachineTypeRequest.newBuilder()
           .setMachineType("machineType-218117087")
           .setProject("project-309310695")
           .setZone("zone3744684")
           .build();
   ApiFuture<MachineType> future = machineTypesClient.getCallable().futureCall(request);
   // Do something.
   MachineType response = future.get();
 }
Returns
Type Description
UnaryCallable<GetMachineTypeRequest,MachineType>

getSettings()

public final MachineTypesSettings getSettings()
Returns
Type Description
MachineTypesSettings

getStub()

public MachineTypesStub getStub()
Returns
Type Description
MachineTypesStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

list(ListMachineTypesRequest request)

public final MachineTypesClient.ListPagedResponse list(ListMachineTypesRequest request)

Retrieves a list of machine types 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 (MachineTypesClient machineTypesClient = MachineTypesClient.create()) {
   ListMachineTypesRequest request =
       ListMachineTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   for (MachineType element : machineTypesClient.list(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListMachineTypesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
MachineTypesClient.ListPagedResponse

list(String project, String zone)

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

Retrieves a list of machine types 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 (MachineTypesClient machineTypesClient = MachineTypesClient.create()) {
   String project = "project-309310695";
   String zone = "zone3744684";
   for (MachineType element : machineTypesClient.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
MachineTypesClient.ListPagedResponse

listCallable()

public final UnaryCallable<ListMachineTypesRequest,MachineTypeList> listCallable()

Retrieves a list of machine types 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 (MachineTypesClient machineTypesClient = MachineTypesClient.create()) {
   ListMachineTypesRequest request =
       ListMachineTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   while (true) {
     MachineTypeList response = machineTypesClient.listCallable().call(request);
     for (MachineType 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<ListMachineTypesRequest,MachineTypeList>

listPagedCallable()

public final UnaryCallable<ListMachineTypesRequest,MachineTypesClient.ListPagedResponse> listPagedCallable()

Retrieves a list of machine types 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 (MachineTypesClient machineTypesClient = MachineTypesClient.create()) {
   ListMachineTypesRequest request =
       ListMachineTypesRequest.newBuilder()
           .setFilter("filter-1274492040")
           .setMaxResults(1128457243)
           .setOrderBy("orderBy-1207110587")
           .setPageToken("pageToken873572522")
           .setProject("project-309310695")
           .setReturnPartialSuccess(true)
           .setZone("zone3744684")
           .build();
   ApiFuture<MachineType> future = machineTypesClient.listPagedCallable().futureCall(request);
   // Do something.
   for (MachineType element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListMachineTypesRequest,ListPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()