Cloud PubSub V1 Client - Class SchemaServiceClient (2.4.0)

Reference documentation and code samples for the Cloud PubSub V1 Client class SchemaServiceClient.

Service Description: Service for doing schema-related operations.

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 \ PubSub \ 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.

↳ 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.

commitSchema

Commits a new schema revision to an existing schema.

The async variant is Google\Cloud\PubSub\V1\Client\SchemaServiceClient::commitSchemaAsync() .

Parameters
Name Description
request Google\Cloud\PubSub\V1\CommitSchemaRequest

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\PubSub\V1\Schema
Example
use Google\ApiCore\ApiException;
use Google\Cloud\PubSub\V1\Client\SchemaServiceClient;
use Google\Cloud\PubSub\V1\CommitSchemaRequest;
use Google\Cloud\PubSub\V1\Schema;

/**
 * @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 the request message.
    $schema = (new Schema())
        ->setName($schemaName);
    $request = (new CommitSchemaRequest())
        ->setName($formattedName)
        ->setSchema($schema);

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

    commit_schema_sample($formattedName, $schemaName);
}

createSchema

Parameters
Name Description
request Google\Cloud\PubSub\V1\CreateSchemaRequest

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\PubSub\V1\Schema
Example
use Google\ApiCore\ApiException;
use Google\Cloud\PubSub\V1\Client\SchemaServiceClient;
use Google\Cloud\PubSub\V1\CreateSchemaRequest;
use Google\Cloud\PubSub\V1\Schema;

/**
 * @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 the request message.
    $schema = (new Schema())
        ->setName($schemaName);
    $request = (new CreateSchemaRequest())
        ->setParent($formattedParent)
        ->setSchema($schema);

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

    create_schema_sample($formattedParent, $schemaName);
}

deleteSchema

Parameters
Name Description
request Google\Cloud\PubSub\V1\DeleteSchemaRequest

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.

Example
use Google\ApiCore\ApiException;
use Google\Cloud\PubSub\V1\Client\SchemaServiceClient;
use Google\Cloud\PubSub\V1\DeleteSchemaRequest;

/**
 * @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();

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

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

    delete_schema_sample($formattedName);
}

deleteSchemaRevision

Deletes a specific schema revision.

The async variant is Google\Cloud\PubSub\V1\Client\SchemaServiceClient::deleteSchemaRevisionAsync() .

Parameters
Name Description
request Google\Cloud\PubSub\V1\DeleteSchemaRevisionRequest

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\PubSub\V1\Schema
Example
use Google\ApiCore\ApiException;
use Google\Cloud\PubSub\V1\Client\SchemaServiceClient;
use Google\Cloud\PubSub\V1\DeleteSchemaRevisionRequest;
use Google\Cloud\PubSub\V1\Schema;

/**
 * @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();

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

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

    delete_schema_revision_sample($formattedName, $revisionId);
}

getSchema

Parameters
Name Description
request Google\Cloud\PubSub\V1\GetSchemaRequest

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\PubSub\V1\Schema
Example
use Google\ApiCore\ApiException;
use Google\Cloud\PubSub\V1\Client\SchemaServiceClient;
use Google\Cloud\PubSub\V1\GetSchemaRequest;
use Google\Cloud\PubSub\V1\Schema;

/**
 * @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();

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

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

    get_schema_sample($formattedName);
}

listSchemaRevisions

Lists all schema revisions for the named schema.

The async variant is Google\Cloud\PubSub\V1\Client\SchemaServiceClient::listSchemaRevisionsAsync() .

Parameters
Name Description
request Google\Cloud\PubSub\V1\ListSchemaRevisionsRequest

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\PubSub\V1\Client\SchemaServiceClient;
use Google\Cloud\PubSub\V1\ListSchemaRevisionsRequest;
use Google\Cloud\PubSub\V1\Schema;

/**
 * @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();

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

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

        /** @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);
}

listSchemas

Lists schemas in a project.

The async variant is Google\Cloud\PubSub\V1\Client\SchemaServiceClient::listSchemasAsync() .

Parameters
Name Description
request Google\Cloud\PubSub\V1\ListSchemasRequest

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\PubSub\V1\Client\SchemaServiceClient;
use Google\Cloud\PubSub\V1\ListSchemasRequest;
use Google\Cloud\PubSub\V1\Schema;

/**
 * @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();

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

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

        /** @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);
}

rollbackSchema

Creates a new schema revision that is a copy of the provided revision_id.

The async variant is Google\Cloud\PubSub\V1\Client\SchemaServiceClient::rollbackSchemaAsync() .

Parameters
Name Description
request Google\Cloud\PubSub\V1\RollbackSchemaRequest

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\PubSub\V1\Schema
Example
use Google\ApiCore\ApiException;
use Google\Cloud\PubSub\V1\Client\SchemaServiceClient;
use Google\Cloud\PubSub\V1\RollbackSchemaRequest;
use Google\Cloud\PubSub\V1\Schema;

/**
 * @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();

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

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

    rollback_schema_sample($formattedName, $revisionId);
}

validateMessage

Validates a message against a schema.

The async variant is Google\Cloud\PubSub\V1\Client\SchemaServiceClient::validateMessageAsync() .

Parameters
Name Description
request Google\Cloud\PubSub\V1\ValidateMessageRequest

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\PubSub\V1\ValidateMessageResponse
Example
use Google\ApiCore\ApiException;
use Google\Cloud\PubSub\V1\Client\SchemaServiceClient;
use Google\Cloud\PubSub\V1\ValidateMessageRequest;
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();

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

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

    validate_message_sample($formattedParent);
}

validateSchema

Parameters
Name Description
request Google\Cloud\PubSub\V1\ValidateSchemaRequest

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\PubSub\V1\ValidateSchemaResponse
Example
use Google\ApiCore\ApiException;
use Google\Cloud\PubSub\V1\Client\SchemaServiceClient;
use Google\Cloud\PubSub\V1\Schema;
use Google\Cloud\PubSub\V1\ValidateSchemaRequest;
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 the request message.
    $schema = (new Schema())
        ->setName($schemaName);
    $request = (new ValidateSchemaRequest())
        ->setParent($formattedParent)
        ->setSchema($schema);

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

    validate_schema_sample($formattedParent, $schemaName);
}

getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

The async variant is Google\Cloud\PubSub\V1\Client\SchemaServiceClient::getIamPolicyAsync() .

Parameters
Name Description
request Google\Cloud\Iam\V1\GetIamPolicyRequest

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\Iam\V1\Policy
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\PubSub\V1\Client\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();

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

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

setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

The async variant is Google\Cloud\PubSub\V1\Client\SchemaServiceClient::setIamPolicyAsync() .

Parameters
Name Description
request Google\Cloud\Iam\V1\SetIamPolicyRequest

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\Iam\V1\Policy
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\PubSub\V1\Client\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 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 = $schemaServiceClient->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);
}

testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

The async variant is Google\Cloud\PubSub\V1\Client\SchemaServiceClient::testIamPermissionsAsync() .

Parameters
Name Description
request Google\Cloud\Iam\V1\TestIamPermissionsRequest

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\Iam\V1\TestIamPermissionsResponse
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\PubSub\V1\Client\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 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 = $schemaServiceClient->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);
}

commitSchemaAsync

Parameters
Name Description
request Google\Cloud\PubSub\V1\CommitSchemaRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

createSchemaAsync

Parameters
Name Description
request Google\Cloud\PubSub\V1\CreateSchemaRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

deleteSchemaAsync

Parameters
Name Description
request Google\Cloud\PubSub\V1\DeleteSchemaRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

deleteSchemaRevisionAsync

Parameters
Name Description
request Google\Cloud\PubSub\V1\DeleteSchemaRevisionRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getSchemaAsync

Parameters
Name Description
request Google\Cloud\PubSub\V1\GetSchemaRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listSchemaRevisionsAsync

Parameters
Name Description
request Google\Cloud\PubSub\V1\ListSchemaRevisionsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

listSchemasAsync

Parameters
Name Description
request Google\Cloud\PubSub\V1\ListSchemasRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

rollbackSchemaAsync

Parameters
Name Description
request Google\Cloud\PubSub\V1\RollbackSchemaRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

validateMessageAsync

Parameters
Name Description
request Google\Cloud\PubSub\V1\ValidateMessageRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

validateSchemaAsync

Parameters
Name Description
request Google\Cloud\PubSub\V1\ValidateSchemaRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

getIamPolicyAsync

Parameters
Name Description
request Google\Cloud\Iam\V1\GetIamPolicyRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

setIamPolicyAsync

Parameters
Name Description
request Google\Cloud\Iam\V1\SetIamPolicyRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

testIamPermissionsAsync

Parameters
Name Description
request Google\Cloud\Iam\V1\TestIamPermissionsRequest
optionalArgs = [] array
Returns
Type Description
GuzzleHttp\Promise\PromiseInterface

static::projectName

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

Parameter
Name Description
project string
Returns
Type Description
string The formatted project resource.

static::schemaName

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

Parameters
Name Description
project string
schema string
Returns
Type Description
string The formatted schema 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

  • project: projects/{project}
  • schema: projects/{project}/schemas/{schema}

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.