Google Cloud OsConfig V1 Client - Class OsConfigServiceClient (1.3.5)

Namespace

Methods

__construct

cancelPatchJob

use Google\ApiCore\ApiException;
use Google\Cloud\OsConfig\V1\CancelPatchJobRequest;
use Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient;
use Google\Cloud\OsConfig\V1\PatchJob;

/**
 * @param string $formattedName Name of the patch in the form `projects/*/patchJobs/*`
 *                              Please see {@see OsConfigServiceClient::patchJobName()} for help formatting this field.
 */
function cancel_patch_job_sample(string $formattedName): void
{
    // Create a client.
    $osConfigServiceClient = new OsConfigServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PatchJob $response */
        $response = $osConfigServiceClient->cancelPatchJob($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 = OsConfigServiceClient::patchJobName('[PROJECT]', '[PATCH_JOB]');

    cancel_patch_job_sample($formattedName);
}

createPatchDeployment

use Google\ApiCore\ApiException;
use Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient;
use Google\Cloud\OsConfig\V1\CreatePatchDeploymentRequest;
use Google\Cloud\OsConfig\V1\OneTimeSchedule;
use Google\Cloud\OsConfig\V1\PatchDeployment;
use Google\Cloud\OsConfig\V1\PatchInstanceFilter;
use Google\Protobuf\Timestamp;

/**
 * @param string $formattedParent   The project to apply this patch deployment to in the form
 *                                  `projects/*`. Please see
 *                                  {@see OsConfigServiceClient::projectName()} for help formatting this field.
 * @param string $patchDeploymentId A name for the patch deployment in the project. When creating a
 *                                  name the following rules apply:
 *                                  * Must contain only lowercase letters, numbers, and hyphens.
 *                                  * Must start with a letter.
 *                                  * Must be between 1-63 characters.
 *                                  * Must end with a number or a letter.
 *                                  * Must be unique within the project.
 */
function create_patch_deployment_sample(string $formattedParent, string $patchDeploymentId): void
{
    // Create a client.
    $osConfigServiceClient = new OsConfigServiceClient();

    // Prepare the request message.
    $patchDeploymentInstanceFilter = new PatchInstanceFilter();
    $patchDeploymentOneTimeScheduleExecuteTime = new Timestamp();
    $patchDeploymentOneTimeSchedule = (new OneTimeSchedule())
        ->setExecuteTime($patchDeploymentOneTimeScheduleExecuteTime);
    $patchDeployment = (new PatchDeployment())
        ->setInstanceFilter($patchDeploymentInstanceFilter)
        ->setOneTimeSchedule($patchDeploymentOneTimeSchedule);
    $request = (new CreatePatchDeploymentRequest())
        ->setParent($formattedParent)
        ->setPatchDeploymentId($patchDeploymentId)
        ->setPatchDeployment($patchDeployment);

    // Call the API and handle any network failures.
    try {
        /** @var PatchDeployment $response */
        $response = $osConfigServiceClient->createPatchDeployment($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
{
    $formattedParent = OsConfigServiceClient::projectName('[PROJECT]');
    $patchDeploymentId = '[PATCH_DEPLOYMENT_ID]';

    create_patch_deployment_sample($formattedParent, $patchDeploymentId);
}

deletePatchDeployment

use Google\ApiCore\ApiException;
use Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient;
use Google\Cloud\OsConfig\V1\DeletePatchDeploymentRequest;

/**
 * @param string $formattedName The resource name of the patch deployment in the form
 *                              `projects/*/patchDeployments/*`. Please see
 *                              {@see OsConfigServiceClient::patchDeploymentName()} for help formatting this field.
 */
function delete_patch_deployment_sample(string $formattedName): void
{
    // Create a client.
    $osConfigServiceClient = new OsConfigServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $osConfigServiceClient->deletePatchDeployment($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
{
    $formattedName = OsConfigServiceClient::patchDeploymentName('[PROJECT]', '[PATCH_DEPLOYMENT]');

    delete_patch_deployment_sample($formattedName);
}

executePatchJob

use Google\ApiCore\ApiException;
use Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient;
use Google\Cloud\OsConfig\V1\ExecutePatchJobRequest;
use Google\Cloud\OsConfig\V1\PatchInstanceFilter;
use Google\Cloud\OsConfig\V1\PatchJob;

/**
 * @param string $formattedParent The project in which to run this patch in the form `projects/*`
 *                                Please see {@see OsConfigServiceClient::projectName()} for help formatting this field.
 */
function execute_patch_job_sample(string $formattedParent): void
{
    // Create a client.
    $osConfigServiceClient = new OsConfigServiceClient();

    // Prepare the request message.
    $instanceFilter = new PatchInstanceFilter();
    $request = (new ExecutePatchJobRequest())
        ->setParent($formattedParent)
        ->setInstanceFilter($instanceFilter);

    // Call the API and handle any network failures.
    try {
        /** @var PatchJob $response */
        $response = $osConfigServiceClient->executePatchJob($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
{
    $formattedParent = OsConfigServiceClient::projectName('[PROJECT]');

    execute_patch_job_sample($formattedParent);
}

getPatchDeployment

use Google\ApiCore\ApiException;
use Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient;
use Google\Cloud\OsConfig\V1\GetPatchDeploymentRequest;
use Google\Cloud\OsConfig\V1\PatchDeployment;

/**
 * @param string $formattedName The resource name of the patch deployment in the form
 *                              `projects/*/patchDeployments/*`. Please see
 *                              {@see OsConfigServiceClient::patchDeploymentName()} for help formatting this field.
 */
function get_patch_deployment_sample(string $formattedName): void
{
    // Create a client.
    $osConfigServiceClient = new OsConfigServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PatchDeployment $response */
        $response = $osConfigServiceClient->getPatchDeployment($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 = OsConfigServiceClient::patchDeploymentName('[PROJECT]', '[PATCH_DEPLOYMENT]');

    get_patch_deployment_sample($formattedName);
}

getPatchJob

use Google\ApiCore\ApiException;
use Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient;
use Google\Cloud\OsConfig\V1\GetPatchJobRequest;
use Google\Cloud\OsConfig\V1\PatchJob;

/**
 * @param string $formattedName Name of the patch in the form `projects/*/patchJobs/*`
 *                              Please see {@see OsConfigServiceClient::patchJobName()} for help formatting this field.
 */
function get_patch_job_sample(string $formattedName): void
{
    // Create a client.
    $osConfigServiceClient = new OsConfigServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PatchJob $response */
        $response = $osConfigServiceClient->getPatchJob($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 = OsConfigServiceClient::patchJobName('[PROJECT]', '[PATCH_JOB]');

    get_patch_job_sample($formattedName);
}

listPatchDeployments

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient;
use Google\Cloud\OsConfig\V1\ListPatchDeploymentsRequest;
use Google\Cloud\OsConfig\V1\PatchDeployment;

/**
 * @param string $formattedParent The resource name of the parent in the form `projects/*`. Please see
 *                                {@see OsConfigServiceClient::projectName()} for help formatting this field.
 */
function list_patch_deployments_sample(string $formattedParent): void
{
    // Create a client.
    $osConfigServiceClient = new OsConfigServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $osConfigServiceClient->listPatchDeployments($request);

        /** @var PatchDeployment $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 = OsConfigServiceClient::projectName('[PROJECT]');

    list_patch_deployments_sample($formattedParent);
}

listPatchJobInstanceDetails

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient;
use Google\Cloud\OsConfig\V1\ListPatchJobInstanceDetailsRequest;
use Google\Cloud\OsConfig\V1\PatchJobInstanceDetails;

/**
 * @param string $formattedParent The parent for the instances are in the form of
 *                                `projects/*/patchJobs/*`. Please see
 *                                {@see OsConfigServiceClient::patchJobName()} for help formatting this field.
 */
function list_patch_job_instance_details_sample(string $formattedParent): void
{
    // Create a client.
    $osConfigServiceClient = new OsConfigServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $osConfigServiceClient->listPatchJobInstanceDetails($request);

        /** @var PatchJobInstanceDetails $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 = OsConfigServiceClient::patchJobName('[PROJECT]', '[PATCH_JOB]');

    list_patch_job_instance_details_sample($formattedParent);
}

listPatchJobs

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient;
use Google\Cloud\OsConfig\V1\ListPatchJobsRequest;
use Google\Cloud\OsConfig\V1\PatchJob;

/**
 * @param string $formattedParent In the form of `projects/*`
 *                                Please see {@see OsConfigServiceClient::projectName()} for help formatting this field.
 */
function list_patch_jobs_sample(string $formattedParent): void
{
    // Create a client.
    $osConfigServiceClient = new OsConfigServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $osConfigServiceClient->listPatchJobs($request);

        /** @var PatchJob $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 = OsConfigServiceClient::projectName('[PROJECT]');

    list_patch_jobs_sample($formattedParent);
}

pausePatchDeployment

use Google\ApiCore\ApiException;
use Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient;
use Google\Cloud\OsConfig\V1\PatchDeployment;
use Google\Cloud\OsConfig\V1\PausePatchDeploymentRequest;

/**
 * @param string $formattedName The resource name of the patch deployment in the form
 *                              `projects/*/patchDeployments/*`. Please see
 *                              {@see OsConfigServiceClient::patchDeploymentName()} for help formatting this field.
 */
function pause_patch_deployment_sample(string $formattedName): void
{
    // Create a client.
    $osConfigServiceClient = new OsConfigServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PatchDeployment $response */
        $response = $osConfigServiceClient->pausePatchDeployment($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 = OsConfigServiceClient::patchDeploymentName('[PROJECT]', '[PATCH_DEPLOYMENT]');

    pause_patch_deployment_sample($formattedName);
}

resumePatchDeployment

use Google\ApiCore\ApiException;
use Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient;
use Google\Cloud\OsConfig\V1\PatchDeployment;
use Google\Cloud\OsConfig\V1\ResumePatchDeploymentRequest;

/**
 * @param string $formattedName The resource name of the patch deployment in the form
 *                              `projects/*/patchDeployments/*`. Please see
 *                              {@see OsConfigServiceClient::patchDeploymentName()} for help formatting this field.
 */
function resume_patch_deployment_sample(string $formattedName): void
{
    // Create a client.
    $osConfigServiceClient = new OsConfigServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var PatchDeployment $response */
        $response = $osConfigServiceClient->resumePatchDeployment($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 = OsConfigServiceClient::patchDeploymentName('[PROJECT]', '[PATCH_DEPLOYMENT]');

    resume_patch_deployment_sample($formattedName);
}

updatePatchDeployment

use Google\ApiCore\ApiException;
use Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient;
use Google\Cloud\OsConfig\V1\OneTimeSchedule;
use Google\Cloud\OsConfig\V1\PatchDeployment;
use Google\Cloud\OsConfig\V1\PatchInstanceFilter;
use Google\Cloud\OsConfig\V1\UpdatePatchDeploymentRequest;
use Google\Protobuf\Timestamp;

/**
 * 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_patch_deployment_sample(): void
{
    // Create a client.
    $osConfigServiceClient = new OsConfigServiceClient();

    // Prepare the request message.
    $patchDeploymentInstanceFilter = new PatchInstanceFilter();
    $patchDeploymentOneTimeScheduleExecuteTime = new Timestamp();
    $patchDeploymentOneTimeSchedule = (new OneTimeSchedule())
        ->setExecuteTime($patchDeploymentOneTimeScheduleExecuteTime);
    $patchDeployment = (new PatchDeployment())
        ->setInstanceFilter($patchDeploymentInstanceFilter)
        ->setOneTimeSchedule($patchDeploymentOneTimeSchedule);
    $request = (new UpdatePatchDeploymentRequest())
        ->setPatchDeployment($patchDeployment);

    // Call the API and handle any network failures.
    try {
        /** @var PatchDeployment $response */
        $response = $osConfigServiceClient->updatePatchDeployment($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

cancelPatchJobAsync

createPatchDeploymentAsync

deletePatchDeploymentAsync

executePatchJobAsync

getPatchDeploymentAsync

getPatchJobAsync

listPatchDeploymentsAsync

listPatchJobInstanceDetailsAsync

listPatchJobsAsync

pausePatchDeploymentAsync

resumePatchDeploymentAsync

updatePatchDeploymentAsync

static::patchDeploymentName

static::patchJobName

static::projectName

static::parseName