Google Cloud Storage Insights V1 Client - Class StorageInsightsClient (1.2.0)

Reference documentation and code samples for the Google Cloud Storage Insights V1 Client class StorageInsightsClient.

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 \ StorageInsights \ 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. Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information 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

createDatasetConfig

Creates a dataset configuration in a given project for a given location.

The async variant is StorageInsightsClient::createDatasetConfigAsync() .

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\CreateDatasetConfigRequest

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
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\StorageInsights\V1\Client\StorageInsightsClient;
use Google\Cloud\StorageInsights\V1\CreateDatasetConfigRequest;
use Google\Cloud\StorageInsights\V1\DatasetConfig;
use Google\Rpc\Status;

/**
 * @param string $formattedParent Value for parent. Please see
 *                                {@see StorageInsightsClient::locationName()} for help formatting this field.
 * @param string $datasetConfigId ID of the requesting object.
 *                                If auto-generating ID is enabled on the server-side, remove this field and
 *                                `dataset_config_id` from the method_signature of Create RPC
 *                                Note: The value should not contain any hyphens.
 */
function create_dataset_config_sample(string $formattedParent, string $datasetConfigId): void
{
    // Create a client.
    $storageInsightsClient = new StorageInsightsClient();

    // Prepare the request message.
    $datasetConfig = new DatasetConfig();
    $request = (new CreateDatasetConfigRequest())
        ->setParent($formattedParent)
        ->setDatasetConfigId($datasetConfigId)
        ->setDatasetConfig($datasetConfig);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $storageInsightsClient->createDatasetConfig($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var DatasetConfig $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = StorageInsightsClient::locationName('[PROJECT]', '[LOCATION]');
    $datasetConfigId = '[DATASET_CONFIG_ID]';

    create_dataset_config_sample($formattedParent, $datasetConfigId);
}

createReportConfig

Creates a new ReportConfig in a given project and location.

The async variant is StorageInsightsClient::createReportConfigAsync() .

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\CreateReportConfigRequest

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\StorageInsights\V1\ReportConfig
Example
use Google\ApiCore\ApiException;
use Google\Cloud\StorageInsights\V1\Client\StorageInsightsClient;
use Google\Cloud\StorageInsights\V1\CreateReportConfigRequest;
use Google\Cloud\StorageInsights\V1\ReportConfig;

/**
 * @param string $formattedParent Value for parent. Please see
 *                                {@see StorageInsightsClient::locationName()} for help formatting this field.
 */
function create_report_config_sample(string $formattedParent): void
{
    // Create a client.
    $storageInsightsClient = new StorageInsightsClient();

    // Prepare the request message.
    $reportConfig = new ReportConfig();
    $request = (new CreateReportConfigRequest())
        ->setParent($formattedParent)
        ->setReportConfig($reportConfig);

    // Call the API and handle any network failures.
    try {
        /** @var ReportConfig $response */
        $response = $storageInsightsClient->createReportConfig($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
{
    $formattedParent = StorageInsightsClient::locationName('[PROJECT]', '[LOCATION]');

    create_report_config_sample($formattedParent);
}

deleteDatasetConfig

Deletes a dataset configuration in a given project for a given location.

The async variant is StorageInsightsClient::deleteDatasetConfigAsync() .

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\DeleteDatasetConfigRequest

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
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\StorageInsights\V1\Client\StorageInsightsClient;
use Google\Cloud\StorageInsights\V1\DeleteDatasetConfigRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName Name of the resource
 *                              Please see {@see StorageInsightsClient::datasetConfigName()} for help formatting this field.
 */
function delete_dataset_config_sample(string $formattedName): void
{
    // Create a client.
    $storageInsightsClient = new StorageInsightsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $storageInsightsClient->deleteDatasetConfig($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = StorageInsightsClient::datasetConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATASET_CONFIG]'
    );

    delete_dataset_config_sample($formattedName);
}

deleteReportConfig

Deletes a single ReportConfig.

The async variant is StorageInsightsClient::deleteReportConfigAsync() .

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\DeleteReportConfigRequest

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.

Example
use Google\ApiCore\ApiException;
use Google\Cloud\StorageInsights\V1\Client\StorageInsightsClient;
use Google\Cloud\StorageInsights\V1\DeleteReportConfigRequest;

/**
 * @param string $formattedName Name of the resource
 *                              Please see {@see StorageInsightsClient::reportConfigName()} for help formatting this field.
 */
function delete_report_config_sample(string $formattedName): void
{
    // Create a client.
    $storageInsightsClient = new StorageInsightsClient();

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

    // Call the API and handle any network failures.
    try {
        $storageInsightsClient->deleteReportConfig($request);
        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 = StorageInsightsClient::reportConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[REPORT_CONFIG]'
    );

    delete_report_config_sample($formattedName);
}

getDatasetConfig

Gets the dataset configuration in a given project for a given location.

The async variant is StorageInsightsClient::getDatasetConfigAsync() .

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\GetDatasetConfigRequest

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\StorageInsights\V1\DatasetConfig
Example
use Google\ApiCore\ApiException;
use Google\Cloud\StorageInsights\V1\Client\StorageInsightsClient;
use Google\Cloud\StorageInsights\V1\DatasetConfig;
use Google\Cloud\StorageInsights\V1\GetDatasetConfigRequest;

/**
 * @param string $formattedName Name of the resource
 *                              Please see {@see StorageInsightsClient::datasetConfigName()} for help formatting this field.
 */
function get_dataset_config_sample(string $formattedName): void
{
    // Create a client.
    $storageInsightsClient = new StorageInsightsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var DatasetConfig $response */
        $response = $storageInsightsClient->getDatasetConfig($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 = StorageInsightsClient::datasetConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATASET_CONFIG]'
    );

    get_dataset_config_sample($formattedName);
}

getReportConfig

Gets details of a single ReportConfig.

The async variant is StorageInsightsClient::getReportConfigAsync() .

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\GetReportConfigRequest

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\StorageInsights\V1\ReportConfig
Example
use Google\ApiCore\ApiException;
use Google\Cloud\StorageInsights\V1\Client\StorageInsightsClient;
use Google\Cloud\StorageInsights\V1\GetReportConfigRequest;
use Google\Cloud\StorageInsights\V1\ReportConfig;

/**
 * @param string $formattedName Name of the resource
 *                              Please see {@see StorageInsightsClient::reportConfigName()} for help formatting this field.
 */
function get_report_config_sample(string $formattedName): void
{
    // Create a client.
    $storageInsightsClient = new StorageInsightsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var ReportConfig $response */
        $response = $storageInsightsClient->getReportConfig($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 = StorageInsightsClient::reportConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[REPORT_CONFIG]'
    );

    get_report_config_sample($formattedName);
}

getReportDetail

Gets details of a single ReportDetail.

The async variant is StorageInsightsClient::getReportDetailAsync() .

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\GetReportDetailRequest

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\StorageInsights\V1\ReportDetail
Example
use Google\ApiCore\ApiException;
use Google\Cloud\StorageInsights\V1\Client\StorageInsightsClient;
use Google\Cloud\StorageInsights\V1\GetReportDetailRequest;
use Google\Cloud\StorageInsights\V1\ReportDetail;

/**
 * @param string $formattedName Name of the resource
 *                              Please see {@see StorageInsightsClient::reportDetailName()} for help formatting this field.
 */
function get_report_detail_sample(string $formattedName): void
{
    // Create a client.
    $storageInsightsClient = new StorageInsightsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var ReportDetail $response */
        $response = $storageInsightsClient->getReportDetail($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 = StorageInsightsClient::reportDetailName(
        '[PROJECT]',
        '[LOCATION]',
        '[REPORT_CONFIG]',
        '[REPORT_DETAIL]'
    );

    get_report_detail_sample($formattedName);
}

linkDataset

Links a dataset to BigQuery in a given project for a given location.

The async variant is StorageInsightsClient::linkDatasetAsync() .

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\LinkDatasetRequest

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
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\StorageInsights\V1\Client\StorageInsightsClient;
use Google\Cloud\StorageInsights\V1\LinkDatasetRequest;
use Google\Cloud\StorageInsights\V1\LinkDatasetResponse;
use Google\Rpc\Status;

/**
 * @param string $formattedName Name of the resource
 *                              Please see {@see StorageInsightsClient::datasetConfigName()} for help formatting this field.
 */
function link_dataset_sample(string $formattedName): void
{
    // Create a client.
    $storageInsightsClient = new StorageInsightsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $storageInsightsClient->linkDataset($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var LinkDatasetResponse $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = StorageInsightsClient::datasetConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATASET_CONFIG]'
    );

    link_dataset_sample($formattedName);
}

listDatasetConfigs

Lists the dataset configurations in a given project for a given location.

The async variant is StorageInsightsClient::listDatasetConfigsAsync() .

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\ListDatasetConfigsRequest

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\StorageInsights\V1\Client\StorageInsightsClient;
use Google\Cloud\StorageInsights\V1\DatasetConfig;
use Google\Cloud\StorageInsights\V1\ListDatasetConfigsRequest;

/**
 * @param string $formattedParent Parent value for ListDatasetConfigsRequest
 *                                Please see {@see StorageInsightsClient::locationName()} for help formatting this field.
 */
function list_dataset_configs_sample(string $formattedParent): void
{
    // Create a client.
    $storageInsightsClient = new StorageInsightsClient();

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

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

        /** @var DatasetConfig $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 = StorageInsightsClient::locationName('[PROJECT]', '[LOCATION]');

    list_dataset_configs_sample($formattedParent);
}

listReportConfigs

Lists ReportConfigs in a given project and location.

The async variant is StorageInsightsClient::listReportConfigsAsync() .

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\ListReportConfigsRequest

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\StorageInsights\V1\Client\StorageInsightsClient;
use Google\Cloud\StorageInsights\V1\ListReportConfigsRequest;
use Google\Cloud\StorageInsights\V1\ReportConfig;

/**
 * @param string $formattedParent Parent value for ListReportConfigsRequest
 *                                Please see {@see StorageInsightsClient::locationName()} for help formatting this field.
 */
function list_report_configs_sample(string $formattedParent): void
{
    // Create a client.
    $storageInsightsClient = new StorageInsightsClient();

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

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

        /** @var ReportConfig $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 = StorageInsightsClient::locationName('[PROJECT]', '[LOCATION]');

    list_report_configs_sample($formattedParent);
}

listReportDetails

Lists ReportDetails in a given project and location.

The async variant is StorageInsightsClient::listReportDetailsAsync() .

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\ListReportDetailsRequest

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\StorageInsights\V1\Client\StorageInsightsClient;
use Google\Cloud\StorageInsights\V1\ListReportDetailsRequest;
use Google\Cloud\StorageInsights\V1\ReportDetail;

/**
 * @param string $formattedParent Parent value for ListReportDetailsRequest
 *                                Please see {@see StorageInsightsClient::reportConfigName()} for help formatting this field.
 */
function list_report_details_sample(string $formattedParent): void
{
    // Create a client.
    $storageInsightsClient = new StorageInsightsClient();

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

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

        /** @var ReportDetail $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 = StorageInsightsClient::reportConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[REPORT_CONFIG]'
    );

    list_report_details_sample($formattedParent);
}

unlinkDataset

Unlinks a dataset from BigQuery in a given project for a given location.

The async variant is StorageInsightsClient::unlinkDatasetAsync() .

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\UnlinkDatasetRequest

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
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\StorageInsights\V1\Client\StorageInsightsClient;
use Google\Cloud\StorageInsights\V1\UnlinkDatasetRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName Name of the resource
 *                              Please see {@see StorageInsightsClient::datasetConfigName()} for help formatting this field.
 */
function unlink_dataset_sample(string $formattedName): void
{
    // Create a client.
    $storageInsightsClient = new StorageInsightsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $storageInsightsClient->unlinkDataset($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            printf('Operation completed successfully.' . PHP_EOL);
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->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 = StorageInsightsClient::datasetConfigName(
        '[PROJECT]',
        '[LOCATION]',
        '[DATASET_CONFIG]'
    );

    unlink_dataset_sample($formattedName);
}

updateDatasetConfig

Updates a dataset configuration in a given project for a given location.

The async variant is StorageInsightsClient::updateDatasetConfigAsync() .

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\UpdateDatasetConfigRequest

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
Example
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\StorageInsights\V1\Client\StorageInsightsClient;
use Google\Cloud\StorageInsights\V1\DatasetConfig;
use Google\Cloud\StorageInsights\V1\UpdateDatasetConfigRequest;
use Google\Protobuf\FieldMask;
use Google\Rpc\Status;

/**
 * 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_dataset_config_sample(): void
{
    // Create a client.
    $storageInsightsClient = new StorageInsightsClient();

    // Prepare the request message.
    $updateMask = new FieldMask();
    $datasetConfig = new DatasetConfig();
    $request = (new UpdateDatasetConfigRequest())
        ->setUpdateMask($updateMask)
        ->setDatasetConfig($datasetConfig);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $storageInsightsClient->updateDatasetConfig($request);
        $response->pollUntilComplete();

        if ($response->operationSucceeded()) {
            /** @var DatasetConfig $result */
            $result = $response->getResult();
            printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
        } else {
            /** @var Status $error */
            $error = $response->getError();
            printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

updateReportConfig

Updates the parameters of a single ReportConfig.

The async variant is StorageInsightsClient::updateReportConfigAsync() .

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\UpdateReportConfigRequest

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\StorageInsights\V1\ReportConfig
Example
use Google\ApiCore\ApiException;
use Google\Cloud\StorageInsights\V1\Client\StorageInsightsClient;
use Google\Cloud\StorageInsights\V1\ReportConfig;
use Google\Cloud\StorageInsights\V1\UpdateReportConfigRequest;
use Google\Protobuf\FieldMask;

/**
 * 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_report_config_sample(): void
{
    // Create a client.
    $storageInsightsClient = new StorageInsightsClient();

    // Prepare the request message.
    $updateMask = new FieldMask();
    $reportConfig = new ReportConfig();
    $request = (new UpdateReportConfigRequest())
        ->setUpdateMask($updateMask)
        ->setReportConfig($reportConfig);

    // Call the API and handle any network failures.
    try {
        /** @var ReportConfig $response */
        $response = $storageInsightsClient->updateReportConfig($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 StorageInsightsClient::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\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\StorageInsights\V1\Client\StorageInsightsClient;

/**
 * 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.
    $storageInsightsClient = new StorageInsightsClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Location $response */
        $response = $storageInsightsClient->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 StorageInsightsClient::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\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\StorageInsights\V1\Client\StorageInsightsClient;

/**
 * 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.
    $storageInsightsClient = new StorageInsightsClient();

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

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

createDatasetConfigAsync

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\CreateDatasetConfigRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

createReportConfigAsync

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\CreateReportConfigRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\StorageInsights\V1\ReportConfig>

deleteDatasetConfigAsync

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\DeleteDatasetConfigRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

deleteReportConfigAsync

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\DeleteReportConfigRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<void>

getDatasetConfigAsync

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\GetDatasetConfigRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\StorageInsights\V1\DatasetConfig>

getReportConfigAsync

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\GetReportConfigRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\StorageInsights\V1\ReportConfig>

getReportDetailAsync

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\GetReportDetailRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\StorageInsights\V1\ReportDetail>

linkDatasetAsync

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\LinkDatasetRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

listDatasetConfigsAsync

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

listReportConfigsAsync

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

listReportDetailsAsync

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

unlinkDatasetAsync

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\UnlinkDatasetRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

updateDatasetConfigAsync

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\UpdateDatasetConfigRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

updateReportConfigAsync

Parameters
Name Description
request Google\Cloud\StorageInsights\V1\UpdateReportConfigRequest
optionalArgs array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\StorageInsights\V1\ReportConfig>

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>

getOperationsClient

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

Returns
Type Description
Google\LongRunning\Client\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::datasetConfigName

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

Parameters
Name Description
project string
location string
datasetConfig string
Returns
Type Description
string The formatted dataset_config 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::reportConfigName

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

Parameters
Name Description
project string
location string
reportConfig string
Returns
Type Description
string The formatted report_config resource.

static::reportDetailName

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

Parameters
Name Description
project string
location string
reportConfig string
reportDetail string
Returns
Type Description
string The formatted report_detail 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

  • datasetConfig: projects/{project}/locations/{location}/datasetConfigs/{dataset_config}
  • location: projects/{project}/locations/{location}
  • reportConfig: projects/{project}/locations/{location}/reportConfigs/{report_config}
  • reportDetail: projects/{project}/locations/{location}/reportConfigs/{report_config}/reportDetails/{report_detail}

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.