Google Cloud Chronicle V1 Client - Class DataTableServiceClient (0.4.0)

Reference documentation and code samples for the Google Cloud Chronicle V1 Client class DataTableServiceClient.

Service Description: DataTableManager provides an interface for managing data tables.

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

Methods

__construct

Constructor.

Parameters

Name

Description

options

array| Google\ApiCore\Options\ClientOptions

Optional. Options for configuring the service API wrapper.

↳ apiEndpoint

string

The address of the API remote host. May optionally include the port, formatted as "

↳ credentials

 Google\Auth\FetchAuthTokenInterface 
| Google\ApiCore\CredentialsWrapper

This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\Chronicle\V1\DataTableServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new DataTableServiceClient(['credentials' => $creds]); https://cloud.google.com/docs/authentication/external/externally-sourced-credentials

↳ credentialsConfig

array

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .

↳ disableRetries

bool

Determines whether or not retries defined by the client configuration should be disabled. Defaults to false .

↳ clientConfig

string|array

Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.

↳ transport

string| Google\ApiCore\Transport\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| Psr\Log\LoggerInterface

A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

↳ universeDomain

string

The service domain for the client. Defaults to 'googleapis.com'.

bulkCreateDataTableRows

Create data table rows in bulk.

The async variant is DataTableServiceClient::bulkCreateDataTableRowsAsync() .

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\BulkCreateDataTableRowsRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

 Google\ApiCore\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\BulkCreateDataTableRowsResponse

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\BulkCreateDataTableRowsRequest;
use Google\Cloud\Chronicle\V1\BulkCreateDataTableRowsResponse;
use Google\Cloud\Chronicle\V1\Client\DataTableServiceClient;
use Google\Cloud\Chronicle\V1\CreateDataTableRowRequest;
use Google\Cloud\Chronicle\V1\DataTableRow;

/**
 * @param string $formattedParent                   The resource id of the data table.
 *                                                  Format:
 *                                                  /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
 *                                                  Please see {@see DataTableServiceClient::dataTableName()} for help formatting this field.
 * @param string $formattedRequestsParent           The resource id of the data table.
 *                                                  Format:
 *                                                  /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
 *                                                  Please see {@see DataTableServiceClient::dataTableName()} for help formatting this field.
 * @param string $requestsDataTableRowValuesElement All column values for a single row. The values should be in the
 *                                                  same order as the columns of the data tables.
 */
function bulk_create_data_table_rows_sample(
    string $formattedParent,
    string $formattedRequestsParent,
    string $requestsDataTableRowValuesElement
): void {
    // Create a client.
    $dataTableServiceClient = new DataTableServiceClient();

    // Prepare the request message.
    $requestsDataTableRowValues = [$requestsDataTableRowValuesElement,];
    $requestsDataTableRow = (new DataTableRow())
        ->setValues($requestsDataTableRowValues);
    $createDataTableRowRequest = (new CreateDataTableRowRequest())
        ->setParent($formattedRequestsParent)
        ->setDataTableRow($requestsDataTableRow);
    $requests = [$createDataTableRowRequest,];
    $request = (new BulkCreateDataTableRowsRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BulkCreateDataTableRowsResponse $response */
        $response = $dataTableServiceClient->bulkCreateDataTableRows($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 = DataTableServiceClient::dataTableName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]',
        '[DATA_TABLE]'
    );
    $formattedRequestsParent = DataTableServiceClient::dataTableName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]',
        '[DATA_TABLE]'
    );
    $requestsDataTableRowValuesElement = '[VALUES]';

    bulk_create_data_table_rows_sample(
        $formattedParent,
        $formattedRequestsParent,
        $requestsDataTableRowValuesElement
    );
}

bulkGetDataTableRows

Get data table rows in bulk.

The async variant is DataTableServiceClient::bulkGetDataTableRowsAsync() .

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\BulkGetDataTableRowsRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

 Google\ApiCore\RetrySettings 
|array

Returns

Type

Description

 Google\Cloud\Chronicle\V1\BulkGetDataTableRowsResponse

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\BulkGetDataTableRowsRequest;
use Google\Cloud\Chronicle\V1\BulkGetDataTableRowsResponse;
use Google\Cloud\Chronicle\V1\Client\DataTableServiceClient;
use Google\Cloud\Chronicle\V1\GetDataTableRowRequest;

/**
 * @param string $formattedParent       The resource id of the data table.
 *                                      Format:
 *                                      /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
 *                                      Please see {@see DataTableServiceClient::dataTableName()} for help formatting this field.
 * @param string $formattedRequestsName The resource name of the data table row i,e row_id.
 *                                      Format:
 *                                      projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row}
 *                                      Please see {@see DataTableServiceClient::dataTableRowName()} for help formatting this field.
 */
function bulk_get_data_table_rows_sample(
    string $formattedParent,
    string $formattedRequestsName
): void {
    // Create a client.
    $dataTableServiceClient = new DataTableServiceClient();

    // Prepare the request message.
    $getDataTableRowRequest = (new GetDataTableRowRequest())
        ->setName($formattedRequestsName);
    $requests = [$getDataTableRowRequest,];
    $request = (new BulkGetDataTableRowsRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BulkGetDataTableRowsResponse $response */
        $response = $dataTableServiceClient->bulkGetDataTableRows($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 = DataTableServiceClient::dataTableName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]',
        '[DATA_TABLE]'
    );
    $formattedRequestsName = DataTableServiceClient::dataTableRowName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]',
        '[DATA_TABLE]',
        '[DATA_TABLE_ROW]'
    );

    bulk_get_data_table_rows_sample($formattedParent, $formattedRequestsName);
}

bulkReplaceDataTableRows

Replace all existing data table rows with new data table rows.

The async variant is DataTableServiceClient::bulkReplaceDataTableRowsAsync() .

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\BulkReplaceDataTableRowsRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

 Google\ApiCore\RetrySettings 
|array

Returns

Type

Description

 Google\Cloud\Chronicle\V1\BulkReplaceDataTableRowsResponse

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\BulkReplaceDataTableRowsRequest;
use Google\Cloud\Chronicle\V1\BulkReplaceDataTableRowsResponse;
use Google\Cloud\Chronicle\V1\Client\DataTableServiceClient;
use Google\Cloud\Chronicle\V1\CreateDataTableRowRequest;
use Google\Cloud\Chronicle\V1\DataTableRow;

/**
 * @param string $formattedParent                   The resource id of the data table.
 *                                                  Format:
 *                                                  /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
 *                                                  Please see {@see DataTableServiceClient::dataTableName()} for help formatting this field.
 * @param string $formattedRequestsParent           The resource id of the data table.
 *                                                  Format:
 *                                                  /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
 *                                                  Please see {@see DataTableServiceClient::dataTableName()} for help formatting this field.
 * @param string $requestsDataTableRowValuesElement All column values for a single row. The values should be in the
 *                                                  same order as the columns of the data tables.
 */
function bulk_replace_data_table_rows_sample(
    string $formattedParent,
    string $formattedRequestsParent,
    string $requestsDataTableRowValuesElement
): void {
    // Create a client.
    $dataTableServiceClient = new DataTableServiceClient();

    // Prepare the request message.
    $requestsDataTableRowValues = [$requestsDataTableRowValuesElement,];
    $requestsDataTableRow = (new DataTableRow())
        ->setValues($requestsDataTableRowValues);
    $createDataTableRowRequest = (new CreateDataTableRowRequest())
        ->setParent($formattedRequestsParent)
        ->setDataTableRow($requestsDataTableRow);
    $requests = [$createDataTableRowRequest,];
    $request = (new BulkReplaceDataTableRowsRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BulkReplaceDataTableRowsResponse $response */
        $response = $dataTableServiceClient->bulkReplaceDataTableRows($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 = DataTableServiceClient::dataTableName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]',
        '[DATA_TABLE]'
    );
    $formattedRequestsParent = DataTableServiceClient::dataTableName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]',
        '[DATA_TABLE]'
    );
    $requestsDataTableRowValuesElement = '[VALUES]';

    bulk_replace_data_table_rows_sample(
        $formattedParent,
        $formattedRequestsParent,
        $requestsDataTableRowValuesElement
    );
}

bulkUpdateDataTableRows

Update data table rows in bulk.

The async variant is DataTableServiceClient::bulkUpdateDataTableRowsAsync() .

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\BulkUpdateDataTableRowsRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

 Google\ApiCore\RetrySettings 
|array

Returns

Type

Description

 Google\Cloud\Chronicle\V1\BulkUpdateDataTableRowsResponse

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\BulkUpdateDataTableRowsRequest;
use Google\Cloud\Chronicle\V1\BulkUpdateDataTableRowsResponse;
use Google\Cloud\Chronicle\V1\Client\DataTableServiceClient;
use Google\Cloud\Chronicle\V1\DataTableRow;
use Google\Cloud\Chronicle\V1\UpdateDataTableRowRequest;

/**
 * @param string $formattedParent                   The resource id of the data table.
 *                                                  Format:
 *                                                  /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
 *                                                  Please see {@see DataTableServiceClient::dataTableName()} for help formatting this field.
 * @param string $requestsDataTableRowValuesElement All column values for a single row. The values should be in the
 *                                                  same order as the columns of the data tables.
 */
function bulk_update_data_table_rows_sample(
    string $formattedParent,
    string $requestsDataTableRowValuesElement
): void {
    // Create a client.
    $dataTableServiceClient = new DataTableServiceClient();

    // Prepare the request message.
    $requestsDataTableRowValues = [$requestsDataTableRowValuesElement,];
    $requestsDataTableRow = (new DataTableRow())
        ->setValues($requestsDataTableRowValues);
    $updateDataTableRowRequest = (new UpdateDataTableRowRequest())
        ->setDataTableRow($requestsDataTableRow);
    $requests = [$updateDataTableRowRequest,];
    $request = (new BulkUpdateDataTableRowsRequest())
        ->setParent($formattedParent)
        ->setRequests($requests);

    // Call the API and handle any network failures.
    try {
        /** @var BulkUpdateDataTableRowsResponse $response */
        $response = $dataTableServiceClient->bulkUpdateDataTableRows($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 = DataTableServiceClient::dataTableName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]',
        '[DATA_TABLE]'
    );
    $requestsDataTableRowValuesElement = '[VALUES]';

    bulk_update_data_table_rows_sample($formattedParent, $requestsDataTableRowValuesElement);
}

createDataTable

Create a new data table.

The async variant is DataTableServiceClient::createDataTableAsync() .

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\CreateDataTableRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

 Google\ApiCore\RetrySettings 
|array

Returns

Type

Description

 Google\Cloud\Chronicle\V1\DataTable

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\DataTableServiceClient;
use Google\Cloud\Chronicle\V1\CreateDataTableRequest;
use Google\Cloud\Chronicle\V1\DataTable;

/**
 * @param string $formattedParent      The parent resource where this data table will be created.
 *                                     Format: projects/{project}/locations/{location}/instances/{instance}
 *                                     Please see {@see DataTableServiceClient::instanceName()} for help formatting this field.
 * @param string $dataTableDescription A user-provided description of the data table.
 * @param string $dataTableId          The ID to use for the data table. This is also the display name
 *                                     for the data table. It must satisfy the following requirements:
 *                                     - Starts with letter.
 *                                     - Contains only letters, numbers and underscore.
 *                                     - Must be unique and has length < 256.
 */
function create_data_table_sample(
    string $formattedParent,
    string $dataTableDescription,
    string $dataTableId
): void {
    // Create a client.
    $dataTableServiceClient = new DataTableServiceClient();

    // Prepare the request message.
    $dataTable = (new DataTable())
        ->setDescription($dataTableDescription);
    $request = (new CreateDataTableRequest())
        ->setParent($formattedParent)
        ->setDataTable($dataTable)
        ->setDataTableId($dataTableId);

    // Call the API and handle any network failures.
    try {
        /** @var DataTable $response */
        $response = $dataTableServiceClient->createDataTable($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 = DataTableServiceClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');
    $dataTableDescription = '[DESCRIPTION]';
    $dataTableId = '[DATA_TABLE_ID]';

    create_data_table_sample($formattedParent, $dataTableDescription, $dataTableId);
}

createDataTableRow

Create a new data table row.

The async variant is DataTableServiceClient::createDataTableRowAsync() .

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\CreateDataTableRowRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

 Google\ApiCore\RetrySettings 
|array

Returns

Type

Description

 Google\Cloud\Chronicle\V1\DataTableRow

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\DataTableServiceClient;
use Google\Cloud\Chronicle\V1\CreateDataTableRowRequest;
use Google\Cloud\Chronicle\V1\DataTableRow;

/**
 * @param string $formattedParent           The resource id of the data table.
 *                                          Format:
 *                                          /projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
 *                                          Please see {@see DataTableServiceClient::dataTableName()} for help formatting this field.
 * @param string $dataTableRowValuesElement All column values for a single row. The values should be in the
 *                                          same order as the columns of the data tables.
 */
function create_data_table_row_sample(
    string $formattedParent,
    string $dataTableRowValuesElement
): void {
    // Create a client.
    $dataTableServiceClient = new DataTableServiceClient();

    // Prepare the request message.
    $dataTableRowValues = [$dataTableRowValuesElement,];
    $dataTableRow = (new DataTableRow())
        ->setValues($dataTableRowValues);
    $request = (new CreateDataTableRowRequest())
        ->setParent($formattedParent)
        ->setDataTableRow($dataTableRow);

    // Call the API and handle any network failures.
    try {
        /** @var DataTableRow $response */
        $response = $dataTableServiceClient->createDataTableRow($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 = DataTableServiceClient::dataTableName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]',
        '[DATA_TABLE]'
    );
    $dataTableRowValuesElement = '[VALUES]';

    create_data_table_row_sample($formattedParent, $dataTableRowValuesElement);
}

deleteDataTable

Delete data table.

The async variant is DataTableServiceClient::deleteDataTableAsync() .

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\DeleteDataTableRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

 Google\ApiCore\RetrySettings 
|array

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\DataTableServiceClient;
use Google\Cloud\Chronicle\V1\DeleteDataTableRequest;

/**
 * @param string $formattedName The resource name of the data table to delete.
 *                              Format
 *                              projects/{project}/locations/{location}/instances/{instances}/dataTables/{data_table}
 *                              Please see {@see DataTableServiceClient::dataTableName()} for help formatting this field.
 */
function delete_data_table_sample(string $formattedName): void
{
    // Create a client.
    $dataTableServiceClient = new DataTableServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $dataTableServiceClient->deleteDataTable($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 = DataTableServiceClient::dataTableName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]',
        '[DATA_TABLE]'
    );

    delete_data_table_sample($formattedName);
}

deleteDataTableRow

Delete data table row.

The async variant is DataTableServiceClient::deleteDataTableRowAsync() .

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\DeleteDataTableRowRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

 Google\ApiCore\RetrySettings 
|array

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\DataTableServiceClient;
use Google\Cloud\Chronicle\V1\DeleteDataTableRowRequest;

/**
 * @param string $formattedName The resource name of the data table row i,e row_id.
 *                              Format:
 *                              projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row}
 *                              Please see {@see DataTableServiceClient::dataTableRowName()} for help formatting this field.
 */
function delete_data_table_row_sample(string $formattedName): void
{
    // Create a client.
    $dataTableServiceClient = new DataTableServiceClient();

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

    // Call the API and handle any network failures.
    try {
        $dataTableServiceClient->deleteDataTableRow($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 = DataTableServiceClient::dataTableRowName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]',
        '[DATA_TABLE]',
        '[DATA_TABLE_ROW]'
    );

    delete_data_table_row_sample($formattedName);
}

getDataTable

Get data table info.

The async variant is DataTableServiceClient::getDataTableAsync() .

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\GetDataTableRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

 Google\ApiCore\RetrySettings 
|array

Returns

Type

Description

 Google\Cloud\Chronicle\V1\DataTable

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\DataTableServiceClient;
use Google\Cloud\Chronicle\V1\DataTable;
use Google\Cloud\Chronicle\V1\GetDataTableRequest;

/**
 * @param string $formattedName The resource name of the data table to retrieve.
 *                              Format:
 *                              projects/{project}/locations/{location}/instances/{instances}/dataTables/{data_table}
 *                              Please see {@see DataTableServiceClient::dataTableName()} for help formatting this field.
 */
function get_data_table_sample(string $formattedName): void
{
    // Create a client.
    $dataTableServiceClient = new DataTableServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var DataTable $response */
        $response = $dataTableServiceClient->getDataTable($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 = DataTableServiceClient::dataTableName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]',
        '[DATA_TABLE]'
    );

    get_data_table_sample($formattedName);
}

getDataTableOperationErrors

Get the error for a data table operation.

The async variant is DataTableServiceClient::getDataTableOperationErrorsAsync() .

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\GetDataTableOperationErrorsRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

 Google\ApiCore\RetrySettings 
|array

Returns

Type

Description

 Google\Cloud\Chronicle\V1\DataTableOperationErrors

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\DataTableServiceClient;
use Google\Cloud\Chronicle\V1\DataTableOperationErrors;
use Google\Cloud\Chronicle\V1\GetDataTableOperationErrorsRequest;

/**
 * @param string $formattedName Resource name for the data table operation errors.
 *                              Format:
 *                              projects/{project}/locations/{location}/instances/{instance}/dataTableOperationErrors/{data_table_operation_errors}
 *                              Please see {@see DataTableServiceClient::dataTableOperationErrorsName()} for help formatting this field.
 */
function get_data_table_operation_errors_sample(string $formattedName): void
{
    // Create a client.
    $dataTableServiceClient = new DataTableServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var DataTableOperationErrors $response */
        $response = $dataTableServiceClient->getDataTableOperationErrors($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 = DataTableServiceClient::dataTableOperationErrorsName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]',
        '[DATA_TABLE_OPERATION_ERRORS]'
    );

    get_data_table_operation_errors_sample($formattedName);
}

getDataTableRow

Get data table row

The async variant is DataTableServiceClient::getDataTableRowAsync() .

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\GetDataTableRowRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

 Google\ApiCore\RetrySettings 
|array

Returns

Type

Description

 Google\Cloud\Chronicle\V1\DataTableRow

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\DataTableServiceClient;
use Google\Cloud\Chronicle\V1\DataTableRow;
use Google\Cloud\Chronicle\V1\GetDataTableRowRequest;

/**
 * @param string $formattedName The resource name of the data table row i,e row_id.
 *                              Format:
 *                              projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row}
 *                              Please see {@see DataTableServiceClient::dataTableRowName()} for help formatting this field.
 */
function get_data_table_row_sample(string $formattedName): void
{
    // Create a client.
    $dataTableServiceClient = new DataTableServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var DataTableRow $response */
        $response = $dataTableServiceClient->getDataTableRow($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 = DataTableServiceClient::dataTableRowName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]',
        '[DATA_TABLE]',
        '[DATA_TABLE_ROW]'
    );

    get_data_table_row_sample($formattedName);
}

listDataTableRows

List data table rows.

The async variant is DataTableServiceClient::listDataTableRowsAsync() .

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\ListDataTableRowsRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

 Google\ApiCore\RetrySettings 
|array

Returns

Type

Description

 Google\ApiCore\PagedListResponse

Example

 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Chronicle\V1\Client\DataTableServiceClient;
use Google\Cloud\Chronicle\V1\DataTableRow;
use Google\Cloud\Chronicle\V1\ListDataTableRowsRequest;

/**
 * @param string $formattedParent The resource id of the data table.
 *                                Format:
 *                                projects/{project}/locations/{locations}/instances/{instance}/dataTables/{data_table}
 *                                Please see {@see DataTableServiceClient::dataTableName()} for help formatting this field.
 */
function list_data_table_rows_sample(string $formattedParent): void
{
    // Create a client.
    $dataTableServiceClient = new DataTableServiceClient();

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

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

        /** @var DataTableRow $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 = DataTableServiceClient::dataTableName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]',
        '[DATA_TABLE]'
    );

    list_data_table_rows_sample($formattedParent);
}

listDataTables

List data tables.

The async variant is DataTableServiceClient::listDataTablesAsync() .

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\ListDataTablesRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

 Google\ApiCore\RetrySettings 
|array

Returns

Type

Description

 Google\ApiCore\PagedListResponse

Example

 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Chronicle\V1\Client\DataTableServiceClient;
use Google\Cloud\Chronicle\V1\DataTable;
use Google\Cloud\Chronicle\V1\ListDataTablesRequest;

/**
 * @param string $formattedParent The parent resource where this data table will be created.
 *                                Format: projects/{project}/locations/{location}/instances/{instance}
 *                                Please see {@see DataTableServiceClient::instanceName()} for help formatting this field.
 */
function list_data_tables_sample(string $formattedParent): void
{
    // Create a client.
    $dataTableServiceClient = new DataTableServiceClient();

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

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

        /** @var DataTable $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 = DataTableServiceClient::instanceName('[PROJECT]', '[LOCATION]', '[INSTANCE]');

    list_data_tables_sample($formattedParent);
}

updateDataTable

Update data table.

The async variant is DataTableServiceClient::updateDataTableAsync() .

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\UpdateDataTableRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

 Google\ApiCore\RetrySettings 
|array

Returns

Type

Description

 Google\Cloud\Chronicle\V1\DataTable

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\DataTableServiceClient;
use Google\Cloud\Chronicle\V1\DataTable;
use Google\Cloud\Chronicle\V1\UpdateDataTableRequest;

/**
 * @param string $dataTableDescription A user-provided description of the data table.
 */
function update_data_table_sample(string $dataTableDescription): void
{
    // Create a client.
    $dataTableServiceClient = new DataTableServiceClient();

    // Prepare the request message.
    $dataTable = (new DataTable())
        ->setDescription($dataTableDescription);
    $request = (new UpdateDataTableRequest())
        ->setDataTable($dataTable);

    // Call the API and handle any network failures.
    try {
        /** @var DataTable $response */
        $response = $dataTableServiceClient->updateDataTable($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
{
    $dataTableDescription = '[DESCRIPTION]';

    update_data_table_sample($dataTableDescription);
}

updateDataTableRow

Update data table row

The async variant is DataTableServiceClient::updateDataTableRowAsync() .

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\UpdateDataTableRowRequest

A request to house fields associated with the call.

callOptions

array

Optional.

↳ retrySettings

 Google\ApiCore\RetrySettings 
|array

Returns

Type

Description

 Google\Cloud\Chronicle\V1\DataTableRow

Example

 use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\DataTableServiceClient;
use Google\Cloud\Chronicle\V1\DataTableRow;
use Google\Cloud\Chronicle\V1\UpdateDataTableRowRequest;

/**
 * @param string $dataTableRowValuesElement All column values for a single row. The values should be in the
 *                                          same order as the columns of the data tables.
 */
function update_data_table_row_sample(string $dataTableRowValuesElement): void
{
    // Create a client.
    $dataTableServiceClient = new DataTableServiceClient();

    // Prepare the request message.
    $dataTableRowValues = [$dataTableRowValuesElement,];
    $dataTableRow = (new DataTableRow())
        ->setValues($dataTableRowValues);
    $request = (new UpdateDataTableRowRequest())
        ->setDataTableRow($dataTableRow);

    // Call the API and handle any network failures.
    try {
        /** @var DataTableRow $response */
        $response = $dataTableServiceClient->updateDataTableRow($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
{
    $dataTableRowValuesElement = '[VALUES]';

    update_data_table_row_sample($dataTableRowValuesElement);
}

bulkCreateDataTableRowsAsync

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\BulkCreateDataTableRowsRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\Cloud\Chronicle\V1\BulkCreateDataTableRowsResponse 
>

bulkGetDataTableRowsAsync

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\BulkGetDataTableRowsRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\Cloud\Chronicle\V1\BulkGetDataTableRowsResponse 
>

bulkReplaceDataTableRowsAsync

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\BulkReplaceDataTableRowsRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\Cloud\Chronicle\V1\BulkReplaceDataTableRowsResponse 
>

bulkUpdateDataTableRowsAsync

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\BulkUpdateDataTableRowsRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\Cloud\Chronicle\V1\BulkUpdateDataTableRowsResponse 
>

createDataTableAsync

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\CreateDataTableRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\Cloud\Chronicle\V1\DataTable 
>

createDataTableRowAsync

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\CreateDataTableRowRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\Cloud\Chronicle\V1\DataTableRow 
>

deleteDataTableAsync

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\DeleteDataTableRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< void 
>

deleteDataTableRowAsync

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\DeleteDataTableRowRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< void 
>

getDataTableAsync

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\GetDataTableRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\Cloud\Chronicle\V1\DataTable 
>

getDataTableOperationErrorsAsync

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\GetDataTableOperationErrorsRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\Cloud\Chronicle\V1\DataTableOperationErrors 
>

getDataTableRowAsync

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\GetDataTableRowRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\Cloud\Chronicle\V1\DataTableRow 
>

listDataTableRowsAsync

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\ListDataTableRowsRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\ApiCore\PagedListResponse 
>

listDataTablesAsync

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\ListDataTablesRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\ApiCore\PagedListResponse 
>

updateDataTableAsync

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\UpdateDataTableRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\Cloud\Chronicle\V1\DataTable 
>

updateDataTableRowAsync

Parameters

Name

Description

request

 Google\Cloud\Chronicle\V1\UpdateDataTableRowRequest

optionalArgs

array

Returns

Type

Description

 GuzzleHttp\Promise\PromiseInterface 
< Google\Cloud\Chronicle\V1\DataTableRow 
>

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

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

Parameters

Name

Description

project

string

location

string

instance

string

dataTable

string

Returns

Type

Description

string

The formatted data_table resource.

static::dataTableOperationErrorsName

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

Parameters

Name

Description

project

string

location

string

instance

string

dataTableOperationErrors

string

Returns

Type

Description

string

The formatted data_table_operation_errors resource.

static::dataTableRowName

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

Parameters

Name

Description

project

string

location

string

instance

string

dataTable

string

dataTableRow

string

Returns

Type

Description

string

The formatted data_table_row 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

dataAccessScope: projects/{project}/locations/{location}/instances/{instance}/dataAccessScopes/{data_access_scope}
dataTable: projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}
dataTableOperationErrors: projects/{project}/locations/{location}/instances/{instance}/dataTableOperationErrors/{data_table_operation_errors}
dataTableRow: projects/{project}/locations/{location}/instances/{instance}/dataTables/{data_table}/dataTableRows/{data_table_row}
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.

Google Cloud Chronicle V1 Client - Class DataTableServiceClient (0.4.0) Stay organized with collections Save and categorize content based on your preferences.

Namespace

Methods

__construct

bulkCreateDataTableRows

bulkGetDataTableRows

bulkReplaceDataTableRows

bulkUpdateDataTableRows

createDataTable

createDataTableRow

deleteDataTable

deleteDataTableRow

getDataTable

getDataTableOperationErrors

getDataTableRow

listDataTableRows

listDataTables

updateDataTable

updateDataTableRow

bulkCreateDataTableRowsAsync

bulkGetDataTableRowsAsync

bulkReplaceDataTableRowsAsync

bulkUpdateDataTableRowsAsync

createDataTableAsync

createDataTableRowAsync

deleteDataTableAsync

deleteDataTableRowAsync

getDataTableAsync

getDataTableOperationErrorsAsync

getDataTableRowAsync

listDataTableRowsAsync

listDataTablesAsync

updateDataTableAsync

updateDataTableRowAsync

static::dataAccessScopeName

static::dataTableName

static::dataTableOperationErrorsName

static::dataTableRowName

static::instanceName

static::parseName

Google Cloud Chronicle V1 Client - Class DataTableServiceClient (0.4.0)