Google Cloud Ids V1 Client - Class IDSClient (0.2.0)

Reference documentation and code samples for the Google Cloud Ids V1 Client class IDSClient.

Service Description: The IDS Service

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$iDSClient = new IDSClient();
try {
    $formattedParent = $iDSClient->locationName('[PROJECT]', '[LOCATION]');
    $endpointId = 'endpoint_id';
    $endpoint = new Endpoint();
    $operationResponse = $iDSClient->createEndpoint($formattedParent, $endpointId, $endpoint);
    $operationResponse->pollUntilComplete();
    if ($operationResponse->operationSucceeded()) {
        $result = $operationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $operationResponse->getError();
        // handleError($error)
    }
    // Alternatively:
    // start the operation, keep the operation name, and resume later
    $operationResponse = $iDSClient->createEndpoint($formattedParent, $endpointId, $endpoint);
    $operationName = $operationResponse->getName();
    // ... do other work
    $newOperationResponse = $iDSClient->resumeOperation($operationName, 'createEndpoint');
    while (!$newOperationResponse->isDone()) {
        // ... do other work
        $newOperationResponse->reload();
    }
    if ($newOperationResponse->operationSucceeded()) {
        $result = $newOperationResponse->getResult();
    // doSomethingWith($result)
    } else {
        $error = $newOperationResponse->getError();
        // handleError($error)
    }
} finally {
    $iDSClient->close();
}

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.

Methods

endpointName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`
`endpoint`	`string`

Returns
Type	Description
`string`	The formatted endpoint resource.

locationName

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

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

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

endpoint: projects/{project}/locations/{location}/endpoints/{endpoint}
location: projects/{project}/locations/{location}

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.

getOperationsClient

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

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `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.

createEndpoint

Creates a new Endpoint in a given project and location.

Parameters
Name	Description
`parent`	`string` Required. The endpoint's parent.
`endpointId`	`string` Required. The endpoint identifier. This will be part of the endpoint's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error.
`endpoint`	`Google\Cloud\Ids\V1\Endpoint` Required. The endpoint to create.
`optionalArgs`	`array` Optional.
`↳ requestId`	`string` An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Ids\V1\Client\IDSClient;
use Google\Cloud\Ids\V1\CreateEndpointRequest;
use Google\Cloud\Ids\V1\Endpoint;
use Google\Cloud\Ids\V1\Endpoint\Severity;
use Google\Rpc\Status;

/**
 * @param string $formattedParent  The endpoint's parent. Please see
 *                                 {@see IDSClient::locationName()} for help formatting this field.
 * @param string $endpointId       The endpoint identifier. This will be part of the endpoint's
 *                                 resource name.
 *                                 This value must start with a lowercase letter followed by up to 62
 *                                 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
 *                                 Values that do not match this pattern will trigger an INVALID_ARGUMENT
 *                                 error.
 * @param string $endpointNetwork  The fully qualified URL of the network to which the IDS Endpoint is
 *                                 attached.
 * @param int    $endpointSeverity Lowest threat severity that this endpoint will alert on.
 */
function create_endpoint_sample(
    string $formattedParent,
    string $endpointId,
    string $endpointNetwork,
    int $endpointSeverity
): void {
    // Create a client.
    $iDSClient = new IDSClient();

    // Prepare the request message.
    $endpoint = (new Endpoint())
        ->setNetwork($endpointNetwork)
        ->setSeverity($endpointSeverity);
    $request = (new CreateEndpointRequest())
        ->setParent($formattedParent)
        ->setEndpointId($endpointId)
        ->setEndpoint($endpoint);

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

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

/**
 * 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 = IDSClient::locationName('[PROJECT]', '[LOCATION]');
    $endpointId = '[ENDPOINT_ID]';
    $endpointNetwork = '[NETWORK]';
    $endpointSeverity = Severity::SEVERITY_UNSPECIFIED;

    create_endpoint_sample($formattedParent, $endpointId, $endpointNetwork, $endpointSeverity);
}

deleteEndpoint

Deletes a single Endpoint.

Parameters
Name	Description
`name`	`string` Required. The name of the endpoint to delete.
`optionalArgs`	`array` Optional.
`↳ requestId`	`string` An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Ids\V1\Client\IDSClient;
use Google\Cloud\Ids\V1\DeleteEndpointRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName The name of the endpoint to delete. Please see
 *                              {@see IDSClient::endpointName()} for help formatting this field.
 */
function delete_endpoint_sample(string $formattedName): void
{
    // Create a client.
    $iDSClient = new IDSClient();

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

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

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

/**
 * 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 = IDSClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');

    delete_endpoint_sample($formattedName);
}

getEndpoint

Gets details of a single Endpoint.

Parameters
Name	Description
`name`	`string` Required. The name of the endpoint to retrieve. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
`optionalArgs`	`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\Ids\V1\Endpoint`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Ids\V1\Client\IDSClient;
use Google\Cloud\Ids\V1\Endpoint;
use Google\Cloud\Ids\V1\GetEndpointRequest;

/**
 * @param string $formattedName The name of the endpoint to retrieve.
 *                              Format: `projects/{project}/locations/{location}/endpoints/{endpoint}`
 *                              Please see {@see IDSClient::endpointName()} for help formatting this field.
 */
function get_endpoint_sample(string $formattedName): void
{
    // Create a client.
    $iDSClient = new IDSClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Endpoint $response */
        $response = $iDSClient->getEndpoint($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * 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 = IDSClient::endpointName('[PROJECT]', '[LOCATION]', '[ENDPOINT]');

    get_endpoint_sample($formattedName);
}

listEndpoints

Lists Endpoints in a given project and location.

Parameters
Name	Description
`parent`	`string` Required. The parent, which owns this collection of endpoints.
`optionalArgs`	`array` Optional.
`↳ pageSize`	`int` The maximum number of resources contained in the underlying API response. The API may return fewer values in a page, even if there are additional values to be retrieved.
`↳ pageToken`	`string` A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API.
`↳ filter`	`string` Optional. The filter expression, following the syntax outlined in https://google.aip.dev/160.
`↳ orderBy`	`string` Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.
`↳ 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\Ids\V1\Client\IDSClient;
use Google\Cloud\Ids\V1\Endpoint;
use Google\Cloud\Ids\V1\ListEndpointsRequest;

/**
 * @param string $formattedParent The parent, which owns this collection of endpoints. Please see
 *                                {@see IDSClient::locationName()} for help formatting this field.
 */
function list_endpoints_sample(string $formattedParent): void
{
    // Create a client.
    $iDSClient = new IDSClient();

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

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

        /** @var Endpoint $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());
    }
}

/**
 * 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 = IDSClient::locationName('[PROJECT]', '[LOCATION]');

    list_endpoints_sample($formattedParent);
}

Constants

SERVICE_NAME

Value: 'google.cloud.ids.v1.IDS'

The name of the service.

SERVICE_ADDRESS

Value: 'ids.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.