com.google.cloud.compute.v1

Class DiskTypeClient

java.lang.Object

com.google.cloud.compute.v1.DiskTypeClient

All Implemented Interfaces:

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

@Generated(value="by gapic-generator")
 @BetaApi
public class DiskTypeClient
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 (DiskTypeClient diskTypeClient = DiskTypeClient.create()) {
   ProjectZoneDiskTypeName diskType = ProjectZoneDiskTypeName.of("[PROJECT]", "[ZONE]", "[DISK_TYPE]");
   DiskType response = diskTypeClient.getDiskType(diskType);
 }
 
 

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

To customize credentials:

 
 DiskTypeSettings diskTypeSettings =
     DiskTypeSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 DiskTypeClient diskTypeClient =
     DiskTypeClient.create(diskTypeSettings);
 
 

To customize the endpoint:

 
 DiskTypeSettings diskTypeSettings =
     DiskTypeSettings.newBuilder().setEndpoint(myEndpoint).build();
 DiskTypeClient diskTypeClient =
     DiskTypeClient.create(diskTypeSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DiskTypeClient.AggregatedListDiskTypesFixedSizeCollection
static class	DiskTypeClient.AggregatedListDiskTypesPage
static class	DiskTypeClient.AggregatedListDiskTypesPagedResponse
static class	DiskTypeClient.ListDiskTypesFixedSizeCollection
static class	DiskTypeClient.ListDiskTypesPage
static class	DiskTypeClient.ListDiskTypesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DiskTypeClient(DiskTypeSettings settings) Constructs an instance of DiskTypeClient, using the given settings.
protected	DiskTypeClient(DiskTypeStub stub)

Method Summary

Modifier and Type	Method and Description
DiskTypeClient.AggregatedListDiskTypesPagedResponse	aggregatedListDiskTypes(AggregatedListDiskTypesHttpRequest request) Retrieves an aggregated list of disk types.
DiskTypeClient.AggregatedListDiskTypesPagedResponse	aggregatedListDiskTypes(ProjectName project) Retrieves an aggregated list of disk types.
DiskTypeClient.AggregatedListDiskTypesPagedResponse	aggregatedListDiskTypes(String project) Retrieves an aggregated list of disk types.
com.google.api.gax.rpc.UnaryCallable<AggregatedListDiskTypesHttpRequest,DiskTypeAggregatedList>	aggregatedListDiskTypesCallable() Retrieves an aggregated list of disk types.
com.google.api.gax.rpc.UnaryCallable<AggregatedListDiskTypesHttpRequest,DiskTypeClient.AggregatedListDiskTypesPagedResponse>	aggregatedListDiskTypesPagedCallable() Retrieves an aggregated list of disk types.
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static DiskTypeClient	create() Constructs an instance of DiskTypeClient with default settings.
static DiskTypeClient	create(DiskTypeSettings settings) Constructs an instance of DiskTypeClient, using the given settings.
static DiskTypeClient	create(DiskTypeStub stub) Constructs an instance of DiskTypeClient, using the given stub for making calls.
DiskType	getDiskType(GetDiskTypeHttpRequest request) Returns the specified disk type.
DiskType	getDiskType(ProjectZoneDiskTypeName diskType) Returns the specified disk type.
DiskType	getDiskType(String diskType) Returns the specified disk type.
com.google.api.gax.rpc.UnaryCallable<GetDiskTypeHttpRequest,DiskType>	getDiskTypeCallable() Returns the specified disk type.
DiskTypeSettings	getSettings()
DiskTypeStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
DiskTypeClient.ListDiskTypesPagedResponse	listDiskTypes(ListDiskTypesHttpRequest request) Retrieves a list of disk types available to the specified project.
DiskTypeClient.ListDiskTypesPagedResponse	listDiskTypes(ProjectZoneName zone) Retrieves a list of disk types available to the specified project.
DiskTypeClient.ListDiskTypesPagedResponse	listDiskTypes(String zone) Retrieves a list of disk types available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListDiskTypesHttpRequest,DiskTypeList>	listDiskTypesCallable() Retrieves a list of disk types available to the specified project.
com.google.api.gax.rpc.UnaryCallable<ListDiskTypesHttpRequest,DiskTypeClient.ListDiskTypesPagedResponse>	listDiskTypesPagedCallable() Retrieves a list of disk 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

DiskTypeClient

protected DiskTypeClient(DiskTypeSettings settings)
                  throws IOException

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

DiskTypeClient

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

Method Detail

create

public static final DiskTypeClient create()
                                   throws IOException

Constructs an instance of DiskTypeClient with default settings.

Throws:

IOException

create

public static final DiskTypeClient create(DiskTypeSettings settings)
                                   throws IOException

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

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

getSettings

public final DiskTypeSettings getSettings()

getStub

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

aggregatedListDiskTypes

@BetaApi
public final DiskTypeClient.AggregatedListDiskTypesPagedResponse aggregatedListDiskTypes(ProjectName project)

Retrieves an aggregated list of disk types.

Sample code:

 try (DiskTypeClient diskTypeClient = DiskTypeClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (DiskTypesScopedList element : diskTypeClient.aggregatedListDiskTypes(project).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

aggregatedListDiskTypes

@BetaApi
public final DiskTypeClient.AggregatedListDiskTypesPagedResponse aggregatedListDiskTypes(String project)

Retrieves an aggregated list of disk types.

Sample code:

 try (DiskTypeClient diskTypeClient = DiskTypeClient.create()) {
   ProjectName project = ProjectName.of("[PROJECT]");
   for (DiskTypesScopedList element : diskTypeClient.aggregatedListDiskTypes(project.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

project - Project ID for this request.

Throws:

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

aggregatedListDiskTypes

@BetaApi
public final DiskTypeClient.AggregatedListDiskTypesPagedResponse aggregatedListDiskTypes(AggregatedListDiskTypesHttpRequest request)

Retrieves an aggregated list of disk types.

Sample code:

 try (DiskTypeClient diskTypeClient = DiskTypeClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListDiskTypesHttpRequest request = AggregatedListDiskTypesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   for (DiskTypesScopedList element : diskTypeClient.aggregatedListDiskTypes(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

aggregatedListDiskTypesPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListDiskTypesHttpRequest,DiskTypeClient.AggregatedListDiskTypesPagedResponse> aggregatedListDiskTypesPagedCallable()

Retrieves an aggregated list of disk types.

Sample code:

 try (DiskTypeClient diskTypeClient = DiskTypeClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListDiskTypesHttpRequest request = AggregatedListDiskTypesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   ApiFuture<AggregatedListDiskTypesPagedResponse> future = diskTypeClient.aggregatedListDiskTypesPagedCallable().futureCall(request);
   // Do something
   for (DiskTypesScopedList element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

aggregatedListDiskTypesCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<AggregatedListDiskTypesHttpRequest,DiskTypeAggregatedList> aggregatedListDiskTypesCallable()

Retrieves an aggregated list of disk types.

Sample code:

 try (DiskTypeClient diskTypeClient = DiskTypeClient.create()) {
   String formattedProject = ProjectName.format("[PROJECT]");
   AggregatedListDiskTypesHttpRequest request = AggregatedListDiskTypesHttpRequest.newBuilder()
     .setProject(formattedProject)
     .build();
   while (true) {
     DiskTypeAggregatedList response = diskTypeClient.aggregatedListDiskTypesCallable().call(request);
     for (DiskTypesScopedList element : response.getItemsMap()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

getDiskType

@BetaApi
public final DiskType getDiskType(ProjectZoneDiskTypeName diskType)

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

Sample code:

 try (DiskTypeClient diskTypeClient = DiskTypeClient.create()) {
   ProjectZoneDiskTypeName diskType = ProjectZoneDiskTypeName.of("[PROJECT]", "[ZONE]", "[DISK_TYPE]");
   DiskType response = diskTypeClient.getDiskType(diskType);
 }
 

Parameters:

diskType - Name of the disk type to return.

Throws:

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

getDiskType

@BetaApi
public final DiskType getDiskType(String diskType)

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

Sample code:

 try (DiskTypeClient diskTypeClient = DiskTypeClient.create()) {
   ProjectZoneDiskTypeName diskType = ProjectZoneDiskTypeName.of("[PROJECT]", "[ZONE]", "[DISK_TYPE]");
   DiskType response = diskTypeClient.getDiskType(diskType.toString());
 }
 

Parameters:

diskType - Name of the disk type to return.

Throws:

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

getDiskType

@BetaApi
public final DiskType getDiskType(GetDiskTypeHttpRequest request)

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

Sample code:

 try (DiskTypeClient diskTypeClient = DiskTypeClient.create()) {
   String formattedDiskType = ProjectZoneDiskTypeName.format("[PROJECT]", "[ZONE]", "[DISK_TYPE]");
   GetDiskTypeHttpRequest request = GetDiskTypeHttpRequest.newBuilder()
     .setDiskType(formattedDiskType)
     .build();
   DiskType response = diskTypeClient.getDiskType(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

getDiskTypeCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<GetDiskTypeHttpRequest,DiskType> getDiskTypeCallable()

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

Sample code:

 try (DiskTypeClient diskTypeClient = DiskTypeClient.create()) {
   String formattedDiskType = ProjectZoneDiskTypeName.format("[PROJECT]", "[ZONE]", "[DISK_TYPE]");
   GetDiskTypeHttpRequest request = GetDiskTypeHttpRequest.newBuilder()
     .setDiskType(formattedDiskType)
     .build();
   ApiFuture<DiskType> future = diskTypeClient.getDiskTypeCallable().futureCall(request);
   // Do something
   DiskType response = future.get();
 }
 

listDiskTypes

@BetaApi
public final DiskTypeClient.ListDiskTypesPagedResponse listDiskTypes(ProjectZoneName zone)

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

Sample code:

 try (DiskTypeClient diskTypeClient = DiskTypeClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   for (DiskType element : diskTypeClient.listDiskTypes(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

listDiskTypes

@BetaApi
public final DiskTypeClient.ListDiskTypesPagedResponse listDiskTypes(String zone)

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

Sample code:

 try (DiskTypeClient diskTypeClient = DiskTypeClient.create()) {
   ProjectZoneName zone = ProjectZoneName.of("[PROJECT]", "[ZONE]");
   for (DiskType element : diskTypeClient.listDiskTypes(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

listDiskTypes

@BetaApi
public final DiskTypeClient.ListDiskTypesPagedResponse listDiskTypes(ListDiskTypesHttpRequest request)

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

Sample code:

 try (DiskTypeClient diskTypeClient = DiskTypeClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   ListDiskTypesHttpRequest request = ListDiskTypesHttpRequest.newBuilder()
     .setZone(formattedZone)
     .build();
   for (DiskType element : diskTypeClient.listDiskTypes(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

listDiskTypesPagedCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListDiskTypesHttpRequest,DiskTypeClient.ListDiskTypesPagedResponse> listDiskTypesPagedCallable()

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

Sample code:

 try (DiskTypeClient diskTypeClient = DiskTypeClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   ListDiskTypesHttpRequest request = ListDiskTypesHttpRequest.newBuilder()
     .setZone(formattedZone)
     .build();
   ApiFuture<ListDiskTypesPagedResponse> future = diskTypeClient.listDiskTypesPagedCallable().futureCall(request);
   // Do something
   for (DiskType element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listDiskTypesCallable

@BetaApi
public final com.google.api.gax.rpc.UnaryCallable<ListDiskTypesHttpRequest,DiskTypeList> listDiskTypesCallable()

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

Sample code:

 try (DiskTypeClient diskTypeClient = DiskTypeClient.create()) {
   String formattedZone = ProjectZoneName.format("[PROJECT]", "[ZONE]");
   ListDiskTypesHttpRequest request = ListDiskTypesHttpRequest.newBuilder()
     .setZone(formattedZone)
     .build();
   while (true) {
     DiskTypeList response = diskTypeClient.listDiskTypesCallable().call(request);
     for (DiskType 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