Google Cloud OsConfig V1 Client - Class OsConfigServiceClient (1.2.2)

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. Sample code to get started:

$osConfigServiceClient = new OsConfigServiceClient();
try {
    $formattedName = $osConfigServiceClient->patchJobName('[PROJECT]', '[PATCH_JOB]');
    $response = $osConfigServiceClient->cancelPatchJob($formattedName);
} finally {
    $osConfigServiceClient->close();
}

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.

This service has a new (beta) implementation. See Google\Cloud\OsConfig\V1\Client\OsConfigServiceClient to use the new surface.

Namespace

Google \ Cloud \ OsConfig \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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.

Parameters
NameDescription
name string

Required. Name of the patch in the form projects/*/patchJobs/*

optionalArgs 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
TypeDescription
Google\Cloud\OsConfig\V1\PatchJob
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OsConfig\V1\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();

    // Call the API and handle any network failures.
    try {
        /** @var PatchJob $response */
        $response = $osConfigServiceClient->cancelPatchJob($formattedName);
        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.

Parameters
NameDescription
parent string

Required. The project to apply this patch deployment to in the form projects/*.

patchDeploymentId string

Required. 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.
patchDeployment Google\Cloud\OsConfig\V1\PatchDeployment

Required. The patch deployment to create.

optionalArgs 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
TypeDescription
Google\Cloud\OsConfig\V1\PatchDeployment
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OsConfig\V1\OneTimeSchedule;
use Google\Cloud\OsConfig\V1\OsConfigServiceClient;
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 any non-scalar elements to be passed along with the request.
    $patchDeploymentInstanceFilter = new PatchInstanceFilter();
    $patchDeploymentOneTimeScheduleExecuteTime = new Timestamp();
    $patchDeploymentOneTimeSchedule = (new OneTimeSchedule())
        ->setExecuteTime($patchDeploymentOneTimeScheduleExecuteTime);
    $patchDeployment = (new PatchDeployment())
        ->setInstanceFilter($patchDeploymentInstanceFilter)
        ->setOneTimeSchedule($patchDeploymentOneTimeSchedule);

    // Call the API and handle any network failures.
    try {
        /** @var PatchDeployment $response */
        $response = $osConfigServiceClient->createPatchDeployment(
            $formattedParent,
            $patchDeploymentId,
            $patchDeployment
        );
        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.

Parameters
NameDescription
name string

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

optionalArgs 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\OsConfigServiceClient;

/**
 * @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();

    // Call the API and handle any network failures.
    try {
        $osConfigServiceClient->deletePatchDeployment($formattedName);
        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.

Parameters
NameDescription
parent string

Required. The project in which to run this patch in the form projects/*

instanceFilter Google\Cloud\OsConfig\V1\PatchInstanceFilter

Required. Instances to patch, either explicitly or filtered by some criteria such as zone or labels.

optionalArgs array

Optional.

↳ description string

Description of the patch job. Length of the description is limited to 1024 characters.

↳ patchConfig PatchConfig

Patch configuration being applied. If omitted, instances are patched using the default configurations.

↳ duration Duration

Duration of the patch job. After the duration ends, the patch job times out.

↳ dryRun bool

If this patch is a dry-run only, instances are contacted but will do nothing.

↳ displayName string

Display name for this patch job. This does not have to be unique.

↳ rollout PatchRollout

Rollout strategy of the patch job.

↳ 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
TypeDescription
Google\Cloud\OsConfig\V1\PatchJob
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OsConfig\V1\OsConfigServiceClient;
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 any non-scalar elements to be passed along with the request.
    $instanceFilter = new PatchInstanceFilter();

    // Call the API and handle any network failures.
    try {
        /** @var PatchJob $response */
        $response = $osConfigServiceClient->executePatchJob($formattedParent, $instanceFilter);
        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.

Parameters
NameDescription
name string

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

optionalArgs 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
TypeDescription
Google\Cloud\OsConfig\V1\PatchDeployment
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OsConfig\V1\OsConfigServiceClient;
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();

    // Call the API and handle any network failures.
    try {
        /** @var PatchDeployment $response */
        $response = $osConfigServiceClient->getPatchDeployment($formattedName);
        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.

Parameters
NameDescription
name string

Required. Name of the patch in the form projects/*/patchJobs/*

optionalArgs 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
TypeDescription
Google\Cloud\OsConfig\V1\PatchJob
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OsConfig\V1\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 get_patch_job_sample(string $formattedName): void
{
    // Create a client.
    $osConfigServiceClient = new OsConfigServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var PatchJob $response */
        $response = $osConfigServiceClient->getPatchJob($formattedName);
        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.

Parameters
NameDescription
parent string

Required. The resource name of the parent in the form projects/*.

optionalArgs array

Optional.

↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

↳ 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
TypeDescription
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OsConfig\V1\OsConfigServiceClient;
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();

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

        /** @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.

Parameters
NameDescription
parent string

Required. The parent for the instances are in the form of projects/*/patchJobs/*.

optionalArgs array

Optional.

↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

↳ filter string

A filter expression that filters results listed in the response. This field supports filtering results by instance zone, name, state, or failure_reason.

↳ 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
TypeDescription
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OsConfig\V1\OsConfigServiceClient;
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();

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

        /** @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.

Parameters
NameDescription
parent string

Required. In the form of projects/*

optionalArgs array

Optional.

↳ pageSize int

The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.

↳ pageToken string

A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.

↳ filter string

If provided, this field specifies the criteria that must be met by patch jobs to be included in the response. Currently, filtering is only available on the patch_deployment field.

↳ 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
TypeDescription
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\OsConfig\V1\OsConfigServiceClient;
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();

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

        /** @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.

Parameters
NameDescription
name string

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

optionalArgs 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
TypeDescription
Google\Cloud\OsConfig\V1\PatchDeployment
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OsConfig\V1\OsConfigServiceClient;
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 pause_patch_deployment_sample(string $formattedName): void
{
    // Create a client.
    $osConfigServiceClient = new OsConfigServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var PatchDeployment $response */
        $response = $osConfigServiceClient->pausePatchDeployment($formattedName);
        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.

Parameters
NameDescription
name string

Required. The resource name of the patch deployment in the form projects/*/patchDeployments/*.

optionalArgs 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
TypeDescription
Google\Cloud\OsConfig\V1\PatchDeployment
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OsConfig\V1\OsConfigServiceClient;
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 resume_patch_deployment_sample(string $formattedName): void
{
    // Create a client.
    $osConfigServiceClient = new OsConfigServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var PatchDeployment $response */
        $response = $osConfigServiceClient->resumePatchDeployment($formattedName);
        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.

Parameters
NameDescription
patchDeployment Google\Cloud\OsConfig\V1\PatchDeployment

Required. The patch deployment to Update.

optionalArgs array

Optional.

↳ updateMask FieldMask

Optional. Field mask that controls which fields of the patch deployment should be updated.

↳ 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
TypeDescription
Google\Cloud\OsConfig\V1\PatchDeployment
Example
use Google\ApiCore\ApiException;
use Google\Cloud\OsConfig\V1\OneTimeSchedule;
use Google\Cloud\OsConfig\V1\OsConfigServiceClient;
use Google\Cloud\OsConfig\V1\PatchDeployment;
use Google\Cloud\OsConfig\V1\PatchInstanceFilter;
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 any non-scalar elements to be passed along with the request.
    $patchDeploymentInstanceFilter = new PatchInstanceFilter();
    $patchDeploymentOneTimeScheduleExecuteTime = new Timestamp();
    $patchDeploymentOneTimeSchedule = (new OneTimeSchedule())
        ->setExecuteTime($patchDeploymentOneTimeScheduleExecuteTime);
    $patchDeployment = (new PatchDeployment())
        ->setInstanceFilter($patchDeploymentInstanceFilter)
        ->setOneTimeSchedule($patchDeploymentOneTimeSchedule);

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

static::patchDeploymentName

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

Parameters
NameDescription
project string
patchDeployment string
Returns
TypeDescription
stringThe formatted patch_deployment resource.

static::patchJobName

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

Parameters
NameDescription
project string
patchJob string
Returns
TypeDescription
stringThe formatted patch_job resource.

static::projectName

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

Parameter
NameDescription
project string
Returns
TypeDescription
stringThe 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
NameDescription
formattedName string

The formatted name string

template string

Optional name of template to match

Returns
TypeDescription
arrayAn associative array from name component IDs to component values.

Constants

SERVICE_NAME

Value: 'google.cloud.osconfig.v1.OsConfigService'

The name of the service.

SERVICE_ADDRESS

Value: 'osconfig.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.