target.apidocs.com.google.api.services.spanner.v1.Spanner.Projects.InstanceConfigs.Operations.html Maven / Gradle / Ivy
Spanner.Projects.InstanceConfigs.Operations (Cloud Spanner API v1-rev20240711-2.0.0)
com.google.api.services.spanner.v1
Class Spanner.Projects.InstanceConfigs.Operations
- java.lang.Object
-
- com.google.api.services.spanner.v1.Spanner.Projects.InstanceConfigs.Operations
-
- Enclosing class:
- Spanner.Projects.InstanceConfigs
public class Spanner.Projects.InstanceConfigs.Operations
extends Object
The "operations" collection of methods.
-
-
Nested Class Summary
Nested Classes
Modifier and Type
Class and Description
class
Spanner.Projects.InstanceConfigs.Operations.Cancel
class
Spanner.Projects.InstanceConfigs.Operations.Delete
class
Spanner.Projects.InstanceConfigs.Operations.Get
class
Spanner.Projects.InstanceConfigs.Operations.List
-
Constructor Summary
Constructors
Constructor and Description
Operations()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Spanner.Projects.InstanceConfigs.Operations.Cancel
cancel(String name)
Starts asynchronous cancellation on a long-running operation.
Spanner.Projects.InstanceConfigs.Operations.Delete
delete(String name)
Deletes a long-running operation.
Spanner.Projects.InstanceConfigs.Operations.Get
get(String name)
Gets the latest state of a long-running operation.
Spanner.Projects.InstanceConfigs.Operations.List
list(String name)
Lists operations that match the specified filter in the request.
-
-
Method Detail
-
cancel
public Spanner.Projects.InstanceConfigs.Operations.Cancel cancel(String name)
throws IOException
Starts asynchronous cancellation on a long-running operation. The server makes a best effort to
cancel the operation, but success is not guaranteed. If the server doesn't support this method,
it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other
methods to check whether the cancellation succeeded or whether the operation completed despite
cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an
operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to
`Code.CANCELLED`.
Create a request for the method "operations.cancel".
This request holds the parameters needed by the spanner server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation.
- Parameters:
name
- The name of the operation resource to be cancelled.
- Returns:
- the request
- Throws:
IOException
-
delete
public Spanner.Projects.InstanceConfigs.Operations.Delete delete(String name)
throws IOException
Deletes a long-running operation. This method indicates that the client is no longer interested
in the operation result. It does not cancel the operation. If the server doesn't support this
method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Create a request for the method "operations.delete".
This request holds the parameters needed by the spanner server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation.
- Parameters:
name
- The name of the operation resource to be deleted.
- Returns:
- the request
- Throws:
IOException
-
get
public Spanner.Projects.InstanceConfigs.Operations.Get get(String name)
throws IOException
Gets the latest state of a long-running operation. Clients can use this method to poll the
operation result at intervals as recommended by the API service.
Create a request for the method "operations.get".
This request holds the parameters needed by the spanner server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation.
- Parameters:
name
- The name of the operation resource.
- Returns:
- the request
- Throws:
IOException
-
list
public Spanner.Projects.InstanceConfigs.Operations.List list(String name)
throws IOException
Lists operations that match the specified filter in the request. If the server doesn't support
this method, it returns `UNIMPLEMENTED`.
Create a request for the method "operations.list".
This request holds the parameters needed by the spanner server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation.
- Parameters:
name
- The name of the operation's parent resource.
- Returns:
- the request
- Throws:
IOException
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy