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 \ ClientMethods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
createReportConfig
Creates a new ReportConfig in a given project and location.
The async variant is Google\Cloud\StorageInsights\V1\Client\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 |
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);
}
deleteReportConfig
Deletes a single ReportConfig.
The async variant is Google\Cloud\StorageInsights\V1\Client\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. |
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);
}
getReportConfig
Gets details of a single ReportConfig.
The async variant is Google\Cloud\StorageInsights\V1\Client\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 |
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 Google\Cloud\StorageInsights\V1\Client\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 |
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);
}
listReportConfigs
Lists ReportConfigs in a given project and location.
The async variant is Google\Cloud\StorageInsights\V1\Client\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 |
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 Google\Cloud\StorageInsights\V1\Client\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 |
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);
}
updateReportConfig
Updates the parameters of a single ReportConfig.
The async variant is Google\Cloud\StorageInsights\V1\Client\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 |
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 Google\Cloud\StorageInsights\V1\Client\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 |
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 Google\Cloud\StorageInsights\V1\Client\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 |
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());
}
}
createReportConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\StorageInsights\V1\CreateReportConfigRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
deleteReportConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\StorageInsights\V1\DeleteReportConfigRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getReportConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\StorageInsights\V1\GetReportConfigRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getReportDetailAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\StorageInsights\V1\GetReportDetailRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listReportConfigsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\StorageInsights\V1\ListReportConfigsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listReportDetailsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\StorageInsights\V1\ListReportDetailsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
updateReportConfigAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\StorageInsights\V1\UpdateReportConfigRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
getLocationAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
listLocationsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
optionalArgs = [] |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface |
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
- 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. |