Cloud PubSub V1 Client - Class SchemaServiceClient (1.46.5)

use Google\ApiCore\ApiException;
use Google\Cloud\PubSub\V1\Schema;
use Google\Cloud\PubSub\V1\SchemaServiceClient;

/**
 * @param string $formattedName The name of the schema we are revising.
 *                              Format is `projects/{project}/schemas/{schema}`. Please see
 *                              {@see SchemaServiceClient::schemaName()} for help formatting this field.
 * @param string $schemaName    Name of the schema.
 *                              Format is `projects/{project}/schemas/{schema}`.
 */
function commit_schema_sample(string $formattedName, string $schemaName): void
{
    // Create a client.
    $schemaServiceClient = new SchemaServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $schema = (new Schema())
        ->setName($schemaName);

    // Call the API and handle any network failures.
    try {
        /** @var Schema $response */
        $response = $schemaServiceClient->commitSchema($formattedName, $schema);
        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 = SchemaServiceClient::schemaName('[PROJECT]', '[SCHEMA]');
    $schemaName = '[NAME]';

    commit_schema_sample($formattedName, $schemaName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\PubSub\V1\Schema;
use Google\Cloud\PubSub\V1\SchemaServiceClient;

/**
 * @param string $formattedParent The name of the project in which to create the schema.
 *                                Format is `projects/{project-id}`. Please see
 *                                {@see SchemaServiceClient::projectName()} for help formatting this field.
 * @param string $schemaName      Name of the schema.
 *                                Format is `projects/{project}/schemas/{schema}`.
 */
function create_schema_sample(string $formattedParent, string $schemaName): void
{
    // Create a client.
    $schemaServiceClient = new SchemaServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $schema = (new Schema())
        ->setName($schemaName);

    // Call the API and handle any network failures.
    try {
        /** @var Schema $response */
        $response = $schemaServiceClient->createSchema($formattedParent, $schema);
        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 = SchemaServiceClient::projectName('[PROJECT]');
    $schemaName = '[NAME]';

    create_schema_sample($formattedParent, $schemaName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\PubSub\V1\SchemaServiceClient;

/**
 * @param string $formattedName Name of the schema to delete.
 *                              Format is `projects/{project}/schemas/{schema}`. Please see
 *                              {@see SchemaServiceClient::schemaName()} for help formatting this field.
 */
function delete_schema_sample(string $formattedName): void
{
    // Create a client.
    $schemaServiceClient = new SchemaServiceClient();

    // Call the API and handle any network failures.
    try {
        $schemaServiceClient->deleteSchema($formattedName);
        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 = SchemaServiceClient::schemaName('[PROJECT]', '[SCHEMA]');

    delete_schema_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\PubSub\V1\Schema;
use Google\Cloud\PubSub\V1\SchemaServiceClient;

/**
 * @param string $formattedName The name of the schema revision to be deleted, with a revision ID
 *                              explicitly included.
 *
 *                              Example: `projects/123/schemas/my-schema@c7cfa2a8`
 *                              Please see {@see SchemaServiceClient::schemaName()} for help formatting this field.
 * @param string $revisionId    Optional. This field is deprecated and should not be used for specifying
 *                              the revision ID. The revision ID should be specified via the `name`
 *                              parameter.
 */
function delete_schema_revision_sample(string $formattedName, string $revisionId): void
{
    // Create a client.
    $schemaServiceClient = new SchemaServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var Schema $response */
        $response = $schemaServiceClient->deleteSchemaRevision($formattedName, $revisionId);
        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 = SchemaServiceClient::schemaName('[PROJECT]', '[SCHEMA]');
    $revisionId = '[REVISION_ID]';

    delete_schema_revision_sample($formattedName, $revisionId);
}

use Google\ApiCore\ApiException;
use Google\Cloud\PubSub\V1\Schema;
use Google\Cloud\PubSub\V1\SchemaServiceClient;

/**
 * @param string $formattedName The name of the schema to get.
 *                              Format is `projects/{project}/schemas/{schema}`. Please see
 *                              {@see SchemaServiceClient::schemaName()} for help formatting this field.
 */
function get_schema_sample(string $formattedName): void
{
    // Create a client.
    $schemaServiceClient = new SchemaServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var Schema $response */
        $response = $schemaServiceClient->getSchema($formattedName);
        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 = SchemaServiceClient::schemaName('[PROJECT]', '[SCHEMA]');

    get_schema_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\PubSub\V1\Schema;
use Google\Cloud\PubSub\V1\SchemaServiceClient;

/**
 * @param string $formattedName The name of the schema to list revisions for. Please see
 *                              {@see SchemaServiceClient::schemaName()} for help formatting this field.
 */
function list_schema_revisions_sample(string $formattedName): void
{
    // Create a client.
    $schemaServiceClient = new SchemaServiceClient();

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

        /** @var Schema $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
{
    $formattedName = SchemaServiceClient::schemaName('[PROJECT]', '[SCHEMA]');

    list_schema_revisions_sample($formattedName);
}

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\PubSub\V1\Schema;
use Google\Cloud\PubSub\V1\SchemaServiceClient;

/**
 * @param string $formattedParent The name of the project in which to list schemas.
 *                                Format is `projects/{project-id}`. Please see
 *                                {@see SchemaServiceClient::projectName()} for help formatting this field.
 */
function list_schemas_sample(string $formattedParent): void
{
    // Create a client.
    $schemaServiceClient = new SchemaServiceClient();

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

        /** @var Schema $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 = SchemaServiceClient::projectName('[PROJECT]');

    list_schemas_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\PubSub\V1\Schema;
use Google\Cloud\PubSub\V1\SchemaServiceClient;

/**
 * @param string $formattedName The schema being rolled back with revision id. Please see
 *                              {@see SchemaServiceClient::schemaName()} for help formatting this field.
 * @param string $revisionId    The revision ID to roll back to.
 *                              It must be a revision of the same schema.
 *
 *                              Example: c7cfa2a8
 */
function rollback_schema_sample(string $formattedName, string $revisionId): void
{
    // Create a client.
    $schemaServiceClient = new SchemaServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var Schema $response */
        $response = $schemaServiceClient->rollbackSchema($formattedName, $revisionId);
        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 = SchemaServiceClient::schemaName('[PROJECT]', '[SCHEMA]');
    $revisionId = '[REVISION_ID]';

    rollback_schema_sample($formattedName, $revisionId);
}

use Google\ApiCore\ApiException;
use Google\Cloud\PubSub\V1\SchemaServiceClient;
use Google\Cloud\PubSub\V1\ValidateMessageResponse;

/**
 * @param string $formattedParent The name of the project in which to validate schemas.
 *                                Format is `projects/{project-id}`. Please see
 *                                {@see SchemaServiceClient::projectName()} for help formatting this field.
 */
function validate_message_sample(string $formattedParent): void
{
    // Create a client.
    $schemaServiceClient = new SchemaServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var ValidateMessageResponse $response */
        $response = $schemaServiceClient->validateMessage($formattedParent);
        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 = SchemaServiceClient::projectName('[PROJECT]');

    validate_message_sample($formattedParent);
}

use Google\ApiCore\ApiException;
use Google\Cloud\PubSub\V1\Schema;
use Google\Cloud\PubSub\V1\SchemaServiceClient;
use Google\Cloud\PubSub\V1\ValidateSchemaResponse;

/**
 * @param string $formattedParent The name of the project in which to validate schemas.
 *                                Format is `projects/{project-id}`. Please see
 *                                {@see SchemaServiceClient::projectName()} for help formatting this field.
 * @param string $schemaName      Name of the schema.
 *                                Format is `projects/{project}/schemas/{schema}`.
 */
function validate_schema_sample(string $formattedParent, string $schemaName): void
{
    // Create a client.
    $schemaServiceClient = new SchemaServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $schema = (new Schema())
        ->setName($schemaName);

    // Call the API and handle any network failures.
    try {
        /** @var ValidateSchemaResponse $response */
        $response = $schemaServiceClient->validateSchema($formattedParent, $schema);
        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 = SchemaServiceClient::projectName('[PROJECT]');
    $schemaName = '[NAME]';

    validate_schema_sample($formattedParent, $schemaName);
}

use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\PubSub\V1\SchemaServiceClient;

/**
 * @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.
    $schemaServiceClient = new SchemaServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $schemaServiceClient->getIamPolicy($resource);
        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\PubSub\V1\SchemaServiceClient;

/**
 * @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.
    $schemaServiceClient = new SchemaServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $policy = new Policy();

    // Call the API and handle any network failures.
    try {
        /** @var Policy $response */
        $response = $schemaServiceClient->setIamPolicy($resource, $policy);
        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\TestIamPermissionsResponse;
use Google\Cloud\PubSub\V1\SchemaServiceClient;

/**
 * @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.
    $schemaServiceClient = new SchemaServiceClient();

    // Prepare any non-scalar elements to be passed along with the request.
    $permissions = [$permissionsElement,];

    // Call the API and handle any network failures.
    try {
        /** @var TestIamPermissionsResponse $response */
        $response = $schemaServiceClient->testIamPermissions($resource, $permissions);
        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);
}