Documentation

Google_Service_Dataproc_Resource_ProjectsRegionsOperations extends Google_Service_Resource
in package

Application

The "operations" collection of methods.

Typical usage is: $dataprocService = new Google_Service_Dataproc(...); $operations = $dataprocService->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_Dataproc_DataprocEmpty: 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_Dataproc_DataprocEmpty: 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_Dataproc_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)
getIamPolicy() : Google_Service_Dataproc_Policy: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (operations.getIamPolicy)
listProjectsRegionsOperations() : Google_Service_Dataproc_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.
setIamPolicy() : Google_Service_Dataproc_Policy: Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (operations.setIamPolicy)
testIamPermissions() : Google_Service_Dataproc_TestIamPermissionsResponse: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.
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[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_DataprocEmpty

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.
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_DataprocEmpty —

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_Dataproc_DataprocEmpty

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_Dataproc_DataprocEmpty —

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_Dataproc_Operation

Parameters

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

Return values

Google_Service_Dataproc_Operation —

getIamPolicy()

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (operations.getIamPolicy)


    public
                getIamPolicy(string $resource, Google_Service_Dataproc_GetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_Dataproc_GetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_Policy —

listProjectsRegionsOperations()

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.


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

(operations.listProjectsRegionsOperations)

Parameters

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

Return values

Google_Service_Dataproc_ListOperationsResponse —

setIamPolicy()

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (operations.setIamPolicy)


    public
                setIamPolicy(string $resource, Google_Service_Dataproc_SetIamPolicyRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_Policy

Parameters

$resource : string: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_Dataproc_SetIamPolicyRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_Policy —

testIamPermissions()

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.


    public
                testIamPermissions(string $resource, Google_Service_Dataproc_TestIamPermissionsRequest $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Dataproc_TestIamPermissionsResponse

This operation may "fail open" without warning. (operations.testIamPermissions)

Parameters

$resource : string: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
$postBody : Google_Service_Dataproc_TestIamPermissionsRequest
$optParams : array<string|int, mixed> = array(): Optional parameters.

Return values

Google_Service_Dataproc_TestIamPermissionsResponse —

convertToArrayAndStripNulls()


    protected
                convertToArrayAndStripNulls(mixed $o) : mixed

Parameters

$o : mixed

Return values

mixed —