Documentation

Google_Service_Translate_Resource_ProjectsLocationsOperations extends Google_Service_Resource
in package

Application

The "operations" collection of methods.

Typical usage is: $translateService = new Google_Service_Translate(...); $operations = $translateService->operations;

$client : Google_Client
$methods : array<string|int, mixed>
$resourceName : string
$rootUrl : string
$serviceName : string
$servicePath : string
$stackParameters : mixed
__construct() : mixed
call() : Google_Http_Request|expectedClass: TODO: This function needs simplifying.
cancel() : Google_Service_Translate_TranslateEmpty: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.
createRequestUri() : string: Parse/expand request parameters and create a fully qualified request uri.
delete() : Google_Service_Translate_TranslateEmpty: 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.
get() : Google_Service_Translate_Operation: 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. (operations.get)
listProjectsLocationsOperations() : Google_Service_Translate_ListOperationsResponse: 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. (operations.listProjectsLocationsOperations)
wait() : Google_Service_Translate_Operation: Waits for the specified long-running operation until it 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. (operations.wait)
convertToArrayAndStripNulls() : mixed

$client


    private
        Google_Client
    $client

$methods


    private
        array<string|int, mixed>
    $methods

$resourceName


    private
        string
    $resourceName

$rootUrl


    private
        string
    $rootUrl

$serviceName


    private
        string
    $serviceName

$servicePath


    private
        string
    $servicePath

$stackParameters


    private
        mixed
    $stackParameters
     = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

__construct()


    public
                __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed

Parameters

$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed

Return values

mixed —

call()

TODO: This function needs simplifying.


    public
                call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass

Parameters

$name :

$arguments :

$expectedClass : = null

optional, the expected class name

Return values

Google_Http_Request|expectedClass —

cancel()

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.


    public
                cancel(string $name, Google_Service_Translate_CancelOperationRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Translate_TranslateEmpty

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. (operations.cancel)

Parameters

$name : string: The name of the operation resource to be cancelled.
$postBody : Google_Service_Translate_CancelOperationRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Translate_TranslateEmpty —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.


    public
                createRequestUri(string $restPath, array<string|int, mixed> $params) : string

Parameters

$restPath : string
$params : array<string|int, mixed>

Return values

string —

$requestUrl

delete()

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.


    public
                delete(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Translate_TranslateEmpty

If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. (operations.delete)

Parameters

$name : string: The name of the operation resource to be deleted.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Translate_TranslateEmpty —

get()

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. (operations.get)


    public
                get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Translate_Operation

Parameters

$name : string: The name of the operation resource.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Translate_Operation —

listProjectsLocationsOperations()

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. (operations.listProjectsLocationsOperations)


    public
                listProjectsLocationsOperations(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Translate_ListOperationsResponse

Parameters

$name : string: The name of the operation's parent resource.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Translate_ListOperationsResponse —

wait()

Waits for the specified long-running operation until it 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. (operations.wait)


    public
                wait(string $name, Google_Service_Translate_WaitOperationRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Translate_Operation

Parameters

$name : string: The name of the operation resource to wait on.
$postBody : Google_Service_Translate_WaitOperationRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Translate_Operation —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —