target.apidocs.com.google.api.services.translate.v3.Translate.Projects.Locations.Operations.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-translate Show documentation

There is a newer version: v3-rev20241218-2.0.0

Show newest version







Translate.Projects.Locations.Operations (Cloud Translation API v3-rev20230428-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.translate.v3
Class Translate.Projects.Locations.Operations



java.lang.Object


com.google.api.services.translate.v3.Translate.Projects.Locations.Operations







Enclosing class:
Translate.Projects.Locations




public class Translate.Projects.Locations.Operations
extends Object
The "operations" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
Translate.Projects.Locations.Operations.Cancel 


class 
Translate.Projects.Locations.Operations.Delete 


class 
Translate.Projects.Locations.Operations.Get 


class 
Translate.Projects.Locations.Operations.List 


class 
Translate.Projects.Locations.Operations.Wait 









Constructor Summary

Constructors 

Constructor and Description


Operations() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Translate.Projects.Locations.Operations.Cancel
cancel(String name,
      CancelOperationRequest content)
Starts asynchronous cancellation on a long-running operation.



Translate.Projects.Locations.Operations.Delete
delete(String name)
Deletes a long-running operation.



Translate.Projects.Locations.Operations.Get
get(String name)
Gets the latest state of a long-running operation.



Translate.Projects.Locations.Operations.List
list(String name)
Lists operations that match the specified filter in the request.



Translate.Projects.Locations.Operations.Wait
wait(String name,
    WaitOperationRequest content)
Waits until the specified long-running operation is done or reaches at most a specified timeout,
 returning the latest state.







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 Translate.Projects.Locations.Operations.Cancel cancel(String name,
                                                             CancelOperationRequest content)
                                                      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 translate 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:
IOException








delete
public Translate.Projects.Locations.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 translate 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 Translate.Projects.Locations.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 translate 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 Translate.Projects.Locations.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 translate 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








wait
public Translate.Projects.Locations.Operations.Wait wait(String name,
                                                         WaitOperationRequest content)
                                                  throws IOException
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.

 Create a request for the method "operations.wait".

 This request holds the parameters needed by the translate 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 wait on.
content - the WaitOperationRequest
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–2023 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`Translate.Projects.Locations.Operations.Cancel`
`class`	`Translate.Projects.Locations.Operations.Delete`
`class`	`Translate.Projects.Locations.Operations.Get`
`class`	`Translate.Projects.Locations.Operations.List`
`class`	`Translate.Projects.Locations.Operations.Wait`

Modifier and Type	Method and Description
`Translate.Projects.Locations.Operations.Cancel`	`cancel(String name, CancelOperationRequest content)` Starts asynchronous cancellation on a long-running operation.
`Translate.Projects.Locations.Operations.Delete`	`delete(String name)` Deletes a long-running operation.
`Translate.Projects.Locations.Operations.Get`	`get(String name)` Gets the latest state of a long-running operation.
`Translate.Projects.Locations.Operations.List`	`list(String name)` Lists operations that match the specified filter in the request.
`Translate.Projects.Locations.Operations.Wait`	`wait(String name, WaitOperationRequest content)` Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.