Google Cloud Security Compliance V1 Client - Class MonitoringClient (0.2.0)

Reference documentation and code samples for the Google Cloud Security Compliance V1 Client class MonitoringClient.

Service Description: Service describing handlers for resources

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 \ Client

Methods

__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 use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\CloudSecurityCompliance\V1\MonitoringClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new MonitoringClient(['credentials' => $creds]); https://cloud.google.com/docs/authentication/external/externally-sourced-credentials

↳ 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.

↳ 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'.

aggregateFrameworkComplianceReport

Gets the aggregated compliance report over time for a given scope.

The async variant is MonitoringClient::aggregateFrameworkComplianceReportAsync() .

Parameters
Name Description
request Google\Cloud\CloudSecurityCompliance\V1\AggregateFrameworkComplianceReportRequest

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\AggregateFrameworkComplianceReportResponse
Example
use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\AggregateFrameworkComplianceReportRequest;
use Google\Cloud\CloudSecurityCompliance\V1\AggregateFrameworkComplianceReportResponse;
use Google\Cloud\CloudSecurityCompliance\V1\Client\MonitoringClient;

/**
 * @param string $formattedName The name of the aggregated compliance report over time to
 *                              retrieve.
 *
 *                              The supported format is:
 *                              `organizations/{organization_id}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}`
 *                              Please see {@see MonitoringClient::frameworkComplianceReportName()} for help formatting this field.
 */
function aggregate_framework_compliance_report_sample(string $formattedName): void
{
    // Create a client.
    $monitoringClient = new MonitoringClient();

    // Prepare the request message.
    $request = (new AggregateFrameworkComplianceReportRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var AggregateFrameworkComplianceReportResponse $response */
        $response = $monitoringClient->aggregateFrameworkComplianceReport($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 = MonitoringClient::frameworkComplianceReportName(
        '[PROJECT]',
        '[LOCATION]',
        '[FRAMEWORK_COMPLIANCE_REPORT]'
    );

    aggregate_framework_compliance_report_sample($formattedName);
}

fetchFrameworkComplianceReport

Fetches the framework compliance report for a given scope.

The async variant is MonitoringClient::fetchFrameworkComplianceReportAsync() .

Parameters
Name Description
request Google\Cloud\CloudSecurityCompliance\V1\FetchFrameworkComplianceReportRequest

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\FrameworkComplianceReport
Example
use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\Client\MonitoringClient;
use Google\Cloud\CloudSecurityCompliance\V1\FetchFrameworkComplianceReportRequest;
use Google\Cloud\CloudSecurityCompliance\V1\FrameworkComplianceReport;

/**
 * @param string $formattedName The name of the framework compliance report to retrieve. Please see
 *                              {@see MonitoringClient::frameworkComplianceReportName()} for help formatting this field.
 */
function fetch_framework_compliance_report_sample(string $formattedName): void
{
    // Create a client.
    $monitoringClient = new MonitoringClient();

    // Prepare the request message.
    $request = (new FetchFrameworkComplianceReportRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var FrameworkComplianceReport $response */
        $response = $monitoringClient->fetchFrameworkComplianceReport($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 = MonitoringClient::frameworkComplianceReportName(
        '[PROJECT]',
        '[LOCATION]',
        '[FRAMEWORK_COMPLIANCE_REPORT]'
    );

    fetch_framework_compliance_report_sample($formattedName);
}

listControlComplianceSummaries

Lists the control compliance summary for a given scope.

The async variant is MonitoringClient::listControlComplianceSummariesAsync() .

Parameters
Name Description
request Google\Cloud\CloudSecurityCompliance\V1\ListControlComplianceSummariesRequest

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\CloudSecurityCompliance\V1\Client\MonitoringClient;
use Google\Cloud\CloudSecurityCompliance\V1\ControlComplianceSummary;
use Google\Cloud\CloudSecurityCompliance\V1\ListControlComplianceSummariesRequest;

/**
 * @param string $formattedParent The parent scope for the framework overview page. Please see
 *                                {@see MonitoringClient::frameworkComplianceReportName()} for help formatting this field.
 */
function list_control_compliance_summaries_sample(string $formattedParent): void
{
    // Create a client.
    $monitoringClient = new MonitoringClient();

    // Prepare the request message.
    $request = (new ListControlComplianceSummariesRequest())
        ->setParent($formattedParent);

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

        /** @var ControlComplianceSummary $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 = MonitoringClient::frameworkComplianceReportName(
        '[PROJECT]',
        '[LOCATION]',
        '[FRAMEWORK_COMPLIANCE_REPORT]'
    );

    list_control_compliance_summaries_sample($formattedParent);
}

listFindingSummaries

Lists the finding summary by category for a given scope.

The async variant is MonitoringClient::listFindingSummariesAsync() .

Parameters
Name Description
request Google\Cloud\CloudSecurityCompliance\V1\ListFindingSummariesRequest

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\CloudSecurityCompliance\V1\Client\MonitoringClient;
use Google\Cloud\CloudSecurityCompliance\V1\FindingSummary;
use Google\Cloud\CloudSecurityCompliance\V1\ListFindingSummariesRequest;

/**
 * @param string $formattedParent The parent scope for the framework overview page. Please see
 *                                {@see MonitoringClient::organizationLocationName()} for help formatting this field.
 */
function list_finding_summaries_sample(string $formattedParent): void
{
    // Create a client.
    $monitoringClient = new MonitoringClient();

    // Prepare the request message.
    $request = (new ListFindingSummariesRequest())
        ->setParent($formattedParent);

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

        /** @var FindingSummary $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 = MonitoringClient::organizationLocationName('[ORGANIZATION]', '[LOCATION]');

    list_finding_summaries_sample($formattedParent);
}

listFrameworkComplianceSummaries

Lists the framework compliance summary for a given scope.

The async variant is MonitoringClient::listFrameworkComplianceSummariesAsync() .

Parameters
Name Description
request Google\Cloud\CloudSecurityCompliance\V1\ListFrameworkComplianceSummariesRequest

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\CloudSecurityCompliance\V1\Client\MonitoringClient;
use Google\Cloud\CloudSecurityCompliance\V1\FrameworkComplianceSummary;
use Google\Cloud\CloudSecurityCompliance\V1\ListFrameworkComplianceSummariesRequest;

/**
 * @param string $formattedParent The parent scope for the framework compliance summary. Please see
 *                                {@see MonitoringClient::organizationLocationName()} for help formatting this field.
 */
function list_framework_compliance_summaries_sample(string $formattedParent): void
{
    // Create a client.
    $monitoringClient = new MonitoringClient();

    // Prepare the request message.
    $request = (new ListFrameworkComplianceSummariesRequest())
        ->setParent($formattedParent);

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

        /** @var FrameworkComplianceSummary $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 = MonitoringClient::organizationLocationName('[ORGANIZATION]', '[LOCATION]');

    list_framework_compliance_summaries_sample($formattedParent);
}

getLocation

Gets information about a location.

The async variant is MonitoringClient::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
Example
use Google\ApiCore\ApiException;
use Google\Cloud\CloudSecurityCompliance\V1\Client\MonitoringClient;
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.
    $monitoringClient = new MonitoringClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $monitoringClient->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 MonitoringClient::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
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\CloudSecurityCompliance\V1\Client\MonitoringClient;
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.
    $monitoringClient = new MonitoringClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

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

aggregateFrameworkComplianceReportAsync

Parameters
Name Description
request Google\Cloud\CloudSecurityCompliance\V1\AggregateFrameworkComplianceReportRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\CloudSecurityCompliance\V1\AggregateFrameworkComplianceReportResponse>

fetchFrameworkComplianceReportAsync

Parameters
Name Description
request Google\Cloud\CloudSecurityCompliance\V1\FetchFrameworkComplianceReportRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\CloudSecurityCompliance\V1\FrameworkComplianceReport>

listControlComplianceSummariesAsync

Parameters
Name Description
request Google\Cloud\CloudSecurityCompliance\V1\ListControlComplianceSummariesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listFindingSummariesAsync

Parameters
Name Description
request Google\Cloud\CloudSecurityCompliance\V1\ListFindingSummariesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

listFrameworkComplianceSummariesAsync

Parameters
Name Description
request Google\Cloud\CloudSecurityCompliance\V1\ListFrameworkComplianceSummariesRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

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::folderLocationName

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

Parameters
Name Description
folder string
location string
Returns
Type Description
string The formatted folder_location resource.

static::folderLocationFrameworkComplianceReportName

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

Parameters
Name Description
folder string
location string
frameworkComplianceReport string
Returns
Type Description
string The formatted folder_location_framework_compliance_report resource.

static::frameworkComplianceReportName

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

Parameters
Name Description
project string
location string
frameworkComplianceReport string
Returns
Type Description
string The formatted framework_compliance_report 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::organizationLocationName

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

Parameters
Name Description
organization string
location string
Returns
Type Description
string The formatted organization_location resource.

static::organizationLocationFrameworkComplianceReportName

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

Parameters
Name Description
organization string
location string
frameworkComplianceReport string
Returns
Type Description
string The formatted organization_location_framework_compliance_report resource.

static::projectLocationFrameworkComplianceReportName

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

Parameters
Name Description
project string
location string
frameworkComplianceReport string
Returns
Type Description
string The formatted project_location_framework_compliance_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

  • folderLocation: folders/{folder}/locations/{location}
  • folderLocationFrameworkComplianceReport: folders/{folder}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}
  • frameworkComplianceReport: projects/{project}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}
  • location: projects/{project}/locations/{location}
  • organizationLocation: organizations/{organization}/locations/{location}
  • organizationLocationFrameworkComplianceReport: organizations/{organization}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}
  • projectLocationFrameworkComplianceReport: projects/{project}/locations/{location}/frameworkComplianceReports/{framework_compliance_report}

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.