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.
This class is currently experimental and may be subject to changes. See Google\Cloud\PubSub\V1\SchemaServiceClient for the stable implementation
Namespace
Google \ Cloud \ PubSub \ V1 \ ClientMethods
__construct
Constructor.
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() .
request
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.
createSchema
Creates a schema.
The async variant is Google\Cloud\PubSub\V1\Client\SchemaServiceClient::createSchemaAsync() .
request
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.
deleteSchema
Deletes a schema.
The async variant is Google\Cloud\PubSub\V1\Client\SchemaServiceClient::deleteSchemaAsync() .
request
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.
deleteSchemaRevision
Deletes a specific schema revision.
The async variant is Google\Cloud\PubSub\V1\Client\SchemaServiceClient::deleteSchemaRevisionAsync() .
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.
getSchema
Gets a schema.
The async variant is Google\Cloud\PubSub\V1\Client\SchemaServiceClient::getSchemaAsync() .
request
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.
listSchemaRevisions
Lists all schema revisions for the named schema.
The async variant is Google\Cloud\PubSub\V1\Client\SchemaServiceClient::listSchemaRevisionsAsync() .
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.
listSchemas
Lists schemas in a project.
The async variant is Google\Cloud\PubSub\V1\Client\SchemaServiceClient::listSchemasAsync() .
request
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.
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() .
request
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.
validateMessage
Validates a message against a schema.
The async variant is Google\Cloud\PubSub\V1\Client\SchemaServiceClient::validateMessageAsync() .
request
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.
validateSchema
Validates a schema.
The async variant is Google\Cloud\PubSub\V1\Client\SchemaServiceClient::validateSchemaAsync() .
request
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.
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() .
request
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.
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() .
request
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.
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() .
request
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.
commitSchemaAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
createSchemaAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteSchemaAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteSchemaRevisionAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getSchemaAsync
GuzzleHttp\Promise\PromiseInterface
listSchemaRevisionsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listSchemasAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
rollbackSchemaAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
validateMessageAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
validateSchemaAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getIamPolicyAsync
GuzzleHttp\Promise\PromiseInterface
setIamPolicyAsync
GuzzleHttp\Promise\PromiseInterface
testIamPermissionsAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
static::projectName
Formats a string containing the fully-qualified path to represent a project resource.
project
string
string
static::schemaName
Formats a string containing the fully-qualified path to represent a schema resource.
project
string
schema
string
string
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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
