Google Cloud Chronicle V1 Client - Class ReferenceListServiceClient (0.1.2)

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

Service Description: ReferenceListService provides an interface for managing reference lists.

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` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information https://cloud.google.com/docs/authentication/external/externally-sourced-credentials
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.
`↳ logger`	`false\|LoggerInterface` A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

createReferenceList

Creates a new reference list.

The async variant is ReferenceListServiceClient::createReferenceListAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Chronicle\V1\CreateReferenceListRequest` 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\ReferenceList`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\ReferenceListServiceClient;
use Google\Cloud\Chronicle\V1\CreateReferenceListRequest;
use Google\Cloud\Chronicle\V1\ReferenceList;
use Google\Cloud\Chronicle\V1\ReferenceListEntry;
use Google\Cloud\Chronicle\V1\ReferenceListSyntaxType;

/**
 * @param string $formattedParent           The parent resource where this reference list will be created.
 *                                          Format: `projects/{project}/locations/{location}/instances/{instance}`
 *                                          Please see {@see ReferenceListServiceClient::instanceName()} for help formatting this field.
 * @param string $referenceListDescription  A user-provided description of the reference list.
 * @param string $referenceListEntriesValue The value of the entry. Maximum length is 512 characters.
 * @param int    $referenceListSyntaxType   The syntax type indicating how list entries should be validated.
 * @param string $referenceListId           The ID to use for the reference list. This is also the display
 *                                          name for the reference list. It must satisfy the following requirements:
 *                                          - Starts with letter.
 *                                          - Contains only letters, numbers and underscore.
 *                                          - Has length less than 256.
 *                                          - Must be unique.
 */
function create_reference_list_sample(
    string $formattedParent,
    string $referenceListDescription,
    string $referenceListEntriesValue,
    int $referenceListSyntaxType,
    string $referenceListId
): void {
    // Create a client.
    $referenceListServiceClient = new ReferenceListServiceClient();

    // Prepare the request message.
    $referenceListEntry = (new ReferenceListEntry())
        ->setValue($referenceListEntriesValue);
    $referenceListEntries = [$referenceListEntry,];
    $referenceList = (new ReferenceList())
        ->setDescription($referenceListDescription)
        ->setEntries($referenceListEntries)
        ->setSyntaxType($referenceListSyntaxType);
    $request = (new CreateReferenceListRequest())
        ->setParent($formattedParent)
        ->setReferenceList($referenceList)
        ->setReferenceListId($referenceListId);

    // Call the API and handle any network failures.
    try {
        /** @var ReferenceList $response */
        $response = $referenceListServiceClient->createReferenceList($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 = ReferenceListServiceClient::instanceName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]'
    );
    $referenceListDescription = '[DESCRIPTION]';
    $referenceListEntriesValue = '[VALUE]';
    $referenceListSyntaxType = ReferenceListSyntaxType::REFERENCE_LIST_SYNTAX_TYPE_UNSPECIFIED;
    $referenceListId = '[REFERENCE_LIST_ID]';

    create_reference_list_sample(
        $formattedParent,
        $referenceListDescription,
        $referenceListEntriesValue,
        $referenceListSyntaxType,
        $referenceListId
    );
}

getReferenceList

Gets a single reference list.

The async variant is ReferenceListServiceClient::getReferenceListAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Chronicle\V1\GetReferenceListRequest` 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\ReferenceList`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\ReferenceListServiceClient;
use Google\Cloud\Chronicle\V1\GetReferenceListRequest;
use Google\Cloud\Chronicle\V1\ReferenceList;

/**
 * @param string $formattedName The resource name of the reference list to retrieve.
 *                              Format:
 *                              `projects/{project}/locations/{locations}/instances/{instance}/referenceLists/{reference_list}`
 *                              Please see {@see ReferenceListServiceClient::referenceListName()} for help formatting this field.
 */
function get_reference_list_sample(string $formattedName): void
{
    // Create a client.
    $referenceListServiceClient = new ReferenceListServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var ReferenceList $response */
        $response = $referenceListServiceClient->getReferenceList($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 = ReferenceListServiceClient::referenceListName(
        '[PROJECT]',
        '[LOCATION]',
        '[INSTANCE]',
        '[REFERENCE_LIST]'
    );

    get_reference_list_sample($formattedName);
}

listReferenceLists

Lists a collection of reference lists.

The async variant is ReferenceListServiceClient::listReferenceListsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Chronicle\V1\ListReferenceListsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Chronicle\V1\Client\ReferenceListServiceClient;
use Google\Cloud\Chronicle\V1\ListReferenceListsRequest;
use Google\Cloud\Chronicle\V1\ReferenceList;

/**
 * @param string $formattedParent The parent, which owns this collection of reference lists.
 *                                Format:
 *                                `projects/{project}/locations/{location}/instances/{instance}`
 *                                Please see {@see ReferenceListServiceClient::instanceName()} for help formatting this field.
 */
function list_reference_lists_sample(string $formattedParent): void
{
    // Create a client.
    $referenceListServiceClient = new ReferenceListServiceClient();

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

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

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

    list_reference_lists_sample($formattedParent);
}

updateReferenceList

Updates an existing reference list.

The async variant is ReferenceListServiceClient::updateReferenceListAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Chronicle\V1\UpdateReferenceListRequest` 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\ReferenceList`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Chronicle\V1\Client\ReferenceListServiceClient;
use Google\Cloud\Chronicle\V1\ReferenceList;
use Google\Cloud\Chronicle\V1\ReferenceListEntry;
use Google\Cloud\Chronicle\V1\ReferenceListSyntaxType;
use Google\Cloud\Chronicle\V1\UpdateReferenceListRequest;

/**
 * @param string $referenceListDescription  A user-provided description of the reference list.
 * @param string $referenceListEntriesValue The value of the entry. Maximum length is 512 characters.
 * @param int    $referenceListSyntaxType   The syntax type indicating how list entries should be validated.
 */
function update_reference_list_sample(
    string $referenceListDescription,
    string $referenceListEntriesValue,
    int $referenceListSyntaxType
): void {
    // Create a client.
    $referenceListServiceClient = new ReferenceListServiceClient();

    // Prepare the request message.
    $referenceListEntry = (new ReferenceListEntry())
        ->setValue($referenceListEntriesValue);
    $referenceListEntries = [$referenceListEntry,];
    $referenceList = (new ReferenceList())
        ->setDescription($referenceListDescription)
        ->setEntries($referenceListEntries)
        ->setSyntaxType($referenceListSyntaxType);
    $request = (new UpdateReferenceListRequest())
        ->setReferenceList($referenceList);

    // Call the API and handle any network failures.
    try {
        /** @var ReferenceList $response */
        $response = $referenceListServiceClient->updateReferenceList($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
{
    $referenceListDescription = '[DESCRIPTION]';
    $referenceListEntriesValue = '[VALUE]';
    $referenceListSyntaxType = ReferenceListSyntaxType::REFERENCE_LIST_SYNTAX_TYPE_UNSPECIFIED;

    update_reference_list_sample(
        $referenceListDescription,
        $referenceListEntriesValue,
        $referenceListSyntaxType
    );
}

createReferenceListAsync

Parameters
Name	Description
`request`	`Google\Cloud\Chronicle\V1\CreateReferenceListRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Chronicle\V1\ReferenceList>`

getReferenceListAsync

Parameters
Name	Description
`request`	`Google\Cloud\Chronicle\V1\GetReferenceListRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Chronicle\V1\ReferenceList>`

listReferenceListsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Chronicle\V1\ListReferenceListsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

updateReferenceListAsync

Parameters
Name	Description
`request`	`Google\Cloud\Chronicle\V1\UpdateReferenceListRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Chronicle\V1\ReferenceList>`

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

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`instance`	`string`
`referenceList`	`string`

Returns
Type	Description
`string`	The formatted reference_list 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

instance: projects/{project}/locations/{location}/instances/{instance}
referenceList: projects/{project}/locations/{location}/instances/{instance}/referenceLists/{reference_list}

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 ReferenceListServiceClient (0.1.2) Stay organized with collections Save and categorize content based on your preferences.

Namespace

Methods

__construct

createReferenceList

getReferenceList

listReferenceLists

updateReferenceList

createReferenceListAsync

getReferenceListAsync

listReferenceListsAsync

updateReferenceListAsync

static::instanceName

static::referenceListName

static::parseName

Google Cloud Chronicle V1 Client - Class ReferenceListServiceClient (0.1.2)