Google Cloud OsConfig V1 Client - Class OsConfigZonalServiceClient (1.1.1)

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

Service Description: Zonal OS Config API

This class is currently experimental and may be subject to changes.

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.

createOSPolicyAssignment

Create an OS policy assignment.

This method also creates the first revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::createOSPolicyAssignmentAsync() .

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

deleteOSPolicyAssignment

Delete the OS policy assignment.

This method creates a new revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::deleteOSPolicyAssignmentAsync() .

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

getInventory

Get inventory data for the specified VM instance. If the VM has no associated inventory, the message NOT_FOUND is returned.

The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::getInventoryAsync() .

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

getOSPolicyAssignment

Retrieve an existing OS policy assignment.

This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the name parameter.

The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::getOSPolicyAssignmentAsync() .

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

getOSPolicyAssignmentReport

Get the OS policy asssignment report for the specified Compute Engine VM instance.

The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::getOSPolicyAssignmentReportAsync() .

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

getVulnerabilityReport

Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.

The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::getVulnerabilityReportAsync() .

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

listInventories

List inventory data for all VM instances in the specified zone.

The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::listInventoriesAsync() .

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

listOSPolicyAssignmentReports

List OS policy asssignment reports for all Compute Engine VM instances in the specified zone.

The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::listOSPolicyAssignmentReportsAsync() .

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

listOSPolicyAssignmentRevisions

List the OS policy assignment revisions for a given OS policy assignment.

The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::listOSPolicyAssignmentRevisionsAsync() .

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

listOSPolicyAssignments

List the OS policy assignments under the parent resource.

For each OS policy assignment, the latest revision is returned.

The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::listOSPolicyAssignmentsAsync() .

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

listVulnerabilityReports

List vulnerability reports for all VM instances in the specified zone.

The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::listVulnerabilityReportsAsync() .

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

updateOSPolicyAssignment

Update an existing OS policy assignment.

This method creates a new revision of the OS policy assignment.

This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO.

For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

The async variant is Google\Cloud\OsConfig\V1\Client\BaseClient\self::updateOSPolicyAssignmentAsync() .

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

createOSPolicyAssignmentAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteOSPolicyAssignmentAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getInventoryAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOSPolicyAssignmentAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOSPolicyAssignmentReportAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getVulnerabilityReportAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listInventoriesAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listOSPolicyAssignmentReportsAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listOSPolicyAssignmentRevisionsAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listOSPolicyAssignmentsAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listVulnerabilityReportsAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateOSPolicyAssignmentAsync

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

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::instanceName

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

Parameters
Name	Description
`project`	`string`
`zone`	`string`
`instance`	`string`

Returns
Type	Description
`string`	The formatted instance resource.

static::instanceOSPolicyAssignmentName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`instance`	`string`
`assignment`	`string`

Returns
Type	Description
`string`	The formatted instance_os_policy_assignment resource.

static::inventoryName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`instance`	`string`

Returns
Type	Description
`string`	The formatted inventory resource.

static::locationName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

static::oSPolicyAssignmentName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`osPolicyAssignment`	`string`

Returns
Type	Description
`string`	The formatted os_policy_assignment resource.

static::oSPolicyAssignmentReportName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`instance`	`string`
`assignment`	`string`

Returns
Type	Description
`string`	The formatted os_policy_assignment_report resource.

static::projectLocationInstanceName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`instance`	`string`

Returns
Type	Description
`string`	The formatted project_location_instance resource.

static::projectZoneInstanceName

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

Parameters
Name	Description
`project`	`string`
`zone`	`string`
`instance`	`string`

Returns
Type	Description
`string`	The formatted project_zone_instance resource.

static::vulnerabilityReportName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`instance`	`string`

Returns
Type	Description
`string`	The formatted vulnerability_report 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

instance: projects/{project}/zones/{zone}/instances/{instance}
instanceOSPolicyAssignment: projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}
inventory: projects/{project}/locations/{location}/instances/{instance}/inventory
location: projects/{project}/locations/{location}
oSPolicyAssignment: projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}
oSPolicyAssignmentReport: projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report
projectLocationInstance: projects/{project}/locations/{location}/instances/{instance}
projectZoneInstance: projects/{project}/zones/{zone}/instances/{instance}
vulnerabilityReport: projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport

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.