Google Cloud Network Security V1 Client - Class SSERealmServiceClient (1.4.0)

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkSecurity\V1\Client\SSERealmServiceClient;
use Google\Cloud\NetworkSecurity\V1\CreateSACAttachmentRequest;
use Google\Cloud\NetworkSecurity\V1\SACAttachment;
use Google\Rpc\Status;

/**
 * @param string $formattedParent         The parent, in the form
 *                                        `projects/{project}/locations/{location}`. Please see
 *                                        {@see SSERealmServiceClient::locationName()} for help formatting this field.
 * @param string $sacAttachmentId         ID of the created attachment.
 *                                        The ID must be 1-63 characters long, and comply with
 *                                        <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
 *                                        Specifically, it must be 1-63 characters long and match the regular
 *                                        expression `[a-z]([-a-z0-9]*[a-z0-9])?`
 *                                        which means the first character must be a lowercase letter, and all
 *                                        following characters must be a dash, lowercase letter, or digit, except
 *                                        the last character, which cannot be a dash.
 * @param string $sacAttachmentSacRealm   SAC Realm which owns the attachment. This can be input as an ID
 *                                        or a full resource name. The output always has the form
 *                                        `projects/{project_number}/locations/{location}/sacRealms/{sac_realm}`.
 * @param string $sacAttachmentNccGateway NCC Gateway associated with the attachment. This can be input as
 *                                        an ID or a full resource name. The output always has the form
 *                                        `projects/{project_number}/locations/{location}/spokes/{ncc_gateway}`.
 */
function create_sac_attachment_sample(
    string $formattedParent,
    string $sacAttachmentId,
    string $sacAttachmentSacRealm,
    string $sacAttachmentNccGateway
): void {
    // Create a client.
    $sSERealmServiceClient = new SSERealmServiceClient();

    // Prepare the request message.
    $sacAttachment = (new SACAttachment())
        ->setSacRealm($sacAttachmentSacRealm)
        ->setNccGateway($sacAttachmentNccGateway);
    $request = (new CreateSACAttachmentRequest())
        ->setParent($formattedParent)
        ->setSacAttachmentId($sacAttachmentId)
        ->setSacAttachment($sacAttachment);

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

        if ($response->operationSucceeded()) {
            /** @var SACAttachment $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());
    }
}

/**
 * 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 = SSERealmServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $sacAttachmentId = '[SAC_ATTACHMENT_ID]';
    $sacAttachmentSacRealm = '[SAC_REALM]';
    $sacAttachmentNccGateway = '[NCC_GATEWAY]';

    create_sac_attachment_sample(
        $formattedParent,
        $sacAttachmentId,
        $sacAttachmentSacRealm,
        $sacAttachmentNccGateway
    );
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkSecurity\V1\Client\SSERealmServiceClient;
use Google\Cloud\NetworkSecurity\V1\CreateSACRealmRequest;
use Google\Cloud\NetworkSecurity\V1\SACRealm;
use Google\Rpc\Status;

/**
 * @param string $formattedParent The parent, in the form `projects/{project}/locations/global`. Please see
 *                                {@see SSERealmServiceClient::locationName()} for help formatting this field.
 * @param string $sacRealmId      ID of the created realm.
 *                                The ID must be 1-63 characters long, and comply with
 *                                <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
 *                                Specifically, it must be 1-63 characters long and match the regular
 *                                expression `[a-z]([-a-z0-9]*[a-z0-9])?`
 *                                which means the first character must be a lowercase letter, and all
 *                                following characters must be a dash, lowercase letter, or digit, except
 *                                the last character, which cannot be a dash.
 */
function create_sac_realm_sample(string $formattedParent, string $sacRealmId): void
{
    // Create a client.
    $sSERealmServiceClient = new SSERealmServiceClient();

    // Prepare the request message.
    $sacRealm = new SACRealm();
    $request = (new CreateSACRealmRequest())
        ->setParent($formattedParent)
        ->setSacRealmId($sacRealmId)
        ->setSacRealm($sacRealm);

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

        if ($response->operationSucceeded()) {
            /** @var SACRealm $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());
    }
}

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

    create_sac_realm_sample($formattedParent, $sacRealmId);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkSecurity\V1\Client\SSERealmServiceClient;
use Google\Cloud\NetworkSecurity\V1\DeleteSACAttachmentRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName Name of the resource, in the form
 *                              `projects/{project}/locations/{location}/sacAttachments/{sac_attachment}`. Please see
 *                              {@see SSERealmServiceClient::sACAttachmentName()} for help formatting this field.
 */
function delete_sac_attachment_sample(string $formattedName): void
{
    // Create a client.
    $sSERealmServiceClient = new SSERealmServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $sSERealmServiceClient->deleteSACAttachment($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());
    }
}

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

    delete_sac_attachment_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\NetworkSecurity\V1\Client\SSERealmServiceClient;
use Google\Cloud\NetworkSecurity\V1\DeleteSACRealmRequest;
use Google\Rpc\Status;

/**
 * @param string $formattedName Name of the resource, in the form
 *                              `projects/{project}/locations/global/sacRealms/{sacRealm}`. Please see
 *                              {@see SSERealmServiceClient::sACRealmName()} for help formatting this field.
 */
function delete_sac_realm_sample(string $formattedName): void
{
    // Create a client.
    $sSERealmServiceClient = new SSERealmServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $sSERealmServiceClient->deleteSACRealm($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());
    }
}

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

    delete_sac_realm_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\NetworkSecurity\V1\Client\SSERealmServiceClient;
use Google\Cloud\NetworkSecurity\V1\GetSACAttachmentRequest;
use Google\Cloud\NetworkSecurity\V1\SACAttachment;

/**
 * @param string $formattedName Name of the resource, in the form
 *                              `projects/{project}/locations/{location}/sacAttachments/{sac_attachment}`. Please see
 *                              {@see SSERealmServiceClient::sACAttachmentName()} for help formatting this field.
 */
function get_sac_attachment_sample(string $formattedName): void
{
    // Create a client.
    $sSERealmServiceClient = new SSERealmServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var SACAttachment $response */
        $response = $sSERealmServiceClient->getSACAttachment($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 = SSERealmServiceClient::sACAttachmentName(
        '[PROJECT]',
        '[LOCATION]',
        '[SAC_ATTACHMENT]'
    );

    get_sac_attachment_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\NetworkSecurity\V1\Client\SSERealmServiceClient;
use Google\Cloud\NetworkSecurity\V1\GetSACRealmRequest;
use Google\Cloud\NetworkSecurity\V1\SACRealm;

/**
 * @param string $formattedName Name of the resource, in the form
 *                              `projects/{project}/locations/global/sacRealms/{sacRealm}`. Please see
 *                              {@see SSERealmServiceClient::sACRealmName()} for help formatting this field.
 */
function get_sac_realm_sample(string $formattedName): void
{
    // Create a client.
    $sSERealmServiceClient = new SSERealmServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var SACRealm $response */
        $response = $sSERealmServiceClient->getSACRealm($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 = SSERealmServiceClient::sACRealmName('[PROJECT]', '[LOCATION]', '[SAC_REALM]');

    get_sac_realm_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\NetworkSecurity\V1\Client\SSERealmServiceClient;
use Google\Cloud\NetworkSecurity\V1\ListSACAttachmentsRequest;
use Google\Cloud\NetworkSecurity\V1\SACAttachment;

/**
 * @param string $formattedParent The parent, in the form
 *                                `projects/{project}/locations/{location}`. Please see
 *                                {@see SSERealmServiceClient::locationName()} for help formatting this field.
 */
function list_sac_attachments_sample(string $formattedParent): void
{
    // Create a client.
    $sSERealmServiceClient = new SSERealmServiceClient();

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

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

        /** @var SACAttachment $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 = SSERealmServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_sac_attachments_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\NetworkSecurity\V1\Client\SSERealmServiceClient;
use Google\Cloud\NetworkSecurity\V1\ListSACRealmsRequest;
use Google\Cloud\NetworkSecurity\V1\SACRealm;

/**
 * @param string $formattedParent The parent, in the form `projects/{project}/locations/global`. Please see
 *                                {@see SSERealmServiceClient::locationName()} for help formatting this field.
 */
function list_sac_realms_sample(string $formattedParent): void
{
    // Create a client.
    $sSERealmServiceClient = new SSERealmServiceClient();

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

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

        /** @var SACRealm $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 = SSERealmServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_sac_realms_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkSecurity\V1\Client\SSERealmServiceClient;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function get_location_sample(): void
{
    // Create a client.
    $sSERealmServiceClient = new SSERealmServiceClient();

    // Prepare the request message.
    $request = new GetLocationRequest();

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

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkSecurity\V1\Client\SSERealmServiceClient;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function list_locations_sample(): void
{
    // Create a client.
    $sSERealmServiceClient = new SSERealmServiceClient();

    // Prepare the request message.
    $request = new ListLocationsRequest();

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

        /** @var Location $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\NetworkSecurity\V1\Client\SSERealmServiceClient;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being requested.
 *                         See the operation documentation for the appropriate value for this field.
 */
function get_iam_policy_sample(string $resource): void
{
    // Create a client.
    $sSERealmServiceClient = new SSERealmServiceClient();

    // Prepare the request message.
    $request = (new GetIamPolicyRequest())
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $sSERealmServiceClient->getIamPolicy($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
{
    $resource = '[RESOURCE]';

    get_iam_policy_sample($resource);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\NetworkSecurity\V1\Client\SSERealmServiceClient;

/**
 * @param string $resource REQUIRED: The resource for which the policy is being specified.
 *                         See the operation documentation for the appropriate value for this field.
 */
function set_iam_policy_sample(string $resource): void
{
    // Create a client.
    $sSERealmServiceClient = new SSERealmServiceClient();

    // Prepare the request message.
    $policy = new Policy();
    $request = (new SetIamPolicyRequest())
        ->setResource($resource)
        ->setPolicy($policy);

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $sSERealmServiceClient->setIamPolicy($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
{
    $resource = '[RESOURCE]';

    set_iam_policy_sample($resource);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\NetworkSecurity\V1\Client\SSERealmServiceClient;

/**
 * @param string $resource           REQUIRED: The resource for which the policy detail is being requested.
 *                                   See the operation documentation for the appropriate value for this field.
 * @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
 *                                   wildcards (such as '*' or 'storage.*') are not allowed. For more
 *                                   information see
 *                                   [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
 */
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
    // Create a client.
    $sSERealmServiceClient = new SSERealmServiceClient();

    // Prepare the request message.
    $permissions = [$permissionsElement,];
    $request = (new TestIamPermissionsRequest())
        ->setResource($resource)
        ->setPermissions($permissions);

    // Call the API and handle any network failures.
    try {
        /** @var TestIamPermissionsResponse $response */
        $response = $sSERealmServiceClient->testIamPermissions($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
{
    $resource = '[RESOURCE]';
    $permissionsElement = '[PERMISSIONS]';

    test_iam_permissions_sample($resource, $permissionsElement);
}