Reference documentation and code samples for the Google Cloud Security Compliance V1 Client class CmEnrollmentServiceClient.
Service Description: Service describing CmEnrollment related RPCs for complianceManager.
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 \ CloudSecurityCompliance \ V1 \ ClientMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
options |
array|Google\ApiCore\Options\ClientOptions
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 |
FetchAuthTokenInterface|CredentialsWrapper
This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly |
↳ 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. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
↳ universeDomain |
string
The service domain for the client. Defaults to 'googleapis.com'. |
calculateEffectiveCmEnrollment
Calculates the effective Compliance Manager enrollment for a resource.
An effective enrollment is either a direct enrollment of a resource (if it exists), or an enrollment of the closest parent of a resource that's enrolled in Compliance Manager.
The async variant is CmEnrollmentServiceClient::calculateEffectiveCmEnrollmentAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\CloudSecurityCompliance\V1\CalculateEffectiveCmEnrollmentRequest
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\CloudSecurityCompliance\V1\CalculateEffectiveCmEnrollmentResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\CalculateEffectiveCmEnrollmentRequest;
use Google\Cloud\CloudSecurityCompliance\V1\CalculateEffectiveCmEnrollmentResponse;
use Google\Cloud\CloudSecurityCompliance\V1\Client\CmEnrollmentServiceClient;
/**
* @param string $formattedName The name of the Compliance Manager enrollment to calculate.
*
* Supported formats are the following:
*
* * `organizations/{organization_id}/locations/{location}/cmEnrollment`
* * `folders/{folder_id}/locations/{location}/cmEnrollment`
* * `projects/{project_id}/locations/{location}/cmEnrollment`
* Please see {@see CmEnrollmentServiceClient::cmEnrollmentName()} for help formatting this field.
*/
function calculate_effective_cm_enrollment_sample(string $formattedName): void
{
// Create a client.
$cmEnrollmentServiceClient = new CmEnrollmentServiceClient();
// Prepare the request message.
$request = (new CalculateEffectiveCmEnrollmentRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var CalculateEffectiveCmEnrollmentResponse $response */
$response = $cmEnrollmentServiceClient->calculateEffectiveCmEnrollment($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 = CmEnrollmentServiceClient::cmEnrollmentName('[ORGANIZATION]', '[LOCATION]');
calculate_effective_cm_enrollment_sample($formattedName);
}
updateCmEnrollment
Updates the Compliance Manager enrollment for a resource to facilitate an audit.
Use this method to enroll a resource in Compliance Manager or to create or update feature-specific configurations.
The async variant is CmEnrollmentServiceClient::updateCmEnrollmentAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\CloudSecurityCompliance\V1\UpdateCmEnrollmentRequest
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\CloudSecurityCompliance\V1\CmEnrollment |
|
use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\Client\CmEnrollmentServiceClient;
use Google\Cloud\CloudSecurityCompliance\V1\CmEnrollment;
use Google\Cloud\CloudSecurityCompliance\V1\UpdateCmEnrollmentRequest;
/**
* 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_cm_enrollment_sample(): void
{
// Create a client.
$cmEnrollmentServiceClient = new CmEnrollmentServiceClient();
// Prepare the request message.
$cmEnrollment = new CmEnrollment();
$request = (new UpdateCmEnrollmentRequest())
->setCmEnrollment($cmEnrollment);
// Call the API and handle any network failures.
try {
/** @var CmEnrollment $response */
$response = $cmEnrollmentServiceClient->updateCmEnrollment($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
getLocation
Gets information about a location.
The async variant is CmEnrollmentServiceClient::getLocationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
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\Location\Location |
|
use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\Client\CmEnrollmentServiceClient;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
/**
* 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 get_location_sample(): void
{
// Create a client.
$cmEnrollmentServiceClient = new CmEnrollmentServiceClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $cmEnrollmentServiceClient->getLocation($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listLocations
Lists information about the supported locations for this service.
The async variant is CmEnrollmentServiceClient::listLocationsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
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 |
|
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\CloudSecurityCompliance\V1\Client\CmEnrollmentServiceClient;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
/**
* 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 list_locations_sample(): void
{
// Create a client.
$cmEnrollmentServiceClient = new CmEnrollmentServiceClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $cmEnrollmentServiceClient->listLocations($request);
/** @var Location $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());
}
}
calculateEffectiveCmEnrollmentAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\CloudSecurityCompliance\V1\CalculateEffectiveCmEnrollmentRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\CloudSecurityCompliance\V1\CalculateEffectiveCmEnrollmentResponse> |
|
updateCmEnrollmentAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\CloudSecurityCompliance\V1\UpdateCmEnrollmentRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\CloudSecurityCompliance\V1\CmEnrollment> |
|
getLocationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location> |
|
listLocationsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
static::cmEnrollmentName
Formats a string containing the fully-qualified path to represent a cm_enrollment resource.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
location |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted cm_enrollment resource. |
static::organizationLocationCmEnrollmentName
Formats a string containing the fully-qualified path to represent a organization_location_cmEnrollment resource.
| Parameters | |
|---|---|
| Name | Description |
organization |
string
|
location |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted organization_location_cmEnrollment resource. |
static::projectLocationCmEnrollmentName
Formats a string containing the fully-qualified path to represent a project_location_cmEnrollment resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted project_location_cmEnrollment 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
- cmEnrollment: organizations/{organization}/locations/{location}/cmEnrollment
- organizationLocationCmEnrollment: organizations/{organization}/locations/{location}/cmEnrollment
- projectLocationCmEnrollment: projects/{project}/locations/{location}/cmEnrollment
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. |