target.apidocs.com.google.api.services.compute.Compute.Reservations.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

There is a newer version: v1-rev20250320-2.0.0

Show newest version







Compute.Reservations (Compute Engine API v1-rev20250107-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute
Class Compute.Reservations



java.lang.Object


com.google.api.services.compute.Compute.Reservations







Enclosing class:
Compute




public class Compute.Reservations
extends Object
The "reservations" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Compute.Reservations.AggregatedList 


class 
Compute.Reservations.Delete 


class 
Compute.Reservations.Get 


class 
Compute.Reservations.GetIamPolicy 


class 
Compute.Reservations.Insert 


class 
Compute.Reservations.List 


class 
Compute.Reservations.Resize 


class 
Compute.Reservations.SetIamPolicy 


class 
Compute.Reservations.TestIamPermissions 


class 
Compute.Reservations.Update 









Constructor Summary

Constructors 

Constructor and Description


Reservations() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Compute.Reservations.AggregatedList
aggregatedList(String project)
Retrieves an aggregated list of reservations.



Compute.Reservations.Delete
delete(String project,
      String zone,
      String reservation)
Deletes the specified reservation.



Compute.Reservations.Get
get(String project,
   String zone,
   String reservation)
Retrieves information about the specified reservation.



Compute.Reservations.GetIamPolicy
getIamPolicy(String project,
            String zone,
            String resource)
Gets the access control policy for a resource.



Compute.Reservations.Insert
insert(String project,
      String zone,
      Reservation content)
Creates a new reservation.



Compute.Reservations.List
list(String project,
    String zone)
A list of all the reservations that have been configured for the specified project in specified
 zone.



Compute.Reservations.Resize
resize(String project,
      String zone,
      String reservation,
      ReservationsResizeRequest content)
Resizes the reservation (applicable to standalone reservations only).



Compute.Reservations.SetIamPolicy
setIamPolicy(String project,
            String zone,
            String resource,
            ZoneSetPolicyRequest content)
Sets the access control policy on the specified resource.



Compute.Reservations.TestIamPermissions
testIamPermissions(String project,
                  String zone,
                  String resource,
                  TestPermissionsRequest content)
Returns permissions that a caller has on the specified resource.



Compute.Reservations.Update
update(String project,
      String zone,
      String reservation,
      Reservation content)
Update share settings of the reservation.







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














Constructor Detail





Reservations
public Reservations()









Method Detail





aggregatedList
public Compute.Reservations.AggregatedList aggregatedList(String project)
                                                   throws IOException
Retrieves an aggregated list of reservations. To prevent failure, Google recommends that you set
 the `returnPartialSuccess` parameter to `true`.

 Create a request for the method "reservations.aggregatedList".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
Returns:
the request
Throws:
IOException








delete
public Compute.Reservations.Delete delete(String project,
                                          String zone,
                                          String reservation)
                                   throws IOException
Deletes the specified reservation.

 Create a request for the method "reservations.delete".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
zone - Name of the zone for this request.
reservation - Name of the reservation to delete.
Returns:
the request
Throws:
IOException








get
public Compute.Reservations.Get get(String project,
                                    String zone,
                                    String reservation)
                             throws IOException
Retrieves information about the specified reservation.

 Create a request for the method "reservations.get".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
zone - Name of the zone for this request.
reservation - Name of the reservation to retrieve.
Returns:
the request
Throws:
IOException








getIamPolicy
public Compute.Reservations.GetIamPolicy getIamPolicy(String project,
                                                      String zone,
                                                      String resource)
                                               throws IOException
Gets the access control policy for a resource. May be empty if no such policy or resource exists.

 Create a request for the method "reservations.getIamPolicy".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
zone - The name of the zone for this request.
resource - Name or id of the resource for this request.
Returns:
the request
Throws:
IOException








insert
public Compute.Reservations.Insert insert(String project,
                                          String zone,
                                          Reservation content)
                                   throws IOException
Creates a new reservation. For more information, read Reserving zonal resources.

 Create a request for the method "reservations.insert".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
zone - Name of the zone for this request.
content - the Reservation
Returns:
the request
Throws:
IOException








list
public Compute.Reservations.List list(String project,
                                      String zone)
                               throws IOException
A list of all the reservations that have been configured for the specified project in specified
 zone.

 Create a request for the method "reservations.list".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
zone - Name of the zone for this request.
Returns:
the request
Throws:
IOException








resize
public Compute.Reservations.Resize resize(String project,
                                          String zone,
                                          String reservation,
                                          ReservationsResizeRequest content)
                                   throws IOException
Resizes the reservation (applicable to standalone reservations only). For more information, read
 Modifying reservations.

 Create a request for the method "reservations.resize".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
zone - Name of the zone for this request.
reservation - Name of the reservation to update.
content - the ReservationsResizeRequest
Returns:
the request
Throws:
IOException








setIamPolicy
public Compute.Reservations.SetIamPolicy setIamPolicy(String project,
                                                      String zone,
                                                      String resource,
                                                      ZoneSetPolicyRequest content)
                                               throws IOException
Sets the access control policy on the specified resource. Replaces any existing policy.

 Create a request for the method "reservations.setIamPolicy".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
zone - The name of the zone for this request.
resource - Name or id of the resource for this request.
content - the ZoneSetPolicyRequest
Returns:
the request
Throws:
IOException








testIamPermissions
public Compute.Reservations.TestIamPermissions testIamPermissions(String project,
                                                                  String zone,
                                                                  String resource,
                                                                  TestPermissionsRequest content)
                                                           throws IOException
Returns permissions that a caller has on the specified resource.

 Create a request for the method "reservations.testIamPermissions".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
zone - The name of the zone for this request.
resource - Name or id of the resource for this request.
content - the TestPermissionsRequest
Returns:
the request
Throws:
IOException








update
public Compute.Reservations.Update update(String project,
                                          String zone,
                                          String reservation,
                                          Reservation content)
                                   throws IOException
Update share settings of the reservation.

 Create a request for the method "reservations.update".

 This request holds the parameters needed by the compute server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID for this request.
zone - Name of the zone for this request.
reservation - Name of the reservation to update.
content - the Reservation
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2025 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`Compute.Reservations.AggregatedList`
`class`	`Compute.Reservations.Delete`
`class`	`Compute.Reservations.Get`
`class`	`Compute.Reservations.GetIamPolicy`
`class`	`Compute.Reservations.Insert`
`class`	`Compute.Reservations.List`
`class`	`Compute.Reservations.Resize`
`class`	`Compute.Reservations.SetIamPolicy`
`class`	`Compute.Reservations.TestIamPermissions`
`class`	`Compute.Reservations.Update`

Modifier and Type	Method and Description
`Compute.Reservations.AggregatedList`	`aggregatedList(String project)` Retrieves an aggregated list of reservations.
`Compute.Reservations.Delete`	`delete(String project, String zone, String reservation)` Deletes the specified reservation.
`Compute.Reservations.Get`	`get(String project, String zone, String reservation)` Retrieves information about the specified reservation.
`Compute.Reservations.GetIamPolicy`	`getIamPolicy(String project, String zone, String resource)` Gets the access control policy for a resource.
`Compute.Reservations.Insert`	`insert(String project, String zone, Reservation content)` Creates a new reservation.
`Compute.Reservations.List`	`list(String project, String zone)` A list of all the reservations that have been configured for the specified project in specified zone.
`Compute.Reservations.Resize`	`resize(String project, String zone, String reservation, ReservationsResizeRequest content)` Resizes the reservation (applicable to standalone reservations only).
`Compute.Reservations.SetIamPolicy`	`setIamPolicy(String project, String zone, String resource, ZoneSetPolicyRequest content)` Sets the access control policy on the specified resource.
`Compute.Reservations.TestIamPermissions`	`testIamPermissions(String project, String zone, String resource, TestPermissionsRequest content)` Returns permissions that a caller has on the specified resource.
`Compute.Reservations.Update`	`update(String project, String zone, String reservation, Reservation content)` Update share settings of the reservation.