Google Cloud OsConfig V1 Client - Class OsConfigServiceClient (2.0.0-RC1)

Reference documentation and code samples for the Google Cloud OsConfig V1 Client class OsConfigServiceClient.

Service Description: OS Config API

The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ OsConfig \ V1 \ Client

Methods

__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 `false`.
`↳ 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 `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ 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.

cancelPatchJob

Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.

The async variant is Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient::cancelPatchJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\CancelPatchJobRequest` 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\OsConfig\V1\PatchJob`

Example

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/&#42;/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

Create an OS Config patch deployment.

The async variant is Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient::createPatchDeploymentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\CreatePatchDeploymentRequest` 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\OsConfig\V1\PatchDeployment`

Example

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

Delete an OS Config patch deployment.

The async variant is Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient::deletePatchDeploymentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\DeletePatchDeploymentRequest` 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.

Example

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/&#42;/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

Patch VM instances by creating and running a patch job.

The async variant is Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient::executePatchJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\ExecutePatchJobRequest` 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\OsConfig\V1\PatchJob`

Example

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

Get an OS Config patch deployment.

The async variant is Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient::getPatchDeploymentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\GetPatchDeploymentRequest` 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\OsConfig\V1\PatchDeployment`

Example

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/&#42;/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

Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.

The async variant is Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient::getPatchJobAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\GetPatchJobRequest` 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\OsConfig\V1\PatchJob`

Example

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/&#42;/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

Get a page of OS Config patch deployments.

The async variant is Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient::listPatchDeploymentsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\ListPatchDeploymentsRequest` 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`

Example

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

Get a list of instance details for a given patch job.

The async variant is Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient::listPatchJobInstanceDetailsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\ListPatchJobInstanceDetailsRequest` 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`

Example

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/&#42;/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

Get a list of patch jobs.

The async variant is Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient::listPatchJobsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\ListPatchJobsRequest` 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`

Example

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

Change state of patch deployment to "PAUSED".

Patch deployment in paused state doesn't generate patch jobs.

The async variant is Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient::pausePatchDeploymentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\PausePatchDeploymentRequest` 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\OsConfig\V1\PatchDeployment`

Example

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/&#42;/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

Change state of patch deployment back to "ACTIVE".

Patch deployment in active state continues to generate patch jobs.

The async variant is Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient::resumePatchDeploymentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\ResumePatchDeploymentRequest` 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\OsConfig\V1\PatchDeployment`

Example

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/&#42;/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

Update an OS Config patch deployment.

The async variant is Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient::updatePatchDeploymentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\UpdatePatchDeploymentRequest` 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\OsConfig\V1\PatchDeployment`

Example

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

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\CancelPatchJobRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createPatchDeploymentAsync

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\CreatePatchDeploymentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deletePatchDeploymentAsync

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\DeletePatchDeploymentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

executePatchJobAsync

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\ExecutePatchJobRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getPatchDeploymentAsync

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\GetPatchDeploymentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getPatchJobAsync

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\GetPatchJobRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listPatchDeploymentsAsync

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\ListPatchDeploymentsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listPatchJobInstanceDetailsAsync

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\ListPatchJobInstanceDetailsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listPatchJobsAsync

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\ListPatchJobsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

pausePatchDeploymentAsync

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\PausePatchDeploymentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

resumePatchDeploymentAsync

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\ResumePatchDeploymentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updatePatchDeploymentAsync

Parameters
Name	Description
`request`	`Google\Cloud\OsConfig\V1\UpdatePatchDeploymentRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

static::patchDeploymentName

Formats a string containing the fully-qualified path to represent a patch_deployment resource.

Parameters
Name	Description
`project`	`string`
`patchDeployment`	`string`

Returns
Type	Description
`string`	The formatted patch_deployment resource.

static::patchJobName

Formats a string containing the fully-qualified path to represent a patch_job resource.

Parameters
Name	Description
`project`	`string`
`patchJob`	`string`

Returns
Type	Description
`string`	The formatted patch_job resource.

static::projectName

Formats a string containing the fully-qualified path to represent a project resource.

Parameter
Name	Description
`project`	`string`

Returns
Type	Description
`string`	The formatted project resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

patchDeployment: projects/{project}/patchDeployments/{patch_deployment}
patchJob: projects/{project}/patchJobs/{patch_job}
project: projects/{project}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.