Class OperationsResource
The "operations" collection of methods.
Inherited Members
Namespace: Google.Apis.Aiplatform.v1
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class OperationsResource
Constructors
OperationsResource(IClientService)
Constructs a new resource.
Declaration
public OperationsResource(IClientService service)
Parameters
| Type | Name | Description |
|---|---|---|
| IClientService | service |
Methods
Cancel(string)
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.
Declaration
public virtual OperationsResource.CancelRequest Cancel(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the operation resource to be cancelled. |
Returns
| Type | Description |
|---|---|
| OperationsResource.CancelRequest |
Delete(string)
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.
Declaration
public virtual OperationsResource.DeleteRequest Delete(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the operation resource to be deleted. |
Returns
| Type | Description |
|---|---|
| OperationsResource.DeleteRequest |
Get(string)
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.
Declaration
public virtual OperationsResource.GetRequest Get(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the operation resource. |
Returns
| Type | Description |
|---|---|
| OperationsResource.GetRequest |
List()
Lists operations that match the specified filter in the request. If the server doesn't support this method,
it returns UNIMPLEMENTED.
Declaration
public virtual OperationsResource.ListRequest List()
Returns
| Type | Description |
|---|---|
| OperationsResource.ListRequest |
Wait(string)
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning
the latest state. If the operation is already done, the latest state is immediately returned. If the timeout
specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not
support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort
basis. It may return the latest state before the specified timeout (including immediately), meaning even an
immediate response is no guarantee that the operation is done.
Declaration
public virtual OperationsResource.WaitRequest Wait(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name of the operation resource to wait on. |
Returns
| Type | Description |
|---|---|
| OperationsResource.WaitRequest |