Reference documentation and code samples for the Google Cloud Chronicle V1 Client class DataAccessControlServiceClient.
Service Description: DataAccessControlService exposes resources and endpoints related to data access control.
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 \ Chronicle \ 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. 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 |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
createDataAccessLabel
Creates a data access label.
Data access labels are applied to incoming event data and selected in data access scopes (another resource), and only users with scopes containing the label can see data with that label. Currently, the data access label resource only includes custom labels, which are labels that correspond to UDM queries over event data.
The async variant is DataAccessControlServiceClient::createDataAccessLabelAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\CreateDataAccessLabelRequest
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\Chronicle\V1\DataAccessLabel |
use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\DataAccessControlServiceClient;
use Google\Cloud\Chronicle\V1\CreateDataAccessLabelRequest;
use Google\Cloud\Chronicle\V1\DataAccessLabel;
/**
* @param string $formattedParent The parent resource where this Data Access Label will be created.
* Format: `projects/{project}/locations/{location}/instances/{instance}`
* Please see {@see DataAccessControlServiceClient::instanceName()} for help formatting this field.
* @param string $dataAccessLabelId The ID to use for the data access label, which will become the
* label's display name and the final component of the label's resource name.
* The maximum number of characters should be 63. Regex pattern is as per AIP:
* https://google.aip.dev/122#resource-id-segments
*/
function create_data_access_label_sample(string $formattedParent, string $dataAccessLabelId): void
{
// Create a client.
$dataAccessControlServiceClient = new DataAccessControlServiceClient();
// Prepare the request message.
$dataAccessLabel = new DataAccessLabel();
$request = (new CreateDataAccessLabelRequest())
->setParent($formattedParent)
->setDataAccessLabel($dataAccessLabel)
->setDataAccessLabelId($dataAccessLabelId);
// Call the API and handle any network failures.
try {
/** @var DataAccessLabel $response */
$response = $dataAccessControlServiceClient->createDataAccessLabel($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 = DataAccessControlServiceClient::instanceName(
'[PROJECT]',
'[LOCATION]',
'[INSTANCE]'
);
$dataAccessLabelId = '[DATA_ACCESS_LABEL_ID]';
create_data_access_label_sample($formattedParent, $dataAccessLabelId);
}
createDataAccessScope
Creates a data access scope.
Data access scope is a combination of allowed and denied labels attached to a permission group. If a scope has allowed labels A and B and denied labels C and D, then the group of people attached to the scope will have permissions to see all events labeled with A or B (or both) and not labeled with either C or D.
The async variant is DataAccessControlServiceClient::createDataAccessScopeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\CreateDataAccessScopeRequest
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\Chronicle\V1\DataAccessScope |
use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\DataAccessControlServiceClient;
use Google\Cloud\Chronicle\V1\CreateDataAccessScopeRequest;
use Google\Cloud\Chronicle\V1\DataAccessScope;
/**
* @param string $formattedParent The parent resource where this Data Access Scope will be created.
* Format: `projects/{project}/locations/{location}/instances/{instance}`
* Please see {@see DataAccessControlServiceClient::instanceName()} for help formatting this field.
* @param string $formattedDataAccessScopeName The unique full name of the data access scope.
* The name should comply with https://google.aip.dev/122 standards. Please see
* {@see DataAccessControlServiceClient::dataAccessScopeName()} for help formatting this field.
* @param string $dataAccessScopeId The user provided scope id which will become the last part of the
* name of the scope resource. Needs to be compliant with
* https://google.aip.dev/122
*/
function create_data_access_scope_sample(
string $formattedParent,
string $formattedDataAccessScopeName,
string $dataAccessScopeId
): void {
// Create a client.
$dataAccessControlServiceClient = new DataAccessControlServiceClient();
// Prepare the request message.
$dataAccessScope = (new DataAccessScope())
->setName($formattedDataAccessScopeName);
$request = (new CreateDataAccessScopeRequest())
->setParent($formattedParent)
->setDataAccessScope($dataAccessScope)
->setDataAccessScopeId($dataAccessScopeId);
// Call the API and handle any network failures.
try {
/** @var DataAccessScope $response */
$response = $dataAccessControlServiceClient->createDataAccessScope($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 = DataAccessControlServiceClient::instanceName(
'[PROJECT]',
'[LOCATION]',
'[INSTANCE]'
);
$formattedDataAccessScopeName = DataAccessControlServiceClient::dataAccessScopeName(
'[PROJECT]',
'[LOCATION]',
'[INSTANCE]',
'[DATA_ACCESS_SCOPE]'
);
$dataAccessScopeId = '[DATA_ACCESS_SCOPE_ID]';
create_data_access_scope_sample(
$formattedParent,
$formattedDataAccessScopeName,
$dataAccessScopeId
);
}
deleteDataAccessLabel
Deletes a data access label. When a label is deleted, new data that enters in the system will not receive the label, but the label will not be removed from old data that still refers to it.
The async variant is DataAccessControlServiceClient::deleteDataAccessLabelAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\DeleteDataAccessLabelRequest
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\Chronicle\V1\Client\DataAccessControlServiceClient;
use Google\Cloud\Chronicle\V1\DeleteDataAccessLabelRequest;
/**
* @param string $formattedName The ID of the data access label to delete.
* Format:
* `projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}`
* Please see {@see DataAccessControlServiceClient::dataAccessLabelName()} for help formatting this field.
*/
function delete_data_access_label_sample(string $formattedName): void
{
// Create a client.
$dataAccessControlServiceClient = new DataAccessControlServiceClient();
// Prepare the request message.
$request = (new DeleteDataAccessLabelRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$dataAccessControlServiceClient->deleteDataAccessLabel($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 = DataAccessControlServiceClient::dataAccessLabelName(
'[PROJECT]',
'[LOCATION]',
'[INSTANCE]',
'[DATA_ACCESS_LABEL]'
);
delete_data_access_label_sample($formattedName);
}
deleteDataAccessScope
Deletes a data access scope.
The async variant is DataAccessControlServiceClient::deleteDataAccessScopeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\DeleteDataAccessScopeRequest
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\Chronicle\V1\Client\DataAccessControlServiceClient;
use Google\Cloud\Chronicle\V1\DeleteDataAccessScopeRequest;
/**
* @param string $formattedName The ID of the data access scope to delete.
* Format:
* `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}`
* Please see {@see DataAccessControlServiceClient::dataAccessScopeName()} for help formatting this field.
*/
function delete_data_access_scope_sample(string $formattedName): void
{
// Create a client.
$dataAccessControlServiceClient = new DataAccessControlServiceClient();
// Prepare the request message.
$request = (new DeleteDataAccessScopeRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
$dataAccessControlServiceClient->deleteDataAccessScope($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 = DataAccessControlServiceClient::dataAccessScopeName(
'[PROJECT]',
'[LOCATION]',
'[INSTANCE]',
'[DATA_ACCESS_SCOPE]'
);
delete_data_access_scope_sample($formattedName);
}
getDataAccessLabel
Gets a data access label.
The async variant is DataAccessControlServiceClient::getDataAccessLabelAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\GetDataAccessLabelRequest
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\Chronicle\V1\DataAccessLabel |
use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\DataAccessControlServiceClient;
use Google\Cloud\Chronicle\V1\DataAccessLabel;
use Google\Cloud\Chronicle\V1\GetDataAccessLabelRequest;
/**
* @param string $formattedName The ID of the data access label to retrieve.
* Format:
* `projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}`
* Please see {@see DataAccessControlServiceClient::dataAccessLabelName()} for help formatting this field.
*/
function get_data_access_label_sample(string $formattedName): void
{
// Create a client.
$dataAccessControlServiceClient = new DataAccessControlServiceClient();
// Prepare the request message.
$request = (new GetDataAccessLabelRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var DataAccessLabel $response */
$response = $dataAccessControlServiceClient->getDataAccessLabel($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 = DataAccessControlServiceClient::dataAccessLabelName(
'[PROJECT]',
'[LOCATION]',
'[INSTANCE]',
'[DATA_ACCESS_LABEL]'
);
get_data_access_label_sample($formattedName);
}
getDataAccessScope
Retrieves an existing data access scope.
The async variant is DataAccessControlServiceClient::getDataAccessScopeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\GetDataAccessScopeRequest
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\Chronicle\V1\DataAccessScope |
use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\DataAccessControlServiceClient;
use Google\Cloud\Chronicle\V1\DataAccessScope;
use Google\Cloud\Chronicle\V1\GetDataAccessScopeRequest;
/**
* @param string $formattedName The ID of the data access scope to retrieve.
* Format:
* `projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}`
* Please see {@see DataAccessControlServiceClient::dataAccessScopeName()} for help formatting this field.
*/
function get_data_access_scope_sample(string $formattedName): void
{
// Create a client.
$dataAccessControlServiceClient = new DataAccessControlServiceClient();
// Prepare the request message.
$request = (new GetDataAccessScopeRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var DataAccessScope $response */
$response = $dataAccessControlServiceClient->getDataAccessScope($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 = DataAccessControlServiceClient::dataAccessScopeName(
'[PROJECT]',
'[LOCATION]',
'[INSTANCE]',
'[DATA_ACCESS_SCOPE]'
);
get_data_access_scope_sample($formattedName);
}
listDataAccessLabels
Lists all data access labels for the customer.
The async variant is DataAccessControlServiceClient::listDataAccessLabelsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\ListDataAccessLabelsRequest
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\Chronicle\V1\Client\DataAccessControlServiceClient;
use Google\Cloud\Chronicle\V1\DataAccessLabel;
use Google\Cloud\Chronicle\V1\ListDataAccessLabelsRequest;
/**
* @param string $formattedParent The parent resource where this data access label will be created.
* Format: `projects/{project}/locations/{location}/instances/{instance}`
* Please see {@see DataAccessControlServiceClient::instanceName()} for help formatting this field.
*/
function list_data_access_labels_sample(string $formattedParent): void
{
// Create a client.
$dataAccessControlServiceClient = new DataAccessControlServiceClient();
// Prepare the request message.
$request = (new ListDataAccessLabelsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataAccessControlServiceClient->listDataAccessLabels($request);
/** @var DataAccessLabel $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 = DataAccessControlServiceClient::instanceName(
'[PROJECT]',
'[LOCATION]',
'[INSTANCE]'
);
list_data_access_labels_sample($formattedParent);
}
listDataAccessScopes
Lists all existing data access scopes for the customer.
The async variant is DataAccessControlServiceClient::listDataAccessScopesAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\ListDataAccessScopesRequest
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\Chronicle\V1\Client\DataAccessControlServiceClient;
use Google\Cloud\Chronicle\V1\DataAccessScope;
use Google\Cloud\Chronicle\V1\ListDataAccessScopesRequest;
/**
* @param string $formattedParent The parent resource where this data access scope will be created.
* Format: `projects/{project}/locations/{location}/instances/{instance}`
* Please see {@see DataAccessControlServiceClient::instanceName()} for help formatting this field.
*/
function list_data_access_scopes_sample(string $formattedParent): void
{
// Create a client.
$dataAccessControlServiceClient = new DataAccessControlServiceClient();
// Prepare the request message.
$request = (new ListDataAccessScopesRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $dataAccessControlServiceClient->listDataAccessScopes($request);
/** @var DataAccessScope $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 = DataAccessControlServiceClient::instanceName(
'[PROJECT]',
'[LOCATION]',
'[INSTANCE]'
);
list_data_access_scopes_sample($formattedParent);
}
updateDataAccessLabel
Updates a data access label.
The async variant is DataAccessControlServiceClient::updateDataAccessLabelAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\UpdateDataAccessLabelRequest
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\Chronicle\V1\DataAccessLabel |
use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\DataAccessControlServiceClient;
use Google\Cloud\Chronicle\V1\DataAccessLabel;
use Google\Cloud\Chronicle\V1\UpdateDataAccessLabelRequest;
/**
* 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_data_access_label_sample(): void
{
// Create a client.
$dataAccessControlServiceClient = new DataAccessControlServiceClient();
// Prepare the request message.
$dataAccessLabel = new DataAccessLabel();
$request = (new UpdateDataAccessLabelRequest())
->setDataAccessLabel($dataAccessLabel);
// Call the API and handle any network failures.
try {
/** @var DataAccessLabel $response */
$response = $dataAccessControlServiceClient->updateDataAccessLabel($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateDataAccessScope
Updates a data access scope.
The async variant is DataAccessControlServiceClient::updateDataAccessScopeAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\UpdateDataAccessScopeRequest
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\Chronicle\V1\DataAccessScope |
use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\DataAccessControlServiceClient;
use Google\Cloud\Chronicle\V1\DataAccessScope;
use Google\Cloud\Chronicle\V1\UpdateDataAccessScopeRequest;
/**
* @param string $formattedDataAccessScopeName The unique full name of the data access scope.
* The name should comply with https://google.aip.dev/122 standards. Please see
* {@see DataAccessControlServiceClient::dataAccessScopeName()} for help formatting this field.
*/
function update_data_access_scope_sample(string $formattedDataAccessScopeName): void
{
// Create a client.
$dataAccessControlServiceClient = new DataAccessControlServiceClient();
// Prepare the request message.
$dataAccessScope = (new DataAccessScope())
->setName($formattedDataAccessScopeName);
$request = (new UpdateDataAccessScopeRequest())
->setDataAccessScope($dataAccessScope);
// Call the API and handle any network failures.
try {
/** @var DataAccessScope $response */
$response = $dataAccessControlServiceClient->updateDataAccessScope($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
{
$formattedDataAccessScopeName = DataAccessControlServiceClient::dataAccessScopeName(
'[PROJECT]',
'[LOCATION]',
'[INSTANCE]',
'[DATA_ACCESS_SCOPE]'
);
update_data_access_scope_sample($formattedDataAccessScopeName);
}
createDataAccessLabelAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\CreateDataAccessLabelRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Chronicle\V1\DataAccessLabel> |
createDataAccessScopeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\CreateDataAccessScopeRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Chronicle\V1\DataAccessScope> |
deleteDataAccessLabelAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\DeleteDataAccessLabelRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
deleteDataAccessScopeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\DeleteDataAccessScopeRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<void> |
getDataAccessLabelAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\GetDataAccessLabelRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Chronicle\V1\DataAccessLabel> |
getDataAccessScopeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\GetDataAccessScopeRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Chronicle\V1\DataAccessScope> |
listDataAccessLabelsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\ListDataAccessLabelsRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
listDataAccessScopesAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\ListDataAccessScopesRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
updateDataAccessLabelAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\UpdateDataAccessLabelRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Chronicle\V1\DataAccessLabel> |
updateDataAccessScopeAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Chronicle\V1\UpdateDataAccessScopeRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Chronicle\V1\DataAccessScope> |
static::dataAccessLabelName
Formats a string containing the fully-qualified path to represent a data_access_label resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
instance |
string
|
dataAccessLabel |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted data_access_label resource. |
static::dataAccessScopeName
Formats a string containing the fully-qualified path to represent a data_access_scope resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
instance |
string
|
dataAccessScope |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted data_access_scope resource. |
static::instanceName
Formats a string containing the fully-qualified path to represent a instance resource.
Parameters | |
---|---|
Name | Description |
project |
string
|
location |
string
|
instance |
string
|
Returns | |
---|---|
Type | Description |
string |
The formatted instance 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
- dataAccessLabel: projects/{project}/locations/{location}/instances/{instance}/dataAccessLabels/{data_access_label}
- dataAccessScope: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}
- instance: projects/{project}/locations/{location}/instances/{instance}
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. |