Google Cloud Run V2 Client - Class JobsClient (1.4.0)

Namespace

Methods

__construct

createJob

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Run\V2\Client\JobsClient;
use Google\Cloud\Run\V2\CreateJobRequest;
use Google\Cloud\Run\V2\ExecutionTemplate;
use Google\Cloud\Run\V2\Job;
use Google\Cloud\Run\V2\TaskTemplate;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The location and project in which this Job should be created.
 *                                Format: projects/{project}/locations/{location}, where {project} can be
 *                                project id or number. Please see
 *                                {@see JobsClient::locationName()} for help formatting this field.
 * @param string $jobId           The unique identifier for the Job. The name of the job becomes
 *                                {parent}/jobs/{job_id}.
 */
function create_job_sample(string $formattedParent, string $jobId): void
{
    // Create a client.
    $jobsClient = new JobsClient();

    // Prepare the request message.
    $jobTemplateTemplate = new TaskTemplate();
    $jobTemplate = (new ExecutionTemplate())
        ->setTemplate($jobTemplateTemplate);
    $job = (new Job())
        ->setTemplate($jobTemplate);
    $request = (new CreateJobRequest())
        ->setParent($formattedParent)
        ->setJob($job)
        ->setJobId($jobId);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $jobsClient->createJob($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
{
    $formattedParent = JobsClient::locationName('[PROJECT]', '[LOCATION]');
    $jobId = '[JOB_ID]';

    create_job_sample($formattedParent, $jobId);
}

deleteJob

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Run\V2\Client\JobsClient;
use Google\Cloud\Run\V2\DeleteJobRequest;
use Google\Cloud\Run\V2\Job;
use Google\Rpc\Status;

/**
 * @param string $formattedName The full name of the Job.
 *                              Format: projects/{project}/locations/{location}/jobs/{job}, where {project}
 *                              can be project id or number. Please see
 *                              {@see JobsClient::jobName()} for help formatting this field.
 */
function delete_job_sample(string $formattedName): void
{
    // Create a client.
    $jobsClient = new JobsClient();

    // Prepare the request message.
    $request = (new DeleteJobRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $jobsClient->deleteJob($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
{
    $formattedName = JobsClient::jobName('[PROJECT]', '[LOCATION]', '[JOB]');

    delete_job_sample($formattedName);
}

getIamPolicy

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Run\V2\Client\JobsClient;

/**
 * @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.
    $jobsClient = new JobsClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $jobsClient->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);
}

getJob

use Google\ApiCore\ApiException;
use Google\Cloud\Run\V2\Client\JobsClient;
use Google\Cloud\Run\V2\GetJobRequest;
use Google\Cloud\Run\V2\Job;

/**
 * @param string $formattedName The full name of the Job.
 *                              Format: projects/{project}/locations/{location}/jobs/{job}, where {project}
 *                              can be project id or number. Please see
 *                              {@see JobsClient::jobName()} for help formatting this field.
 */
function get_job_sample(string $formattedName): void
{
    // Create a client.
    $jobsClient = new JobsClient();

    // Prepare the request message.
    $request = (new GetJobRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Job $response */
        $response = $jobsClient->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
{
    $formattedName = JobsClient::jobName('[PROJECT]', '[LOCATION]', '[JOB]');

    get_job_sample($formattedName);
}

listJobs

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Run\V2\Client\JobsClient;
use Google\Cloud\Run\V2\Job;
use Google\Cloud\Run\V2\ListJobsRequest;

/**
 * @param string $formattedParent The location and project to list resources on.
 *                                Format: projects/{project}/locations/{location}, where {project} can be
 *                                project id or number. Please see
 *                                {@see JobsClient::locationName()} for help formatting this field.
 */
function list_jobs_sample(string $formattedParent): void
{
    // Create a client.
    $jobsClient = new JobsClient();

    // Prepare the request message.
    $request = (new ListJobsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $jobsClient->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
{
    $formattedParent = JobsClient::locationName('[PROJECT]', '[LOCATION]');

    list_jobs_sample($formattedParent);
}

runJob

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Run\V2\Client\JobsClient;
use Google\Cloud\Run\V2\Execution;
use Google\Cloud\Run\V2\RunJobRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The full name of the Job.
 *                              Format: projects/{project}/locations/{location}/jobs/{job}, where {project}
 *                              can be project id or number. Please see
 *                              {@see JobsClient::jobName()} for help formatting this field.
 */
function run_job_sample(string $formattedName): void
{
    // Create a client.
    $jobsClient = new JobsClient();

    // Prepare the request message.
    $request = (new RunJobRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $jobsClient->runJob($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var Execution $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
{
    $formattedName = JobsClient::jobName('[PROJECT]', '[LOCATION]', '[JOB]');

    run_job_sample($formattedName);
}

setIamPolicy

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\Run\V2\Client\JobsClient;

/**
 * @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.
    $jobsClient = new JobsClient();

    // 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 = $jobsClient->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

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\Run\V2\Client\JobsClient;

/**
 * @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.
    $jobsClient = new JobsClient();

    // 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 = $jobsClient->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);
}

updateJob

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Run\V2\Client\JobsClient;
use Google\Cloud\Run\V2\ExecutionTemplate;
use Google\Cloud\Run\V2\Job;
use Google\Cloud\Run\V2\TaskTemplate;
use Google\Cloud\Run\V2\UpdateJobRequest;
use Google\Rpc\Status;

/**
 * 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 update_job_sample(): void
{
    // Create a client.
    $jobsClient = new JobsClient();

    // Prepare the request message.
    $jobTemplateTemplate = new TaskTemplate();
    $jobTemplate = (new ExecutionTemplate())
        ->setTemplate($jobTemplateTemplate);
    $job = (new Job())
        ->setTemplate($jobTemplate);
    $request = (new UpdateJobRequest())
        ->setJob($job);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $jobsClient->updateJob($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());
    }
}

createJobAsync

deleteJobAsync

getIamPolicyAsync

getJobAsync

listJobsAsync

runJobAsync

setIamPolicyAsync

testIamPermissionsAsync

updateJobAsync

getOperationsClient

resumeOperation

static::connectorName

static::cryptoKeyName

static::executionName

static::jobName

static::locationName

static::locationPolicyName

static::policyName

static::projectPolicyName

static::secretName

static::secretVersionName

static::parseName