Reference documentation and code samples for the Google Cloud OsConfig V1 Client class OsConfigServiceClient.
Service Description: OS Config API
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ OsConfig \ V1 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
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\BaseClient\self::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 |
createPatchDeployment
Create an OS Config patch deployment.
The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::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 |
deletePatchDeployment
Delete an OS Config patch deployment.
The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::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. |
executePatchJob
Patch VM instances by creating and running a patch job.
The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::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 |
getPatchDeployment
Get an OS Config patch deployment.
The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::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 |
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\BaseClient\self::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 |
listPatchDeployments
Get a page of OS Config patch deployments.
The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::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 |
listPatchJobInstanceDetails
Get a list of instance details for a given patch job.
The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::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 |
listPatchJobs
Get a list of patch jobs.
The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::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 |
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\BaseClient\self::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 |
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\BaseClient\self::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 |
updatePatchDeployment
Update an OS Config patch deployment.
The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::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 |
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. |