com.google.api.services.serviceusage.v1

Class ServiceUsage.Operations

java.lang.Object

com.google.api.services.serviceusage.v1.ServiceUsage.Operations

Enclosing class:

ServiceUsage

public class ServiceUsage.Operations
extends java.lang.Object

The "operations" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ServiceUsage.Operations.Cancel
class	ServiceUsage.Operations.Delete
class	ServiceUsage.Operations.Get
class	ServiceUsage.Operations.List

Constructor Summary

Constructors

Constructor and Description
Operations()

Method Summary

Modifier and Type	Method and Description
ServiceUsage.Operations.Cancel	cancel(java.lang.String name, CancelOperationRequest content) Starts asynchronous cancellation on a long-running operation.
ServiceUsage.Operations.Delete	delete(java.lang.String name) Deletes a long-running operation.
ServiceUsage.Operations.Get	get(java.lang.String name) Gets the latest state of a long-running operation.
ServiceUsage.Operations.List	list() Lists operations that match the specified filter in the request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Operations

public Operations()

Method Detail

cancel

public ServiceUsage.Operations.Cancel cancel(java.lang.String name,
                                             CancelOperationRequest content)
                                      throws java.io.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 serviceusage 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.

content - the CancelOperationRequest

Returns:

the request

Throws:

java.io.IOException

delete

public ServiceUsage.Operations.Delete delete(java.lang.String name)
                                      throws java.io.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 serviceusage 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:

java.io.IOException

get

public ServiceUsage.Operations.Get get(java.lang.String name)
                                throws java.io.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 serviceusage 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:

java.io.IOException

list

public ServiceUsage.Operations.List list()
                                  throws java.io.IOException

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. Create a request for the method "operations.list". This request holds the parameters needed by the serviceusage server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

java.io.IOException