com.google.cloud.compute.v1

Class MachineTypeClient

java.lang.Object

com.google.cloud.compute.v1.MachineTypeClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class MachineTypeClient
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 (MachineTypeClient machineTypeClient = MachineTypeClient.create()) {
   ProjectZoneMachineTypeName machineType = ProjectZoneMachineTypeName.of("[PROJECT]", "[ZONE]", "[MACHINE_TYPE]");
   MachineType response = machineTypeClient.getMachineType(machineType);
 }
 
 

Note: close() needs to be called on the machineTypeClient 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 MachineTypeSettings to create(). For example:

To customize credentials:

 
 MachineTypeSettings machineTypeSettings =
     MachineTypeSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MachineTypeClient machineTypeClient =
     MachineTypeClient.create(machineTypeSettings);
 
 

To customize the endpoint:

 
 MachineTypeSettings machineTypeSettings =
     MachineTypeSettings.newBuilder().setEndpoint(myEndpoint).build();
 MachineTypeClient machineTypeClient =
     MachineTypeClient.create(machineTypeSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MachineTypeClient.AggregatedListMachineTypesFixedSizeCollection
static class	MachineTypeClient.AggregatedListMachineTypesPage
static class	MachineTypeClient.AggregatedListMachineTypesPagedResponse
static class	MachineTypeClient.ListMachineTypesFixedSizeCollection
static class	MachineTypeClient.ListMachineTypesPage
static class	MachineTypeClient.ListMachineTypesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MachineTypeClient(MachineTypeSettings settings) Constructs an instance of MachineTypeClient, using the given settings.
protected	MachineTypeClient(MachineTypeStub stub)

Method Summary

Modifier and Type	Method and Description
MachineTypeClient.AggregatedListMachineTypesPagedResponse	aggregatedListMachineTypes(AggregatedListMachineTypesHttpRequest request) Retrieves an aggregated list of machine types.
MachineTypeClient.AggregatedListMachineTypesPagedResponse	aggregatedListMachineTypes(ProjectName project) Retrieves an aggregated list of machine types.
MachineTypeClient.AggregatedListMachineTypesPagedResponse	aggregatedListMachineTypes(String project) Retrieves an aggregated list of machine types.
com.google.api.gax.rpc.UnaryCallable<AggregatedListMachineTypesHttpRequest,MachineTypeAggregatedList>	aggregatedListMachineTypesCallable() Retrieves an aggregated list of machine types.
com.google.api.gax.rpc.UnaryCallable<AggregatedListMachineTypesHttpRequest,MachineTypeClient.AggregatedListMachineTypesPagedResponse>	aggregatedListMachineTypesPagedCallable() Retrieves an aggregated list of machine types.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static MachineTypeClient	create() Constructs an instance of MachineTypeClient with default settings.
static MachineTypeClient	create(MachineTypeSettings settings) Constructs an instance of MachineTypeClient, using the given settings.
static MachineTypeClient	create(MachineTypeStub stub) Constructs an instance of MachineTypeClient, using the given stub for making calls.
MachineType	getMachineType(GetMachineTypeHttpRequest request) Returns the specified machine type.
MachineType	getMachineType(ProjectZoneMachineTypeName machineType) Returns the specified machine type.
MachineType	getMachineType(String machineType) Returns the specified machine type.
com.google.api.gax.rpc.UnaryCallable<GetMachineTypeHttpRequest,MachineType>	getMachineTypeCallable() Returns the specified machine type.
MachineTypeSettings	getSettings()
MachineTypeStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
MachineTypeClient.ListMachineTypesPagedResponse	listMachineTypes(ListMachineTypesHttpRequest request) Retrieves a list of machine types available to the specified project.
MachineTypeClient.ListMachineTypesPagedResponse	listMachineTypes(ProjectZoneName zone) Retrieves a list of machine types available to the specified project.
MachineTypeClient.ListMachineTypesPagedResponse	listMachineTypes(String zone) Retrieves a list of machine types available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListMachineTypesHttpRequest,MachineTypeList>	listMachineTypesCallable() Retrieves a list of machine types available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListMachineTypesHttpRequest,MachineTypeClient.ListMachineTypesPagedResponse>	listMachineTypesPagedCallable() Retrieves a list of machine 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

MachineTypeClient

protected MachineTypeClient(MachineTypeSettings settings)
                     throws IOException

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

MachineTypeClient

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

Method Detail

create

public static final MachineTypeClient create()
                                      throws IOException

Constructs an instance of MachineTypeClient with default settings.

Throws:

IOException

create

public static final MachineTypeClient create(MachineTypeSettings settings)
                                      throws IOException

Constructs an instance of MachineTypeClient, 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 MachineTypeClient create(MachineTypeStub stub)

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

getSettings

public final MachineTypeSettings getSettings()

getStub

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

aggregatedListMachineTypes

@BetaApi
public final MachineTypeClient.AggregatedListMachineTypesPagedResponse aggregatedListMachineTypes(ProjectName project)

Retrieves an aggregated list of machine types.

Sample code:

 try (MachineTypeClient machineTypeClient = MachineTypeClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (MachineTypesScopedList element : machineTypeClient.aggregatedListMachineTypes(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

aggregatedListMachineTypes

@BetaApi
public final MachineTypeClient.AggregatedListMachineTypesPagedResponse aggregatedListMachineTypes(String project)

Retrieves an aggregated list of machine types.

Sample code:

 try (MachineTypeClient machineTypeClient = MachineTypeClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (MachineTypesScopedList element : machineTypeClient.aggregatedListMachineTypes(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

aggregatedListMachineTypes

@BetaApi
public final MachineTypeClient.AggregatedListMachineTypesPagedResponse aggregatedListMachineTypes(AggregatedListMachineTypesHttpRequest request)

Retrieves an aggregated list of machine types.

Sample code:

 try (MachineTypeClient machineTypeClient = MachineTypeClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListMachineTypesHttpRequest request = AggregatedListMachineTypesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (MachineTypesScopedList element : machineTypeClient.aggregatedListMachineTypes(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

aggregatedListMachineTypesPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListMachineTypesHttpRequest,MachineTypeClient.AggregatedListMachineTypesPagedResponse> aggregatedListMachineTypesPagedCallable()

Retrieves an aggregated list of machine types.

Sample code:

 try (MachineTypeClient machineTypeClient = MachineTypeClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListMachineTypesHttpRequest request = AggregatedListMachineTypesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<AggregatedListMachineTypesPagedResponse> future = machineTypeClient.aggregatedListMachineTypesPagedCallable().futureCall(request);
   // Do something
   for (MachineTypesScopedList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

aggregatedListMachineTypesCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListMachineTypesHttpRequest,MachineTypeAggregatedList> aggregatedListMachineTypesCallable()

Retrieves an aggregated list of machine types.

Sample code:

 try (MachineTypeClient machineTypeClient = MachineTypeClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListMachineTypesHttpRequest request = AggregatedListMachineTypesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     MachineTypeAggregatedList response = machineTypeClient.aggregatedListMachineTypesCallable().call(request);
     for (MachineTypesScopedList element : response.getItemsMap()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getMachineType

@BetaApi
public final MachineType getMachineType(ProjectZoneMachineTypeName machineType)

Returns the specified machine type. Gets a list of available machine types by making a list() request.

Sample code:

 try (MachineTypeClient machineTypeClient = MachineTypeClient.create()) {
   ProjectZoneMachineTypeName machineType = ProjectZoneMachineTypeName.of("[PROJECT]", "[ZONE]", "[MACHINE_TYPE]");
   MachineType response = machineTypeClient.getMachineType(machineType);
 }
 

Parameters:

machineType - Name of the machine type to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getMachineType

@BetaApi
public final MachineType getMachineType(String machineType)

Returns the specified machine type. Gets a list of available machine types by making a list() request.

Sample code:

 try (MachineTypeClient machineTypeClient = MachineTypeClient.create()) {
   ProjectZoneMachineTypeName machineType = ProjectZoneMachineTypeName.of("[PROJECT]", "[ZONE]", "[MACHINE_TYPE]");
   MachineType response = machineTypeClient.getMachineType(machineType.toString());
 }
 

Parameters:

machineType - Name of the machine type to return.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getMachineType

@BetaApi
public final MachineType getMachineType(GetMachineTypeHttpRequest request)

Returns the specified machine type. Gets a list of available machine types by making a list() request.

Sample code:

 try (MachineTypeClient machineTypeClient = MachineTypeClient.create()) {
   String formattedMachineType = ProjectZoneMachineTypeName.format("[PROJECT]", "[ZONE]", "[MACHINE_TYPE]");
   GetMachineTypeHttpRequest request = GetMachineTypeHttpRequest.newBuilder()
     .setMachineType(formattedMachineType)
     .build();
   MachineType response = machineTypeClient.getMachineType(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

getMachineTypeCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetMachineTypeHttpRequest,MachineType> getMachineTypeCallable()

Returns the specified machine type. Gets a list of available machine types by making a list() request.

Sample code:

 try (MachineTypeClient machineTypeClient = MachineTypeClient.create()) {
   String formattedMachineType = ProjectZoneMachineTypeName.format("[PROJECT]", "[ZONE]", "[MACHINE_TYPE]");
   GetMachineTypeHttpRequest request = GetMachineTypeHttpRequest.newBuilder()
     .setMachineType(formattedMachineType)
     .build();
   ApiFuture<MachineType> future = machineTypeClient.getMachineTypeCallable().futureCall(request);
   // Do something
   MachineType response = future.get();
 }
 

listMachineTypes

@BetaApi
public final MachineTypeClient.ListMachineTypesPagedResponse listMachineTypes(ProjectZoneName zone)

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

Sample code:

 try (MachineTypeClient machineTypeClient = MachineTypeClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   for (MachineType element : machineTypeClient.listMachineTypes(zone).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

zone - The name of the zone for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listMachineTypes

@BetaApi
public final MachineTypeClient.ListMachineTypesPagedResponse listMachineTypes(String zone)

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

Sample code:

 try (MachineTypeClient machineTypeClient = MachineTypeClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   for (MachineType element : machineTypeClient.listMachineTypes(zone.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

zone - The name of the zone for this request.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listMachineTypes

@BetaApi
public final MachineTypeClient.ListMachineTypesPagedResponse listMachineTypes(ListMachineTypesHttpRequest request)

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

Sample code:

 try (MachineTypeClient machineTypeClient = MachineTypeClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   ListMachineTypesHttpRequest request = ListMachineTypesHttpRequest.newBuilder()
     .setZone(formattedZone)
     .build();
   for (MachineType element : machineTypeClient.listMachineTypes(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

listMachineTypesPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListMachineTypesHttpRequest,MachineTypeClient.ListMachineTypesPagedResponse> listMachineTypesPagedCallable()

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

Sample code:

 try (MachineTypeClient machineTypeClient = MachineTypeClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   ListMachineTypesHttpRequest request = ListMachineTypesHttpRequest.newBuilder()
     .setZone(formattedZone)
     .build();
   ApiFuture<ListMachineTypesPagedResponse> future = machineTypeClient.listMachineTypesPagedCallable().futureCall(request);
   // Do something
   for (MachineType element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listMachineTypesCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListMachineTypesHttpRequest,MachineTypeList> listMachineTypesCallable()

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

Sample code:

 try (MachineTypeClient machineTypeClient = MachineTypeClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   ListMachineTypesHttpRequest request = ListMachineTypesHttpRequest.newBuilder()
     .setZone(formattedZone)
     .build();
   while (true) {
     MachineTypeList response = machineTypeClient.listMachineTypesCallable().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;
     }
   }
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

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

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException