Reference documentation and code samples for the Google Cloud Dataproc V1 Client class JobControllerClient.
Service Description: The JobController provides methods to manage jobs.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Namespace
Google \ Cloud \ Dataproc \ V1 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
cancelJob
Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.
The async variant is JobControllerClient::cancelJobAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataproc\V1\CancelJobRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataproc\V1\Job |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\CancelJobRequest;
use Google\Cloud\Dataproc\V1\Client\JobControllerClient;
use Google\Cloud\Dataproc\V1\Job;
/**
* @param string $projectId The ID of the Google Cloud Platform project that the job
* belongs to.
* @param string $region The Dataproc region in which to handle the request.
* @param string $jobId The job ID.
*/
function cancel_job_sample(string $projectId, string $region, string $jobId): void
{
// Create a client.
$jobControllerClient = new JobControllerClient();
// Prepare the request message.
$request = (new CancelJobRequest())
->setProjectId($projectId)
->setRegion($region)
->setJobId($jobId);
// Call the API and handle any network failures.
try {
/** @var Job $response */
$response = $jobControllerClient->cancelJob($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$projectId = '[PROJECT_ID]';
$region = '[REGION]';
$jobId = '[JOB_ID]';
cancel_job_sample($projectId, $region, $jobId);
}
deleteJob
Deletes the job from the project. If the job is active, the delete fails,
and the response returns FAILED_PRECONDITION
.
The async variant is JobControllerClient::deleteJobAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataproc\V1\DeleteJobRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\JobControllerClient;
use Google\Cloud\Dataproc\V1\DeleteJobRequest;
/**
* @param string $projectId The ID of the Google Cloud Platform project that the job
* belongs to.
* @param string $region The Dataproc region in which to handle the request.
* @param string $jobId The job ID.
*/
function delete_job_sample(string $projectId, string $region, string $jobId): void
{
// Create a client.
$jobControllerClient = new JobControllerClient();
// Prepare the request message.
$request = (new DeleteJobRequest())
->setProjectId($projectId)
->setRegion($region)
->setJobId($jobId);
// Call the API and handle any network failures.
try {
$jobControllerClient->deleteJob($request);
printf('Call completed successfully.' . PHP_EOL);
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$projectId = '[PROJECT_ID]';
$region = '[REGION]';
$jobId = '[JOB_ID]';
delete_job_sample($projectId, $region, $jobId);
}
getJob
Gets the resource representation for a job in a project.
The async variant is JobControllerClient::getJobAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataproc\V1\GetJobRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataproc\V1\Job |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\JobControllerClient;
use Google\Cloud\Dataproc\V1\GetJobRequest;
use Google\Cloud\Dataproc\V1\Job;
/**
* @param string $projectId The ID of the Google Cloud Platform project that the job
* belongs to.
* @param string $region The Dataproc region in which to handle the request.
* @param string $jobId The job ID.
*/
function get_job_sample(string $projectId, string $region, string $jobId): void
{
// Create a client.
$jobControllerClient = new JobControllerClient();
// Prepare the request message.
$request = (new GetJobRequest())
->setProjectId($projectId)
->setRegion($region)
->setJobId($jobId);
// Call the API and handle any network failures.
try {
/** @var Job $response */
$response = $jobControllerClient->getJob($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$projectId = '[PROJECT_ID]';
$region = '[REGION]';
$jobId = '[JOB_ID]';
get_job_sample($projectId, $region, $jobId);
}
listJobs
Lists regions/{region}/jobs in a project.
The async variant is JobControllerClient::listJobsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataproc\V1\ListJobsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\PagedListResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Dataproc\V1\Client\JobControllerClient;
use Google\Cloud\Dataproc\V1\Job;
use Google\Cloud\Dataproc\V1\ListJobsRequest;
/**
* @param string $projectId The ID of the Google Cloud Platform project that the job
* belongs to.
* @param string $region The Dataproc region in which to handle the request.
*/
function list_jobs_sample(string $projectId, string $region): void
{
// Create a client.
$jobControllerClient = new JobControllerClient();
// Prepare the request message.
$request = (new ListJobsRequest())
->setProjectId($projectId)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $jobControllerClient->listJobs($request);
/** @var Job $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$projectId = '[PROJECT_ID]';
$region = '[REGION]';
list_jobs_sample($projectId, $region);
}
submitJob
Submits a job to a cluster.
The async variant is JobControllerClient::submitJobAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataproc\V1\SubmitJobRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataproc\V1\Job |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\JobControllerClient;
use Google\Cloud\Dataproc\V1\Job;
use Google\Cloud\Dataproc\V1\JobPlacement;
use Google\Cloud\Dataproc\V1\SubmitJobRequest;
/**
* @param string $projectId The ID of the Google Cloud Platform project that the job
* belongs to.
* @param string $region The Dataproc region in which to handle the request.
* @param string $jobPlacementClusterName The name of the cluster where the job will be submitted.
*/
function submit_job_sample(
string $projectId,
string $region,
string $jobPlacementClusterName
): void {
// Create a client.
$jobControllerClient = new JobControllerClient();
// Prepare the request message.
$jobPlacement = (new JobPlacement())
->setClusterName($jobPlacementClusterName);
$job = (new Job())
->setPlacement($jobPlacement);
$request = (new SubmitJobRequest())
->setProjectId($projectId)
->setRegion($region)
->setJob($job);
// Call the API and handle any network failures.
try {
/** @var Job $response */
$response = $jobControllerClient->submitJob($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$projectId = '[PROJECT_ID]';
$region = '[REGION]';
$jobPlacementClusterName = '[CLUSTER_NAME]';
submit_job_sample($projectId, $region, $jobPlacementClusterName);
}
submitJobAsOperation
Submits job to a cluster.
The async variant is JobControllerClient::submitJobAsOperationAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataproc\V1\SubmitJobRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Dataproc\V1\Client\JobControllerClient;
use Google\Cloud\Dataproc\V1\Job;
use Google\Cloud\Dataproc\V1\JobPlacement;
use Google\Cloud\Dataproc\V1\SubmitJobRequest;
use Google\Rpc\Status;
/**
* @param string $projectId The ID of the Google Cloud Platform project that the job
* belongs to.
* @param string $region The Dataproc region in which to handle the request.
* @param string $jobPlacementClusterName The name of the cluster where the job will be submitted.
*/
function submit_job_as_operation_sample(
string $projectId,
string $region,
string $jobPlacementClusterName
): void {
// Create a client.
$jobControllerClient = new JobControllerClient();
// Prepare the request message.
$jobPlacement = (new JobPlacement())
->setClusterName($jobPlacementClusterName);
$job = (new Job())
->setPlacement($jobPlacement);
$request = (new SubmitJobRequest())
->setProjectId($projectId)
->setRegion($region)
->setJob($job);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $jobControllerClient->submitJobAsOperation($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Job $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$projectId = '[PROJECT_ID]';
$region = '[REGION]';
$jobPlacementClusterName = '[CLUSTER_NAME]';
submit_job_as_operation_sample($projectId, $region, $jobPlacementClusterName);
}
updateJob
Updates a job in a project.
The async variant is JobControllerClient::updateJobAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataproc\V1\UpdateJobRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Dataproc\V1\Job |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\JobControllerClient;
use Google\Cloud\Dataproc\V1\Job;
use Google\Cloud\Dataproc\V1\JobPlacement;
use Google\Cloud\Dataproc\V1\UpdateJobRequest;
use Google\Protobuf\FieldMask;
/**
* @param string $projectId The ID of the Google Cloud Platform project that the job
* belongs to.
* @param string $region The Dataproc region in which to handle the request.
* @param string $jobId The job ID.
* @param string $jobPlacementClusterName The name of the cluster where the job will be submitted.
*/
function update_job_sample(
string $projectId,
string $region,
string $jobId,
string $jobPlacementClusterName
): void {
// Create a client.
$jobControllerClient = new JobControllerClient();
// Prepare the request message.
$jobPlacement = (new JobPlacement())
->setClusterName($jobPlacementClusterName);
$job = (new Job())
->setPlacement($jobPlacement);
$updateMask = new FieldMask();
$request = (new UpdateJobRequest())
->setProjectId($projectId)
->setRegion($region)
->setJobId($jobId)
->setJob($job)
->setUpdateMask($updateMask);
// Call the API and handle any network failures.
try {
/** @var Job $response */
$response = $jobControllerClient->updateJob($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$projectId = '[PROJECT_ID]';
$region = '[REGION]';
$jobId = '[JOB_ID]';
$jobPlacementClusterName = '[CLUSTER_NAME]';
update_job_sample($projectId, $region, $jobId, $jobPlacementClusterName);
}
getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
The async variant is JobControllerClient::getIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\JobControllerClient;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
/**
* @param string $resource REQUIRED: The resource for which the policy is being requested.
* See the operation documentation for the appropriate value for this field.
*/
function get_iam_policy_sample(string $resource): void
{
// Create a client.
$jobControllerClient = new JobControllerClient();
// Prepare the request message.
$request = (new GetIamPolicyRequest())
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $jobControllerClient->getIamPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
get_iam_policy_sample($resource);
}
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND
, INVALID_ARGUMENT
, and PERMISSION_DENIED
errors.
The async variant is JobControllerClient::setIamPolicyAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\Policy |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\JobControllerClient;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
/**
* @param string $resource REQUIRED: The resource for which the policy is being specified.
* See the operation documentation for the appropriate value for this field.
*/
function set_iam_policy_sample(string $resource): void
{
// Create a client.
$jobControllerClient = new JobControllerClient();
// Prepare the request message.
$policy = new Policy();
$request = (new SetIamPolicyRequest())
->setResource($resource)
->setPolicy($policy);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $jobControllerClient->setIamPolicy($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
set_iam_policy_sample($resource);
}
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. This operation may "fail open" without warning.
The async variant is JobControllerClient::testIamPermissionsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
Returns | |
---|---|
Type | Description |
Google\Cloud\Iam\V1\TestIamPermissionsResponse |
use Google\ApiCore\ApiException;
use Google\Cloud\Dataproc\V1\Client\JobControllerClient;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
/**
* @param string $resource REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
* @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more
* information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
// Create a client.
$jobControllerClient = new JobControllerClient();
// Prepare the request message.
$permissions = [$permissionsElement,];
$request = (new TestIamPermissionsRequest())
->setResource($resource)
->setPermissions($permissions);
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $jobControllerClient->testIamPermissions($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* Helper to execute the sample.
*
* This sample has been automatically generated and should be regarded as a code
* template only. It will require modifications to work:
* - It may require correct/in-range values for request initialization.
* - It may require specifying regional endpoints when creating the service client,
* please see the apiEndpoint client configuration option for more details.
*/
function callSample(): void
{
$resource = '[RESOURCE]';
$permissionsElement = '[PERMISSIONS]';
test_iam_permissions_sample($resource, $permissionsElement);
}
cancelJobAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataproc\V1\CancelJobRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataproc\V1\Job> |
deleteJobAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataproc\V1\DeleteJobRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
getJobAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataproc\V1\GetJobRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataproc\V1\Job> |
listJobsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataproc\V1\ListJobsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
submitJobAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataproc\V1\SubmitJobRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataproc\V1\Job> |
submitJobAsOperationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataproc\V1\SubmitJobRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
updateJobAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Dataproc\V1\UpdateJobRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Dataproc\V1\Job> |
getIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> |
setIamPolicyAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> |
testIamPermissionsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\TestIamPermissionsResponse> |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\LongRunning\Client\OperationsClient |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
Parameters | |
---|---|
Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
Returns | |
---|---|
Type | Description |
Google\ApiCore\OperationResponse |